Skip to main content
POST
Trigger a site audit

Authorizations

Authorization
string
header
required

A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Headers

Idempotency-Key
string

Optional client-generated key (e.g. a UUID). Retrying with the same key within 24h replays the original stored response (X-Idempotent-Replay: true) instead of repeating the side effect. See Idempotency.

Path Parameters

projectId
string<uuid>
required

The project id.

Body

application/json
pageIds
string[]

Pages to audit. Omit to audit every tracked page in the project.

Minimum string length: 1

Response

Audit started.

success
boolean
required
jobId
string
required
projectId
string<uuid>
required
pageCount
integer
required
pageIds
string[]
baseURL
string<uri>
message
string