Skip to main content
POST
Stop Snapshot

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

scan_id
string<uuid>
required

A Snapshot id from startSnapshot.

Response

Successful Response

audit_progress
AuditProgress · object | null
required

An Audit's live page and screenshot counts; null on other scans.

brand_id
string<uuid> | null
required

Null for a Snapshot no brand holds.

completed_at
string<date-time> | null
required

When it completed, failed or expired; null until then.

domain
string
required

The site the scan measured.

ecommerce
boolean
required

Whether the scan measured the brand as ecommerce, which reads product cards and Google Shopping. Fixed for the scan once it runs.

failure_reason
string | null
required

Why the scan failed, one of stuck_no_progress, brief_abandoned, insufficient_engine_signal, cost_cap_exceeded, report_inputs_missing, service_unavailable or other; null unless the scan failed. New values may be added.

id
string<uuid>
required

The scan's id.

issued
V1ScanFacts · object | null
required

What the scan issued once complete; null while it runs, while it is partial, on a daily scan and on an Audit.

kind
enum<string>
required

weekly, daily, snapshot (a one-time Snapshot or a brand's first) or audit.

Available options:
weekly,
daily,
snapshot,
audit
meta
Meta · object
required

Normalized query and newest included scan.

partial
boolean
required

A Snapshot delivered before every answer came back, still filling in.

payer
V1SnapshotPayer · object | null
required

Who pays for a Snapshot: recorded on Run, charged when it starts. A run that needs action keeps the payer it waits on. Null before Run, after a stop and on other scans.

profile
V1SnapshotProfile · object | null
required

A preparing Snapshot's profile, to confirm or edit before Run; null while it drafts and once the Snapshot runs.

progress
V1ScanProgress · object | null
required

Null on an Audit and once the scan completed or failed.

questions_asked
integer | null
required

How many questions the scan asks AI engines. A Snapshot asks 20, or 12 to 19 when fewer of its drafted questions passed review. Null before its questions are fixed and on an Audit.

report_url
string | null
required

A delivered Snapshot's or weekly scan's report page, to give the member; null on an Audit, a daily scan and before delivery.

run_request
V1RunRequest · object | null
required

Run pressed before the Snapshot started; null otherwise.

sells_to
enum<string>
required

Who the scan measured the brand as selling to: businesses or consumers. Fixed for the scan once it runs.

Available options:
businesses,
consumers
share_id
string<uuid> | null
required

The report link id once delivered; null on a daily scan and before delivery. Quick shares use /v1/shared/audits/{share_id}; Base and Full remain owner-only.

started_at
string<date-time>
required

When the scan was started.

state
enum<string>
required

preparing while the profile drafts or waits for Run, running, completed, failed, or expired: a Snapshot whose profile waited 24 hours without a run.

Available options:
preparing,
running,
completed,
failed,
expired
url
string
required

The Snapshot's page, where its member can check the profile, run it and follow it.