Skip to main content
GET
Get scan configuration

Authorizations

Authorization
string
header
required

An API key created in Settings → Account → API Keys.

Path Parameters

siteId
string
required

Query Parameters

scanId
string<uuid>

Read the configuration snapshot used by this Scan; omit for the working configuration.

Response

strategicGoal
object | null
required
subjectKind
enum<string>
required
Available options:
site,
topic
businessProfile
object | null
required
personas
object[]
required
products
object[]
required

Scan-strategy products (distinct from the profile products).

journeyStages
object[]
required
models
object[]
required

Every selectable AI model, with whether the Site scans it.

regions
string[]
required

Region codes the Site scans.

schedule
object
required
prompts
object
required

Prompt count; list them via GET …/prompts.

competitors
object
required

Tracked competitor count; list them via GET …/competitors.

source
enum<string>
Available options:
working,
scan_snapshot
scanId
string
configVersion
object
topicContext
object

Topic title, scope and focal entity. Absent for brand sites.

clientId
string | null
focalEntityId
string | null
trackedEntities
object[]

Topic roster. entityId is the stable identity used for edits and focal selection; id is the configuration row.

scanExecutionSupported
boolean

Whether manual scan execution is supported for this subject.