Skip to content
Ranqo
Docs
DashboardGet started
GuidesMethodologyIntegrationsAPI
Video tutorials

Get started

  • Introduction
  • Quickstart
  • Authentication

Using the API

  • Rate limits
  • Errors
  • Pagination
  • Dates and time zones
  • Versioning

Account

  • Get the account

Brands

  • List brands
  • Get a brand

Visibility

  • Get visibility

Competitors

  • List competitors

Runs

  • List runs
  • Get a run

Prompts

  • List prompts
  • Get a prompt
  • List a prompt's answers

Site Access

  • Get site access

Page audits

  • List page audits
  • Get a page audit

Recommendations

  • List recommendations
  • Get a recommendation

Outreach

  • List outreach targets

5 sections

Page audits

Get a page audit

View as MarkdownOpen this page as .md
ChatGPTOpen in ChatGPTAsk about this pageClaudeOpen in ClaudeAsk about this page

Read one page audit by id, with each dimension's score, summary, recommendations and the checks behind the score.

HTTP
GET https://api.ranqo.ai/v1/brands/{brand_id}/page-audits/{audit_id}

One audit with each dimension's checks.

Path parameters#

NameTypeDescription
brand_idstringThe brand id, from GET /v1/brands.
audit_idstringThe audit id, from GET /v1/brands/{brand_id}/page-audits.

Response#

One audit of one page, with every dimension's checks.

FieldTypeDescription
idstring
urlstring
titlestring or null
statusstringOne of pending, analyzing, completed, failed.
page_typestring or nullWhat the page is, such as blog_article or product.
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.
scores.crawlabilityinteger or null0-100; null when the dimension was not audited.
scores.content_qualityinteger or null0-100; null when the dimension was not audited.
scores.page_speedinteger or null0-100; null when the dimension was not audited.
scores.ai_readinessinteger or null0-100; null when the dimension was not audited.
scores.citation_potentialinteger or null0-100; null when the dimension was not audited.
scores.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 null
created_atstringRFC 3339 timestamp in UTC.
completed_atstring or nullRFC 3339 timestamp in UTC.
errorstring or nullWhy the audit failed; null otherwise.
meta_descriptionstring or null
dimensionsarray of objectsEach dimension audited, with the checks behind its score.
dimensions[].idstringOne of crawlability, content_quality, page_speed, ai_readiness, citation_potential, authority_trust.
dimensions[].labelstring
dimensions[].scoreinteger
dimensions[].weightnumberIts share of the page score, 0-1: the shares of the dimensions audited sum to 1, as the score divides them.
dimensions[].summarystring
dimensions[].recommendationsarray of strings
dimensions[].signalsarray of objects
dimensions[].signals[].idstring
dimensions[].signals[].labelstring
dimensions[].signals[].statusstringOne of pass, warning, fail.
dimensions[].signals[].scorenumber
dimensions[].signals[].max_scorenumber
dimensions[].signals[].feedbackstring

Response headers#

HeaderDescription
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.

Example request#

curl
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/page-audits/AUDIT_ID" \
  -H "Authorization: Bearer $RANQO_API_KEY"

Errors#

Errors are problem details (application/problem+json) with a stable code. See Errors for each one.

StatusCodes
400unknown_parameter, api_key_in_url
401missing_api_key, invalid_api_key, api_key_revoked, api_key_expired, api_key_orphaned
403plan_upgrade_required, subscription_inactive
404not_found
429rate_limited
500internal_error
503service_unavailable
Previous page: List page auditsNext page: List recommendations
On this page
Ranqo
Docs
Dashboardranqo.aiPrivacyTerms
Be the Source AI Cites.
Ranqo
Docs
GuidesMethodologyIntegrationsAPI

Get started

  • Introduction
  • Quickstart
  • Authentication

Using the API

  • Rate limits
  • Errors
  • Pagination
  • Dates and time zones
  • Versioning

Account

  • Get the account

Brands

  • List brands
  • Get a brand

Visibility

  • Get visibility

Competitors

  • List competitors

Runs

  • List runs
  • Get a run

Prompts

  • List prompts
  • Get a prompt
  • List a prompt's answers

Site Access

  • Get site access

Page audits

  • List page audits
  • Get a page audit

Recommendations

  • List recommendations
  • Get a recommendation

Outreach

  • List outreach targets
Get started