ATathenahq
Metrics

Cumulative Mention Rate

Changed on

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

  • 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 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

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 /