Skip to main content
POST
Propose complete monitoring settings from a domain alone.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

The website to set up

A website to propose monitoring settings for

companyId
string
required

Company ID

domain
string
required

Domain or URL

country
string

Market country code, default us

language
string

Language code, default en

Response

Proposed keywords, competitors, AI questions and schedule

Proposed settings, ready to pass to Add a website to monitor

name
string

Display name; defaults to the domain

frequency
enum<string>

manual (run-now only), daily, weekly or monthly

Available options:
manual,
daily,
weekly,
monthly
enabledModules
object

Module key -> true/false. Keys: keyword_research, domain_overview, opportunities, backlinks, disavow, link_profile, rank_tracking, competitors, ai_visibility, site_audit, lighthouse

trackedKeywords
string[]

Keywords to rank-track

competitorDomains
string[]

Competitor domains to pin

trackedPrompts
string[]

Questions to ask AI platforms

brandNames
string[]

Strings that count as a brand mention

aiPlatforms
object

AI platform key -> true/false

trackAiOverview
boolean

Also check Google AI Overview

notificationUserIds
string[]

Company user IDs (uids) who receive the summary of changes after each scheduled run. Empty sends nothing; a new project defaults to its creator

Backlinks pulled per run

auditMaxPages
integer

Pages per scheduled site audit

country
string

Market country code, default us

language
string

Language code, default en

timezone
string

Schedule timezone, default UTC

domain
string

Normalized domain

existingProjectId
string

The company's project for this domain, if it already has one

rankedKeywordCount
integer

Keywords the site ranks for in Google