Skip to main content
POST
/
api
/
v1
/
metrics
/
share-of-voice
/
cumulative
Cumulative Share of Voice
curl --request POST \
  --url https://api.athenahq.ai/api/v1/metrics/share-of-voice/cumulative \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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"
    ]
  }
}
'
{
  "data": [
    {
      "name": "Acme Corp",
      "value": 33.3,
      "absolute_value": 150,
      "is_self": true
    },
    {
      "name": "Competitor Inc",
      "value": 26.7,
      "absolute_value": 120,
      "is_self": false
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json

Request body for share of voice endpoints

​
website_id
string<uuid>
required

The ID of the website to query share of voice for

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
filters
object
required

Filters for querying responses and metrics. Pass location filters in the JSON body as filters.location_ids.

Response

Successful response with share of voice data

​
data
object[]
required