Skip to main content
POST
Estimate the credits one run of a monitored website will cost.

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

Modules and settings to price

Project configuration to price

companyId
string
required

Company ID

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

Projected credits per run

Projected credit cost of one run

total
number

Estimated credits for one run of all enabled modules

modules
object

Estimated credits per enabled module key

cacheFirst
string[]

Modules that only buy missing/stale data, so usually cost less than estimated