v1

latestOpenAPI 3.1.02026-07-265897154.5 KB
Competitors

List competitors

The project's real/tracked competitors (rows in the competitors table) with share of voice, sentiment score, and all-time mention counts. Paginated. sov/sentimentScore are windowed by days and honor the platform/topicId/unbranded/branded/country/locationId filters; mentions is always all-time and ignores days + all filters (mirrors the in-app Competitors list); visibilityScore and citations are null in the list view — see the detail endpoint for those. days defaults to 30, max 365. limit defaults to 20, max 100.

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

Path parameters

projectIdstring uuid required

The project 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.

limitinteger

Page size. Default and maximum vary by endpoint — see the operation description.

offsetinteger

Row offset for pagination.

Response

Competitors list.

totalCountinteger required