Skip to content

Create Competitor

POST
/radar/competitors

Add one competitor to track. 409 if already tracked, 422 at the cap.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
domain
required
string
>= 1 characters <= 255 characters
name
Any of:
string
<= 255 characters
scan_config
Any of:

Per-competitor page-selection config (persisted on profile.meta.scan_config).

mode=auto: Firecrawl /map → rank by traffic + pricing/feature paths → scrape top N (= tier page budget). mode=manual: scrape include_paths (literal or /wildcard/* patterns), capped to the budget.

object
include_paths
Array<string>
<= 50 items
mode
string
default: auto
Allowed values: auto manual
tier
Any of:
string

Responses

200

Successful Response

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string