Skip to main content
GET
Get a site audit run

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Path Parameters

id
string<uuid>
required

Audit run ID

Response

Default Response

id
string<uuid>
required

Audit run identifier

state
enum<string>
required

Run state; PARTIAL means the plan's URL ceiling capped coverage

Available options:
PENDING,
RUNNING,
FINALIZING,
COMPLETED,
FAILED,
PARTIAL
trigger
enum<string>
required

What opened the run

Available options:
SCHEDULED,
MANUAL
healthScore
integer | null
required

Health score 0-100; null until the run finalizes

urlsTotal
integer
required

URLs selected for the run

urlsChecked
integer
required

URLs the sweep returned a result for

urlsSkipped
integer
required

URLs left out of the run by the plan ceiling

urlsUnchecked
integer
required

URLs selected but never answered before the run closed

createdAt
string<date-time>
required

Timestamp (ISO 8601)

error
string | null
required

Failure reason when the run state is FAILED

issueCounts
object
required

Affected URL count per check, keyed by check id (status4xx, status5xx, brokenInternalLink, redirectChainTooLong, missingTitle, noH1, certificateInvalid, sitemapUrlRedirects, orphanPage, missingDescription, multipleH1, thinContent, slowTtfb, oversizedHtml, certificateExpiringSoon, linkedNotInSitemap, titleLengthOutOfRange, externalCanonical, duplicateContent, navOnlyPage, contentRequiresJs). Checks that never fired are omitted.

issueDiffs
object
required

New/fixed deltas against the previous completed run, keyed by check id

startedAt
string<date-time> | null

When the first check was dispatched

finishedAt
string<date-time> | null

When the run finalized