Skip to content
Zaraftis API
Esc
↑↓navigate↵open⌘Jpreview

Get a site audit

Returns one audit: request, brand, status, and timestamps, the collected data (the page with its response, preview, and rendering, robots_txt, sitemap candidates, and mobile Lighthouse), and the issues found from it. Each collected item says whether collection failed, so a failed fetch is never reported as a missing resource. The audit reports issues and gives no recommendations.

GET/site-audits/{audit_id}
Authorization
AuthorizationBearer token · headerrequired

API key sent as Authorization: Bearer <key>. A key belongs to one workspace, has scopes, and can be limited to some brands.

or
AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 sign-in (authorization code with PKCE) used by AI assistants that connect through the Zaraftis MCP server. Discovery URLs are at https://api.zaraftis.com/api/auth.

Path parameters
audit_idstring<uuid>required
Responses
200

One Site audit with collected data and issued issues

SiteAuditEnvelope
404

not_found: unknown id, or an id this key cannot see

successbooleanrequired
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsobject
field_errorsobject[]
Show properties
Array of object
fieldstringrequired
codestringrequired
Allowed:requiredformattoo_smalltoo_largeunrecognized_keyinvalid
messagestringrequired
request_idRequestIdrequired
Request
curl -X GET 'https://api.zaraftis.com/v1/site-audits/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
One Site audit with collected data and issued issues

Was this page helpful?