Skip to main content
GET
List competitors
Lists competitor domains and mention metrics for the selected scope. The default relationship set is SELF,DIRECT; include INDIRECT explicitly when needed. On this endpoint, Share of Voice uses mention occurrences from the selected relationship set.
See Entities for the complete Competitor object structure.
string
required
Bearer token. Example: Bearer qw-api-xxx

Path parameters

string
required
The unique identifier of the brand

Query parameters

number
Number of days to include. If not specified, returns all data.
string
Start date in YYYY-MM-DD. Provide it with endDate; a lone boundary is currently ignored. Choose either period or the complete date pair.
string
End date in YYYY-MM-DD. Provide it with startDate; a lone boundary is currently ignored. Do not combine the complete date pair with period.
string
Filter by AI provider. Supports comma-separated multi-select (e.g., chatgpt,claude).
string
Filter by topic ID. Supports comma-separated multi-select (e.g., id1,id2).
string
Filter by tag ID. Supports comma-separated multi-select (e.g., id1,id2).
string
Filter by prompt type: TOFU, MOFU, BOFU
string
default:"SELF,DIRECT"
Filter by relationship type. Supports comma-separated multi-select: SELF, DIRECT, INDIRECT. Default: SELF,DIRECT.
number
default:"50"
Maximum number of results to return (max: 100)
number
default:"0"
Number of results to skip for pagination
string
default:"mentions"
Field to sort by: mentions, position, sentiment, shareOfVoice, name
string
default:"desc"
Sort order: asc or desc

Response

Returns competitors from the requested relationship filter. INDIRECT is excluded only by the default filter.
boolean
Indicates if the request was successful
object
array

Synthetic request

Synthetic response

Errors

See Rate limits for retry behavior.