> ## Documentation Index
> Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Cumulative Attribute Metrics

> Returns, for each brand-perception attribute, how many AI responses mentioned it across the date range, and the percentage. `total_responses` is the denominator: responses in the date range that mention the brand AND had attribute extraction run on them. It is NOT every response for the website — responses that never mention the brand are excluded, and Athena samples which responses get extraction, so un-analyzed ones are excluded too. Compute rates from the returned `percentage` / `total_responses` rather than against a response count from another endpoint. Attributes nobody mentioned are returned with response_count 0 rather than omitted. `positive` describes the keyword itself, not the individual mention.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/attributes/cumulative
openapi: 3.1.0
info:
  title: AthenaHQ API
  description: >-
    AthenaHQ API provides programmatic access to manage your websites and
    prompts for AI-powered content optimization.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Production server
security:
  - apiKey: []
tags:
  - name: Basics
    description: Core API operations for managing websites and prompts
  - name: Metrics
    description: Metrics and analytics endpoints for tracking AI visibility
  - name: Billing
    description: Billing and credits endpoints for managing usage
  - name: Team Management
    description: Endpoints for managing team members and invitations
  - name: Groups
    description: Endpoints for managing groups of websites
  - name: Content
    description: >-
      Endpoints for accessing Content Hub data — tabs, tracked URLs, and per-URL
      prompt breakdowns.
  - name: Pitch Workspace
    description: >-
      Endpoints for accessing pitch workspace reports — org-scoped pitch runs
      with competitors, prompts, attributes, and aggregate metrics.
  - name: Knowledge Base
    description: >-
      Endpoints for reading the brand Knowledge Base — approved brand facts and
      the pillars that organize them.
paths:
  /api/v1/attributes/cumulative:
    post:
      tags:
        - Attributes
      summary: Cumulative Attribute Metrics
      description: >-
        Returns, for each brand-perception attribute, how many AI responses
        mentioned it across the date range, and the percentage.
        `total_responses` is the denominator: responses in the date range that
        mention the brand AND had attribute extraction run on them. It is NOT
        every response for the website — responses that never mention the brand
        are excluded, and Athena samples which responses get extraction, so
        un-analyzed ones are excluded too. Compute rates from the returned
        `percentage` / `total_responses` rather than against a response count
        from another endpoint. Attributes nobody mentioned are returned with
        response_count 0 rather than omitted. `positive` describes the keyword
        itself, not the individual mention.
      operationId: getCumulativeAttributeMetrics
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CumulativeAttributeMetricsRequest'
      responses:
        '200':
          description: Successful response with attribute metrics
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AttributeMetric'
                required:
                  - data
              example:
                data:
                  - attribute_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    attribute_name: Affordable
                    positive: true
                    response_count: 12
                    total_responses: 40
                    percentage: 30
                  - attribute_id: 9c858901-8a57-4791-81fe-4c455b099bc9
                    attribute_name: Slow Support
                    positive: false
                    response_count: 0
                    total_responses: 40
                    percentage: 0
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - API key cannot access this website
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found - Website or attribute does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    CumulativeAttributeMetricsRequest:
      type: object
      properties:
        website_id:
          type: string
          format: uuid
        filters:
          $ref: '#/components/schemas/ApiFiltersNoCompetitors'
      required:
        - website_id
        - filters
    AttributeMetric:
      type: object
      properties:
        attribute_id:
          type: string
          format: uuid
        attribute_name:
          type: string
          example: Affordable
        positive:
          type: boolean
        response_count:
          type: integer
          description: Number of analyzed responses that mention this attribute.
        total_responses:
          type: integer
          description: Analyzed responses in the date range — the denominator.
        percentage:
          type: number
          description: response_count / total_responses, as a percentage.
      required:
        - attribute_id
        - attribute_name
        - positive
        - response_count
        - total_responses
        - percentage
    Error:
      type: object
      description: Error response object
      required:
        - error
      properties:
        error:
          type: string
          description: Error message describing what went wrong
          example: Unauthorized
    ApiFiltersNoCompetitors:
      type: object
      description: >-
        Filter set for the brand cumulative endpoint. Same as the shared filters
        but without competitor_ids: this endpoint is brand-only. Sending
        competitor_ids is rejected — use /api/v1/attributes/competitors for
        per-competitor data.
      required:
        - start_date
      properties:
        start_date:
          type: string
          format: date-time
          description: Filter start date (UTC)
          example: '2024-01-01T00:00:00.000Z'
        end_date:
          type: string
          format: date-time
          description: Filter end date (UTC)
          example: '2024-12-31T23:59:59.999Z'
        models:
          type: array
          description: Filter by AI models
          items:
            type: string
            enum:
              - chatgpt
              - perplexity
              - gemini
              - google_ai_overview
              - copilot
              - claude
              - ai_mode
              - grok
              - deepseek
          example:
            - chatgpt
            - perplexity
        prompt_ids:
          type: array
          description: Filter by specific prompt IDs
          items:
            type: string
            format: uuid
        location_ids:
          type: array
          description: >-
            Filter by location IDs. Pass this in the JSON body as
            `filters.location_ids`, even when filtering by a single location.
            Use IDs returned by `GET /api/v1/locations`.
          items:
            type: string
            format: uuid
          example:
            - 123e4567-e89b-12d3-a456-426614174111
        prompt_status:
          type: string
          enum:
            - active
            - paused
          description: Filter by prompt status
        prompt_type:
          type: string
          enum:
            - branded
            - non_branded
          description: Filter by prompt type
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can create one
        [here](https://app.athenahq.ai/organization?tab=api).

````