List audit issues
List the pages affected by site audit issues, filtered by issue type or severity, with the details of each.
https://api.rankparse.com/v1/site-audit/issuesFreeAPI keyLists the individual problems a site audit found, one row per page and issue. Use it after Get a site audit tells you which issue types occur: for example, filter by broken_internal_link to get every page that links to a broken URL, with the broken targets.
Rows are ordered errors first, then warnings, then notices, then by issue and URL.
Query parameters
site_idstringrequiredA website id from Websites. A missing, unknown, archived or other workspace's id returns 404 site_audit_site_not_found.
audit_idstringAn 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.
issue_idstringOnly this issue type, for example duplicate_title. See the catalog. An unknown id returns 400 site_audit_invalid_request.
severitystringOnly error, warning or notice. Any other value returns 400 site_audit_invalid_request.
limitintegerdefault 100Rows to return, 1 to 500. Any other value returns 400 site_audit_invalid_request.
offsetintegerdefault 0Rows to skip, for paging.
Response
site_idstringThe website.
audit_idstring | nullThe audit the rows belong to. null when the website has no audit, or is not eligible.
statusstringThe audit's status. Issues are written when the audit completes, so a queued or running audit has none yet.
eligiblebooleanOnly present, as false, when the website cannot be audited (with reason). The list is then empty. See Eligibility.
totalintegerRows matching the filters, across all pages.
issuesarrayThe rows for this page of results.
Show propertiesHide properties
urlstring | nullThe page. null for an issue about the whole website (no_sitemap).
issue_idstringFor example http_4xx.
severitystringerror, warning or notice.
titlestring | nullWhat the issue is, in a short sentence.
detailsobject | nullFacts about this occurrence. The fields depend on the issue and are listed in the catalog. Lists such as linked_from, targets and others hold at most 10 URLs. null when the issue has none.
Behavior and limits
- Cost: 0 credits. It reads stored results only.
- Paging: use
limitandoffsetand stop whenoffset + issues.lengthreachestotal. - Permissions: needs the
site.readcapability. - Rate limit: 60 requests per minute per key. See Rate limiting.
Errors
| HTTP | Code | When |
|---|---|---|
| 400 | site_audit_invalid_request | issue_id, severity, limit or offset is not valid. |
| 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.
Related
MCP tool: get_site_audit_issues (accepts site_id, audit_id, issue_id, severity, limit and offset).