Basics

Get Identifiers

Changed on

Returns the identifiers of a website's own brand, or of one of its competitors when you pass competitor_id: the names, aliases and domains Athena looks for in AI responses to count a mention. default_identifiers holds the name and domain, which are always matched. identifiers holds every other value the Competitors page shows, so the two lists together are the full set. case_sensitive tells whether matching respects letter case. entity says what the identifiers belong to, with type set to brand or competitor.

get/api/v1/identifiers

Request

Query parameters

website_idstring required

The ID of the website

competitor_idstring

The ID of a competitor on this website, as GET /api/v1/competitors returns it. Omit it for the website's own brand.

Response

Successful response with the identifiers

default_identifiersstring[] required
identifiersstring[] required
case_sensitiveboolean required

Changes