Page audits
Get a page audit
Read one page audit by id, with each dimension's score, summary, recommendations and the checks behind the score.
/v1/brands/{brand_id}/page-audits/{audit_id}One audit with each dimension's checks.
Authorization
AuthorizationstringheaderrequiredYour API key as Bearer ranqo_sk_…. The account owner creates keys in Settings, under API keys. See Authentication.
Path parameters
brand_idstringrequiredThe brand id, from GET /v1/brands.
audit_idstringrequiredThe audit id, from GET /v1/brands/{brand_id}/page-audits.
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/page-audits/AUDIT_ID" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
One audit of one page, with every dimension's checks.
idstringurlstringtitlestring or nullstatusstringOne of
pending,analyzing,completed,failed.page_typestring or nullWhat the page is, such as
blog_articleorproduct.page_scoreinteger or null0-100, the weighted score over the dimensions audited. Null until it completes.
scoresobjectEach dimension's 0-100 score. A page that served no text is scored on crawlability and page speed only; page speed is null when it could not be measured.
Show 6 fields insideHide the fields inside
crawlabilityinteger or null0-100; null when the dimension was not audited.
content_qualityinteger or null0-100; null when the dimension was not audited.
page_speedinteger or null0-100; null when the dimension was not audited.
ai_readinessinteger or null0-100; null when the dimension was not audited.
citation_potentialinteger or null0-100; null when the dimension was not audited.
authority_trustinteger or null0-100; null when the dimension was not audited.
seo_scoreinteger or null0-100.
geo_scoreinteger or null0-100, generative-engine optimization.
word_countinteger or nullcreated_atstringRFC 3339 timestamp in UTC.
completed_atstring or nullRFC 3339 timestamp in UTC.
errorstring or nullWhy the audit failed; null otherwise.
meta_descriptionstring or nulldimensionsarray of objectsEach dimension audited, with the checks behind its score.
Show 7 fields insideHide the fields inside
idstringOne of
crawlability,content_quality,page_speed,ai_readiness,citation_potential,authority_trust.labelstringscoreintegerweightnumberIts share of the page score, 0-1: the shares of the dimensions audited sum to 1, as the score divides them.
summarystringrecommendationsarray of stringssignalsarray of objectsShow 6 fields insideHide the fields inside
idstringlabelstringstatusstringOne of
pass,warning,fail.scorenumbermax_scorenumberfeedbackstring
Response headers
X-Request-IdThe request id; quote it to support.
RateLimitRequests left in this window and seconds until it resets.
RateLimit-PolicyThe key's limit per window.
Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.