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

6 sections

Page audits

List page audits

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

List a brand's page audits, newest first, with each page's score and its score on every dimension audited.

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

The brand's page audits, newest first, as the Page Audit history lists them.

Path parameters#

NameTypeDescription
brand_idstringThe brand id, from GET /v1/brands.

Query parameters#

Every parameter is optional. A parameter the endpoint does not take is refused with unknown_parameter.

NameTypeDefaultDescription
limitinteger50Items per page, 1 to 100.
cursorstringThe next_cursor of the previous page.
statusstringOnly audits in this state. One of pending, analyzing, completed, failed.

Response#

The response body, as JSON.

FieldTypeDescription
dataarray of objects
data[].idstring
data[].urlstring
data[].titlestring or null
data[].statusstringOne of pending, analyzing, completed, failed.
data[].page_typestring or nullWhat the page is, such as blog_article or product.
data[].page_scoreinteger or null0-100, the weighted score over the dimensions audited. Null until it completes.
data[].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.
data[].scores.crawlabilityinteger or null0-100; null when the dimension was not audited.
data[].scores.content_qualityinteger or null0-100; null when the dimension was not audited.
data[].scores.page_speedinteger or null0-100; null when the dimension was not audited.
data[].scores.ai_readinessinteger or null0-100; null when the dimension was not audited.
data[].scores.citation_potentialinteger or null0-100; null when the dimension was not audited.
data[].scores.authority_trustinteger or null0-100; null when the dimension was not audited.
data[].seo_scoreinteger or null0-100.
data[].geo_scoreinteger or null0-100, generative-engine optimization.
data[].word_countinteger or null
data[].created_atstringRFC 3339 timestamp in UTC.
data[].completed_atstring or nullRFC 3339 timestamp in UTC.
data[].errorstring or nullWhy the audit failed; null otherwise.
has_morebooleanWhether another page follows.
next_cursorstring or nullPass as cursor for the next page; null on the last page.

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" \
  -H "Authorization: Bearer $RANQO_API_KEY"

Errors#

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

StatusCodes
400invalid_parameter, unknown_parameter, invalid_cursor, 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: Get site accessNext page: Get a page audit
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