Skip to Content
RankParseDocs
ChangelogDashboardGet API key
DocumentationAPI Reference
Site audit

List audited pages

List the pages a site audit crawled, with status, title, canonical, indexability, word count, inlinks and click depth.

GEThttps://api.rankparse.com/v1/site-audit/pagesFreeAPI key

Lists every URL a site audit found, in the order the crawl discovered them, with what the crawler read from each. Use it to find pages by status (all the redirects, all the pages robots.txt blocked), to export an audit, or to look at one page's title, canonical and inlinks.

Query parameters

site_idstringrequired

A website id from Websites. A missing, unknown, archived or other workspace's id returns 404 site_audit_site_not_found.

audit_idstring

An audit id. Defaults to the newest audit of the website. An id that is not one of this website's audits returns 404 site_audit_not_found.

statusstring

Only pages in one group: ok (a 2xx answer), redirect (a 3xx), client_error (a 4xx, including a redirect that ends on one), server_error (a 5xx), failed (no answer: timeout or connection failure), blocked (robots.txt disallows it) or pending (not reached yet). Any other value returns 400 site_audit_invalid_request.

indexableboolean

true for pages a search engine may index (200 HTML, no noindex, no canonical to another URL), false for the pages that were read and may not. Pages that were not parsed have no value and match neither.

limitintegerdefault 100

Rows to return, 1 to 500.

offsetintegerdefault 0

Rows to skip, for paging.

Response

site_idstring

The website.

audit_idstring | null

The audit the rows belong to. null when the website has no audit, or is not eligible.

statusstring

The audit's status. Pages are listed while it runs: a running audit shows the pages found so far, most still pending.

eligibleboolean

Only present, as false, when the website cannot be audited (with reason). The list is then empty. See Eligibility.

totalinteger

Pages matching the filters, across all pages of results.

pagesarray

The rows for this page of results.

Show properties
urlstring

The URL as the crawler normalized it: lower-case host, no fragment, no tracking parameters.

statestring

done, error, blocked or pending.

depthinteger | null

Clicks from the home page. null for a page only the sitemap led to.

in_sitemapboolean

Whether the XML sitemap lists the URL.

http_statusinteger | null

The first response's status. For a redirecting URL this is the 3xx.

final_statusinteger | null

The status of the response the redirects ended on. Equals http_status when there is no redirect.

final_urlstring | null

Where the URL ended up after redirects.

response_msinteger | null

Time to receive the page, in milliseconds.

bytesinteger | null

Bytes read. At most 1 MB is read.

titlestring | null

The page title. Read only from a 200 HTML page that answered at its own URL, as are the content fields below (down to images_missing_alt). x_robots_tag is the exception: it comes from the response headers of any page that answered.

meta_descriptionstring | null

The meta description.

h1string | null

The first H1.

h1_countinteger | null

How many H1 headings the page has.

canonicalstring | null

The canonical URL the page declares, normalized.

meta_robotsstring | null

The robots meta tag content.

x_robots_tagstring | null

The X-Robots-Tag response header.

indexableboolean | null

null when the page was not parsed.

word_countinteger | null

Words of visible text.

langstring | null

The language from the lang attribute, a Content-Language header or a meta tag.

structured_typesarray | null

The schema.org types in the page's JSON-LD, for example ["Organization", "WebSite"].

internal_link_countinteger | null

Internal links on the page, counting each target once.

external_link_countinteger | null

Links to other hosts.

inlinksinteger | null

Crawled pages that link to this one. Filled in when the audit completes.

images_missing_altinteger | null

Images without alt text.

error_codestring | null

For a error page: timeout, fetch_failed, private_ip or invalid_url.

Behavior and limits

  • Cost: 0 credits. It reads stored results only.
  • Order: the order the crawl discovered the pages: the home page first, then the pages it linked to.
  • Permissions: needs the site.read capability.
  • Rate limit: 60 requests per minute per key. See Rate limiting.

Errors

HTTPCodeWhen
400site_audit_invalid_requeststatus, indexable, limit or offset is not valid.
401invalid_api_keyMissing, invalid or revoked API key.
403capability_missingYour workspace role cannot read websites.
404site_audit_site_not_foundsite_id is missing or not a website in your workspace.
404site_audit_not_foundaudit_id is not an audit of this website.
429rate_limitedMore than 60 requests in a minute.

See Errors for the error body format.

MCP tool: get_site_audit_pages (accepts site_id, audit_id, status, indexable, limit and offset).

Get a site audit

Score and issues by type.

List audit issues

The problems found, page by page.

List audit issues

List the pages affected by site audit issues, filtered by issue type or severity, with the details of each.

Project context

A shared note about each website (what the business does, its goal, competitors and key pages) that you and your agents read before researching and update afterwards.