Skip to main content
POST
Get or create the project for a domain.

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

Company and domain

Get or create the project for a domain

companyId
string
required

Company ID

domain
string
required

Domain or URL

Response

The existing or new project

The project, with whether it was just created

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>
created
boolean

True when the project was created by this call