Skip to main content
POST
Add a website to monitor and set its schedule + enabled modules.

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

Website, schedule and modules

Add a website to monitor

companyId
string
required

Company ID

domain
string
required

Domain or URL 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, 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

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

Response

The new project

A monitored website. enabledModules maps each SEO/AEO module key to whether it runs on the schedule; any module can also be run on demand with seo_runProjectRoute.

id
string

Project ID (UUID)

companyId
string

Company ID

domain
string

Monitored host, lowercased

name
string

Display name

status
enum<string>

active or paused

Available options:
active,
paused
frequency
enum<string>

manual, daily, weekly or monthly

Available options:
manual,
daily,
weekly,
monthly
timezone
string

Schedule timezone

nextRunAt
string<date-time>

Next scheduled run (null when manual/paused)

lastRunAt
string<date-time>

Last run

runCount
integer

Runs so far

enabledModules
object

Module key -> enabled. Keys: keyword_research, domain_overview, opportunities, backlinks, link_profile, rank_tracking, competitors, ai_visibility, site_audit, lighthouse

trackedKeywords
string[]

Keywords for rank tracking and keyword research

competitorDomains
string[]

Pinned competitor domains

trackedPrompts
string[]

Questions asked of AI platforms (AEO)

brandNames
string[]

Strings that count as a brand mention

aiPlatforms
object

AI platform key -> enabled (chatgpt, claude, gemini, perplexity)

trackAiOverview
boolean

Also check Google AI Overview

Backlinks pulled per run (billed per link)

auditMaxPages
integer

Pages crawled per scheduled site audit

country
string

Market country code, e.g. us

language
string

Language code, e.g. en

created_date
string<date-time>
updated_date
string<date-time>