Skip to main content
GET
List discovered competitors

Authorizations

Authorization
string
header
required

An API key created in Settings → Account → API Keys.

Path Parameters

siteId
string
required

Query Parameters

cursor
string

Opaque cursor from the previous page (nextCursor). Omit for the first page.

limit
number
default:25
Required range: 1 <= x <= 100
kind
enum<string>[]

Repeat to limit to these kinds. Omit for all, including brands with no classification.

Available options:
direct_competitor,
category_alternative,
channel_or_broker
scanId
string<uuid>

Restrict to brands measured in this Scan. Omit for all-time presence.

Response

data
object[]
required
total
number
required

Total discovered competitors matching the query.

nextCursor
string | null
required

Opaque cursor: pass back as cursor for the next page.