Get a page audit
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId} \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId}"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": {},
"status": "<string>",
"creditsReserved": 123,
"counts": {},
"pages": [
{}
],
"createdAt": "<string>",
"completedAt": {}
}Site diagnostics
Get a page audit
Read the status of a page audit and the progress of each audited page. Poll it after a 202 response, or wait for the site_audit.completed webhook.
GET
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
site-diagnostics
/
audits
/
{siteAuditId}
Get a page audit
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId} \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId}"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": {},
"status": "<string>",
"creditsReserved": 123,
"counts": {},
"pages": [
{}
],
"createdAt": "<string>",
"completedAt": {}
}Returns the status of a page audit and the status of each audited page. This is
the resource identified by the
Read errors use the flat or nested shapes described in Error codes. On
Location header from
Start a page audit.
Each page’s terminal result belongs to this audit and does not change when a
later audit runs. COMPLETED means every page has reached a terminal state,
not that every page succeeded: inspect counts.failed and counts.skipped.
An interrupted treatment can remain QUEUED or AUDITING while its exact result
is recovered. A page whose run can no longer exist is FAILED: queueing is
retried within 24 hours of acceptance, at most 12 times, and queued runs expire
after 7 days. A run that is still active on the queue is waited for.
Get a monitored page
returns that page’s latest scores, which may come from a newer audit.
Available on Growth, Agency Growth, Business, Agency Business and Enterprise plans. See Authentication.
Response
Audit credit budget: 5 per page to audit, adjusted when dispatch refuses pages. Not an immediate hold or the final amount spent
One entry per page with
pageId, status (QUEUED, AUDITING, COMPLETED, FAILED or SKIPPED) and completedAt (nullable).ISO 8601 time when the audit finished, or
null while it runs. Once the site_audit.completed event exists, this is the completedAt of that event. It can be later than the last page date when the last pages were skipped or queueing closed laterSynthetic request and response
curl "https://www.qwairy.co/api/v1/brands/$BRAND_ID/site-diagnostics/audits/$SITE_AUDIT_ID" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN"
{
"id": "aaaaaaaa-0000-4000-8000-000000000000",
"status": "COMPLETED",
"counts": { "total": 1, "succeeded": 1, "failed": 0, "skipped": 0, "running": 0 },
"creditsReserved": 5,
"pages": [
{
"pageId": "99999999-0000-4000-8000-000000000000",
"status": "COMPLETED",
"completedAt": "2026-10-12T09:03:00.000Z"
}
],
"createdAt": "2026-10-12T09:00:00.000Z",
"completedAt": "2026-10-12T09:03:00.000Z"
}
Errors
| Status | Code | Cause |
|---|---|---|
401 | Flat body | Missing or invalid token |
403 | INSUFFICIENT_PLAN | Generic plan refusal: “This endpoint is not included in the team’s plan.” |
404 | RESOURCE_NOT_FOUND | The workspace or audit is missing or inaccessible |
429, honor Retry-After.
