ATathenahq
Metrics

Cumulative Share of Voice

Changed on

Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes relative_mention_rate: the entry's mentions as a percentage of responses that mention at least one tracked brand.

post/api/v1/metrics/share-of-voice/cumulative

Request

  • Base URL
    https://api.athenahq.ai
  • Auth
    API key in header x-api-key

Request body

website_idstring uuid required

The ID of the website to query share of voice for

Example request

{
  "website_id": "123e4567-e89b-12d3-a456-426614174000",
  "filters": {
    "start_date": "2024-01-01T00:00:00.000Z",
    "end_date": "2024-01-31T23:59:59.999Z",
    "location_ids": [
      "123e4567-e89b-12d3-a456-426614174111"
    ]
  }
}

Response

Successful response with share of voice data

Example response

{
  "data": [
    {
      "name": "Acme Corp",
      "value": 33.3,
      "relative_mention_rate": 40,
      "absolute_value": 150,
      "is_self": true
    }
  ]
}

Changes

  • 2d1d86d5e067Revision changes
    • breaking

      added subschema #2 to the request property allOf list

    • breaking

      the request property type changed from object to no type

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /