v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB

Attributes

Attribute Time Series

Returns the daily trend for ONE attribute, brand and competitors side by side. Requires an attribute_id — call GET /api/v1/attributes first to discover ids. Days with no data are returned as zeros, so the series is gap-free and chartable. Denominators are per-side, not the day's whole response set: brand_percentage divides by that day's responses that mention the brand (and had attribute extraction run), and competitor_percentage by responses that mention the tracked competitors. brand_total and competitor_total return those denominators explicitly. Competitor figures aggregate all tracked competitors unless filters.competitor_ids narrows them.

post/api/v1/attributes/time-series

Request body

website_idstring uuid required

attribute_idstring uuid required

The attribute to chart. Obtain ids from GET /api/v1/attributes.

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 the daily series