Sign in

v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Metrics

Cumulative Mention Rate

Returns mention rate percentages across the specified date range. mention_rate is absolute (the percentage of all AI responses that mention the brand); relative_mention_rate is the percentage of responses mentioning at least one tracked brand.

post/api/v1/metrics/mention-rate/cumulative

Request body

website_idstring uuid required

The ID of the website to query mention rates 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 mention rate data

dataobject required