Skip to main content
GET
Observation Competitors

Query Parameters

q
string | null
Maximum string length: 256
competitor_ids
string[]
Maximum array length: 200
Required string length: 1 - 128
currency_codes
string[]
Maximum array length: 50
Pattern: ^[A-Z]{3}$
statuses
string[]
Maximum array length: 50
Maximum string length: 128
competitor_names
string[]
Maximum array length: 200
Maximum string length: 256
cursor
string | null
Maximum string length: 4096
limit
integer
default:100
Required range: 1 <= x <= 200

Response

Successful Response

external_org_id
string<uuid>
required
items
ObservationCompetitor · object[]
required
Maximum array length: 200
next_cursor
string | null
required
has_more
boolean
required