Skip to main content
GET
Get Competitors

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Query Parameters

website_id
string<uuid>
required

The ID of the website to retrieve competitors for

include_discovered
boolean
default:false

Set to true to add discovered_competitors to the response. When omitted or false, the response holds only competitors.

Response

Successful response with list of competitors

competitors
object[]
required
discovered_competitors
object[]

Returned only when include_discovered is true: up to 6 discovered competitors, highest mention rate first. An empty array when there are none.