Skip to main content
POST
Start a site audit.

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

Domain to audit

Queue a site audit. Returns immediately with a queued audit; the crawl runs in the background, so poll the audit until status is complete.

companyId
string
required

Company ID

domain
string
required

Domain or URL to audit. A bare domain is crawled over https.

maxPages
integer

Pages to crawl, 1-500. Defaults to 25.

checkAiReadiness
boolean

Also score AI crawler readiness. Billed separately. Defaults to true.

Response

The queued audit

The site audit

audit
object

A site audit. Carries its own rolled-up totals, so listing audits never loads the per-page rows.