Attributes

Attribute Time Series

Changed on

Returns the daily directional trend for one attribute, brand and competitors side by side. Requires an attribute_id. The optional top-level positive request field selects positive or negative observations and defaults to true. Days with no data are returned as zeros. Denominators are per-side sampled, successfully analyzed responses that mention the entity. Competitor figures aggregate all tracked competitors unless filters.competitor_ids narrows them.

post/api/v1/attributes/time-series

Request

  • Base URL
    https://api.athenahq.ai
  • Auth
    API key in header x-api-key

Request body

website_idstring uuid required
attribute_idstring uuid required

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

positiveboolean

Observation direction to select.

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

Changes

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new meta_ai enum value to the request property //

    • info

      added the new mistral enum value to the request property //