v1

latestOpenAPI 3.1.02026-07-265897154.5 KB

Competitors

Get a competitor

Full detail for one tracked competitor — the list-view fields plus a per-day history[] and up to 10 recent topPrompts[] it was mentioned in. Two distinct citation metrics: citations (top level) counts every citation on responses that mention the competitor, whatever domain it points at; history[].domainCitations counts citations whose URL is on the competitor's own domain. Returns 404 if competitorId doesn't exist or belongs to a different project. days defaults to 30, max 365.

get/api/mcp/projects/{projectId}/competitors/{competitorId}

Path parameters

projectIdstring uuid required

The project id.

competitorIdstring uuid required

The competitor's id.

Query parameters

daysinteger

Lookback window in days. Default and maximum vary by endpoint — see the operation description.

platformstring

Comma-separated AI platform filter (e.g. chatgpt,claude,gemini). Accepted values and whether the param is required vary by endpoint — see the operation description.

topicIdstring uuid

Restrict to a single topic id.

unbranded'true'

Pass true to restrict every metric to non-branded prompts only.

branded'true'

Pass true to restrict every metric to branded prompts only.

countrystring

Comma-separated ISO 3166-1 country codes (e.g. US,GB) or country names.

locationIdstring

Comma-separated tracked-location ids.

Response

Competitor detail.

idstring uuid required

namestring required

domainstring nullable

sovnumber required

{"stackTrail":"components:schemas:CompetitorDetailResponse:properties:visibilityScore","oasType":"schema","type":"unknown"}

mentionsinteger required

Total mentions in responses, honoring the filters.

citationsinteger required

ALL source-type citations on responses that mention this competitor, whatever domain they point at.

sentimentScorenumber nullable