v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Attributes

Competitor Attribute Metrics

Returns attribute metrics per tracked competitor: for each competitor and each attribute, how many AI responses mentioned that keyword for that competitor. Pair with POST /api/v1/attributes/cumulative to compare the brand against competitors. total_responses is per-competitor: responses in the date range that mention THAT competitor and had attribute extraction run on them. Each competitor therefore has its own denominator, and none of them is the website's total response count. positive describes the keyword itself, not the individual mention. Returns one row per competitor per attribute, so responses can be large — narrow with filters.competitor_ids. Competitors with no responses in the date range are omitted entirely rather than returned with zeros.

post/api/v1/attributes/competitors

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

Example response

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