Skip to content

Get Seo Audit

GET
/seo/audits/{audit_id}

SPENDS NOTHING. One audit, with its plain-language state. 404 if it is not this organisation’s.

Authorizations

Parameters

Path Parameters

audit_id
required
string format: uuid

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Mirrors AuditDTO.

object
completed_at
Any of:
string format: date-time
created_at
Any of:
string format: date-time
credits_charged
Any of:
integer
domain
required
string
failure_reason
Any of:
string
id
required
string format: uuid
max_pages
required
integer
onpage_score
Any of:
number
pages_crawled
Any of:
integer
state
required

Mirrors AuditStateDTO - the plain-language, recovery-oriented view of where an audit is, so a caller can explain the state rather than parse raw provider text.

object
can_run_again
required

Whether to offer a manual ‘Run a new audit’ action

boolean
category
required

Lifecycle state category driving the plain-language status + recovery UX

string
Allowed values: queued running complete timeout provider_error credit_issue start_error failed
detail
required

Plain-language explanation of what happened

string
diagnostic
Any of:
string
headline
required

One-line human status

string
is_terminal
required

No further automatic progress will happen

boolean
label
required

Short status chip label

string
recovery
required

Plain-language, safe next step (may be empty)

string
status
required
string
summary_checks
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string