ATathenahq
Attributes

Competitor Attribute Metrics

Changed on

Returns directional attribute prevalence per tracked competitor. The optional top-level positive request field selects positive or negative observations and defaults to true. total_responses is per-competitor: sampled, successfully analyzed responses in the date range that mention that competitor. Returns one row per competitor per attribute; narrow with filters.competitor_ids. Competitors with no responses in the date range are omitted.

post/api/v1/attributes/competitors

Request

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

Request body

website_idstring uuid required
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 per-competitor attribute metrics

Example response

{
  "data": [
    {
      "competitor_name": "Globex",
      "attribute_name": "Affordable"
    }
  ]
}

Changes

  • 2d1d86d5e067Revision 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 //