Skip to main content
POST
Add competitors

Authorizations

Authorization
string
header
required

A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

Body

application/json
competitors
(string | object)[]
required
Required array length: 1 - 20 elements

A website domain or URL, e.g. example.com.

source
enum<string>

"manual" with exactly one item also runs the duplicate check (409 conflict) the in-app add-competitor dialog runs.

Available options:
manual,
ai_discovery

Response

Competitors added.

success
boolean
required
added
integer
required
updated
integer
required
competitors
object[]
required
newDomains
string[]

The domains added as new competitors.

alreadyTracked
string[]

The domains that matched a competitor already tracked, by domain or name, so were not added again.