Domains
Register the domains you check with the Console API and read their latest headline metrics.
Every Console check runs against a Console domain. Create one with {"domain": "yourbrand.com"} and pass its id as domain_id when you submit a check. A domain you track in the dashboard cannot be used as a Console domain_id; register it here first.
Each domain record carries domain, status, created_at, and the headline metrics from its most recent completed check: latest_visibility_score, latest_brand_coverage_pct (Brand Coverage), latest_market_position (Market Position), last_scan_at, and scan_count. The list returns your 50 most recently created domains.
Creating and deleting a domain require an Idempotency-Key header when you authenticate with an API key. Deleting a domain removes it from the list; its checks stay in the scan list.
domainsQuery Parameters
cursorCursor
page_sizePage Size
50Minimum: 1Maximum: 200Header Parameters
X-API-KeyX-Api-Key
Successful Response
domainsRequest Body
application/jsonRequired[key: string]any
Header Parameters
X-API-KeyX-Api-Key
Idempotency-KeyIdempotency-Key
Successful Response
domains/{domain_id}Successful Response
domains/{domain_id}Path Parameters
domain_idRequiredDomain Id
Header Parameters
X-API-KeyX-Api-Key
Idempotency-KeyIdempotency-Key
Successful Response