v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Attributes

Cumulative Attribute Metrics

Returns, for each brand-perception attribute, how many AI responses mentioned it across the date range, and the percentage. total_responses is the denominator: responses in the date range that mention the brand AND had attribute extraction run on them. It is NOT every response for the website — responses that never mention the brand are excluded, and Athena samples which responses get extraction, so un-analyzed ones are excluded too. Compute rates from the returned percentage / total_responses rather than against a response count from another endpoint. Attributes nobody mentioned are returned with response_count 0 rather than omitted. positive describes the keyword itself, not the individual mention.

post/api/v1/attributes/cumulative

Request body

website_idstring uuid required

Example request

{
  "filters": {
    "start_date": "2024-01-01T00:00:00.000Z",
    "end_date": "2024-12-31T23:59:59.999Z",
    "models": [
      "chatgpt",
      "perplexity"
    ],
    "location_ids": [
      "123e4567-e89b-12d3-a456-426614174111"
    ]
  }
}

Response

Successful response with attribute metrics

Example response

{
  "data": [
    {
      "attribute_name": "Affordable"
    }
  ]
}