Sign in

v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Metrics

Cumulative Share of Voice

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 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
    }
  ]
}