Sign in

v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Metrics

Share of Voice Over Time

Returns daily share of voice breakdown over the specified date range. Each entry contains the date and SOV percentages for your brand and competitors, plus each company's relative_mention_rate: its mentions as a percentage of that day's responses that mention at least one tracked brand.

post/api/v1/metrics/share-of-voice/time-series

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 time series data

Example response

{
  "data": [
    {
      "date": "2024-06-15"
    }
  ]
}