Read the newest site audit of a website, or one by id, with its progress, score and issues grouped by type.

GEThttps://api.rankparse.com/v1/site-auditFreeAPI key

Returns a site audit of one website: its status and progress, a score, and the issues found grouped by type, each with its severity, a plain explanation, how to fix it, how many pages are affected and how that changed since the previous completed audit. It reads stored results and never crawls.

To see the pages behind an issue, use List audit issues. To start one, use Run a site audit.

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 from history or Run a site audit. 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.

Response

site_idstring

The website asked for.

hoststring

The website's canonical host.

eligibleboolean

false when the website cannot be audited. audit is then null and issues and history are empty.

reasonstring | null

null when eligible. not_verified when no verified Google or Bing property is attached, plan_required when the workspace is on the Free plan. See Eligibility.

max_pagesinteger

The page budget a new audit would get on this plan. Absent when not eligible.

auditobject | null

The audit. null for an eligible website that has never been audited.

Show properties

audit_idstring

For example aud_Qm3x9bT2kZ7vLw1PdRf8N.

statusstring

queued, running, completed or failed.

requested_atinteger

Unix milliseconds.

started_atinteger | null

When the first chunk started, in Unix milliseconds. null while queued.

finished_atinteger | null

When the audit completed or failed. null while it runs.

max_pagesinteger

The page budget of this audit.

crawled_hoststring | null

The host that was crawled: where the home page landed. null before the crawl starts.

sitemap_foundboolean | null

Whether an XML sitemap was found. null before the crawl starts.

pages_crawledinteger

Pages fetched so far (answered, failed or blocked by robots.txt).

pages_discoveredinteger

Pages found so far, fetched or not. Both numbers grow while the audit runs, so pages_crawled / pages_discovered is a progress indicator, not a percentage of the final total.

page_limit_reachedboolean

true when the page budget stopped the crawl. The counts then cover only the crawled pages.

scoreinteger | null

0 to 100: the share of checked pages with no error-level issue. null until the audit completes. See Score.

error_codestring | null

Set when status is failed. See Statuses.

summaryobject | null

Set when the audit completes: pages_checked, pages_with_errors, by_severity (counts of error, warning and notice issues), by_issue (a count per issue id), issues_found and issues_stored (these differ only when more than 5,000 issues were found).

issuesarray

One entry per issue type found, errors first, then by count.

Show properties

issue_idstring

For example broken_internal_link. See the catalog.

severitystring

error, warning or notice.

titlestring

What the issue is, in a short sentence.

fixstring

How to fix it, in plain language.

countinteger

Pages affected (or 1 for a website-level issue such as no_sitemap).

change_since_previousinteger | null

This audit's count minus the previous completed audit's. Negative means fewer. null when there is no previous audit.

resolved_since_previousarray

Issue types the previous completed audit had and this one does not, each { issue_id, title, was } where was is the old count. Empty when there is no previous audit.

previous_auditobject | null

{ audit_id, score, finished_at } of the completed audit used for the comparison.

historyarray

The kept audits, newest first (at most 3): { audit_id, status, score, pages_crawled, requested_at, finished_at }.

Behavior and limits

Cost: 0 credits. It reads stored results only.
While an audit runs: audit.status is queued or running, score and summary are null, and issues is empty until it completes.
Permissions: needs the site.read capability.
Rate limit: 60 requests per minute per key. See Rate limiting.

Errors

HTTP	Code	When
401	`invalid_api_key`	Missing, invalid or revoked API key.
403	`capability_missing`	Your workspace role cannot read websites.
404	`site_audit_site_not_found`	`site_id` is missing or not a website in your workspace.
404	`site_audit_not_found`	`audit_id` is not an audit of this website.
429	`rate_limited`	More than 60 requests in a minute.

See Errors for the error body format.

MCP tool: get_site_audit (accepts site_id and audit_id).

curl "https://api.rankparse.com/v1/site-audit?site_id=site_abc123" \
  -H "X-API-Key: rp_your_key"

Response

{
  "site_id": "site_abc123",
  "host": "example.com",
  "eligible": true,
  "reason": null,
  "max_pages": 200,
  "audit": {
    "audit_id": "aud_Qm3x9bT2kZ7vLw1PdRf8N",
    "status": "completed",
    "requested_at": 1794470400000,
    "started_at": 1794470402113,
    "finished_at": 1794470431940,
    "max_pages": 200,
    "crawled_host": "example.com",
    "sitemap_found": true,
    "pages_crawled": 87,
    "pages_discovered": 87,
    "page_limit_reached": false,
    "score": 92,
    "error_code": null,
    "summary": {
      "pages_checked": 87,
      "pages_with_errors": 7,
      "by_severity": { "error": 8, "warning": 14, "notice": 31 },
      "by_issue": { "http_4xx": 2, "broken_internal_link": 6, "duplicate_title": 6 },
      "issues_stored": 53,
      "issues_found": 53
    }
  },
  "issues": [
    {
      "issue_id": "broken_internal_link",
      "severity": "error",
      "title": "Page links to a broken internal URL",
      "fix": "Update or remove the links listed in the details.",
      "count": 6,
      "change_since_previous": -2
    },
    {
      "issue_id": "duplicate_title",
      "severity": "warning",
      "title": "Title used by several pages",
      "fix": "Give each page a title that says what is different about it.",
      "count": 6,
      "change_since_previous": 0
    }
  ],
  "resolved_since_previous": [
    { "issue_id": "redirect_chain", "title": "URL redirects more than once", "was": 3 }
  ],
  "previous_audit": { "audit_id": "aud_Xk2m8vR4nB6tYc9HjQe1A", "score": 89, "finished_at": 1793865631204 },
  "history": [
    { "audit_id": "aud_Qm3x9bT2kZ7vLw1PdRf8N", "status": "completed", "score": 92, "pages_crawled": 87, "requested_at": 1794470400000, "finished_at": 1794470431940 },
    { "audit_id": "aud_Xk2m8vR4nB6tYc9HjQe1A", "status": "completed", "score": 89, "pages_crawled": 85, "requested_at": 1793865600000, "finished_at": 1793865631204 }
  ]
}

200 not eligible

{
  "site_id": "site_abc123",
  "host": "example.com",
  "eligible": false,
  "reason": "plan_required",
  "audit": null,
  "issues": [],
  "history": []
}

Get a site audit

Query parameters

Response

Behavior and limits

Errors

Run a site audit

List audit issues

List audited pages

Get a site audit

Query parametersCopy Anchor Link

ResponseCopy Anchor Link

Behavior and limitsCopy Anchor Link

ErrorsCopy Anchor Link

RelatedCopy Anchor Link

Run a site audit

List audit issues

List audited pages

Query parameters

Response

Behavior and limits

Errors

Related