Get Audit
Get full audit details including scorecard, findings, and fix prompts.
GET
/api/v1/audits/[slug]Get full audit details for a domain, including scorecard, detailed findings, opportunities, and optional fix prompts.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
slug | string | Required | Domain slug (e.g., "notion-com") |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
engine | string | Optional | Filter by engine (default: latest) |
include | string | Optional | Set to "fix_prompts" for actionable remediation advice |
Code Examples
Basic request:
With fix prompts:
Response
200Response 200 OK
Fix Prompts Response
When include=fix_prompts is set, the response includes two additional fields:
200Response 200 OK (with fix_prompts)
Fix prompts are sorted by
potential_impact (descending). Focus on the top 3 for the biggest score improvement.Scorecard Fields
Each entry in the scorecard array contains the following fields:
| Name | Type | Required | Description |
|---|---|---|---|
id | number | Required | Criterion ID (1-22) |
criterion | string | Required | Criterion name |
score | number | Required | Score 0-10 |
status | string | Required | "pass", "partial", or "fail" |
keyFindings | string | Required | Summary of findings |