Sign inCreate a free account
Theme

Site crawls

Read a crawl, its pages, and the findings that repeat across a site.

A crawl follows links from a starting page and analyses everything it finds on the same site, up to your plan's page limit. Crawls are read-only through the API: start one in the dashboard, then read its results here.

Site crawl is on Pro and Agency. A key on Free or Basic gets 403 plan_excluded from these endpoints.

GET /site-crawls

List crawls

Every crawl this workspace has run, newest first.

Query parameters

NameTypeNotes
limitintegeroptional1 to 100. Defaults to 25.
statestringoptionalOne of queued, running, done, failed.

Request

curl "https://webrankpage.com/api/v1/site-crawls" \
  -H "Authorization: Bearer wrp_live_8fKp2mQx9tR4vN7c"

Response

{
    "site_crawls": [
        {
            "id": 594,
            "host": "onbixo.com",
            "label": "Full crawl before the redesign",
            "seed_url": "https://onbixo.com/",
            "state": "done",
            "pages_found": 157,
            "pages_fetched": 90,
            "pages_failed": 0,
            "max_pages": 90,
            "max_depth": 4,
            "created_at": "2026-09-24T06:33:08+00:00",
            "started_at": "2026-09-24T06:33:09+00:00",
            "finished_at": "2026-09-24T06:35:51+00:00",
            "error": null
        },
        {
            "id": 234,
            "host": "onbixo.com",
            "label": "Onbixo, after the redesign",
            "seed_url": "https://onbixo.com/",
            "state": "done",
            "pages_found": 92,
            "pages_fetched": 25,
            "pages_failed": 0,
            "max_pages": 25,

         truncated. The full response continues.

pages_found counts every URL discovered, including those skipped once the limit was reached. pages_fetched is what was actually analysed, and that is the number your plan caps.

GET /site-crawls/{id}

Read one crawl

The crawl with its totals and score distribution.

Request

curl "https://webrankpage.com/api/v1/site-crawls/594" \
  -H "Authorization: Bearer wrp_live_8fKp2mQx9tR4vN7c"

Response

{
    "site_crawl": {
        "id": 594,
        "host": "onbixo.com",
        "state": "done",
        "pages_fetched": 90,
        "pages_found": 157,
        "average_score": 71,
        "critical_pages": 4
    }
}

GET /site-crawls/{id}/pages

List the pages a crawl fetched

Every page, with its score and issue counts. This is the endpoint to use for a spreadsheet of a whole site.

Query parameters

NameTypeNotes
limitintegeroptional1 to 100. Defaults to 25.
offsetintegeroptionalHow many to skip.

Request

curl "https://webrankpage.com/api/v1/site-crawls/594/pages" \
  -H "Authorization: Bearer wrp_live_8fKp2mQx9tR4vN7c"

Response

{
    "pages": [
        {
            "id": 12,
            "url": "https://onbixo.com/pricing",
            "status": 200,
            "depth": 1,
            "score": 84,
            "critical_count": 0
        }
    ],
    "total": 90
}

GET /site-crawls/{id}/pages/{page_id}

Read one crawled page

The full detail for a single page in the crawl, including its findings.

Request

curl "https://webrankpage.com/api/v1/site-crawls/594/pages/12" \
  -H "Authorization: Bearer wrp_live_8fKp2mQx9tR4vN7c"

Response

{
    "page": {
        "id": 12,
        "url": "https://onbixo.com/pricing",
        "title": "Pricing",
        "score": 84,
        "word_count": 812,
        "internal_links": 34,
        "findings": []
    }
}

GET /site-crawls/{id}/findings

Findings across the whole crawl

The same issue grouped across every page it affects, which is how you find the template problem rather than the page problem.

Request

curl "https://webrankpage.com/api/v1/site-crawls/594/findings" \
  -H "Authorization: Bearer wrp_live_8fKp2mQx9tR4vN7c"

Response

{
    "findings": [
        {
            "check": "media.missing_alt",
            "severity": "recommended",
            "pages": 46,
            "message": "Images without alt text."
        }
    ]
}

Type to search. Try a check name from your report, an endpoint, or what you are trying to do.

↑↓ to move ↵ to open Esc to close