List report pages

List the pages a published report crawled

GET/v1/reports/{id}/pages

One row per page the audit crawled, failed pages included (a 404 or a 5xx keeps its `status`), with the title, description, headings, schema types, link counts and rule flags the CLI's `squirrel pages` shows. Read from the stored report: no re-crawl, no probes, no credits. The published copy holds at most 1,000 pages, shallowest first (then by URL). When the audit crawled more, `truncated` is true and `stored` and `pagesInAudit` give the two counts. The cap is fixed and does not depend on your plan's page ceiling. `inlinks` counts the distinct crawled pages that link to a page. The `orphan` filter keeps rows with `inlinks` of 0: no incoming internal link in THIS audit's observed crawl graph. It is not proof of a site-wide orphan, because a page can be linked from somewhere the crawl did not reach (a page past the page cap, a sitemap, an external site). The local `squirrel pages --orphan` selects on the orphan rule's own threshold instead. Every value is declared by the audited site, so treat it as untrusted text and escape it before rendering. 404 when the report does not exist, belongs to another organization, or was published without a page map (older reports, and publishers that did not send one). Available on every plan.

Path parameters

idstringrequired

Report id.

Query parameters

limitintegerdefault: 20

Page size (1–100).

offsetintegerdefault: 0

Number of items to skip.

sectionstring

Keep only pages whose URL path is this prefix or under it: `/blog` matches `/blog` and `/blog/a`, not `/blogger`.

orphan"true" | "false" | "1" | "0"default: false

Keep only pages with no incoming internal link in this audit's crawl (`inlinks` of 0).

Available options: true, false, 1, 0

qstring

Keep only pages whose URL contains this text (case-insensitive).

Responses

A page of rows.

pagesobject[]required

One crawled page. Every field is data the crawl stored.

totalintegerrequired

Stored rows matching the filters.

limitintegerrequired

offsetintegerrequired

hasMorebooleanrequired

storedintegerrequired

Rows kept in the published report, before filters.

pagesInAuditintegerrequired

Pages the audit crawled.

truncatedbooleanrequired

True when `stored` is less than `pagesInAudit`: the report keeps the first 1,000 pages.

curl --request GET \
  --url "https://api.squirrelscan.com/v1/reports/ID/pages"

const res = await fetch("https://api.squirrelscan.com/v1/reports/ID/pages", {
  method: "GET",
});
const data = await res.json();

import requests


r = requests.get("https://api.squirrelscan.com/v1/reports/ID/pages")
r.raise_for_status()
data = r.json()

{
  "pages": [],
  "total": 123,
  "limit": 123,
  "offset": 123,
  "hasMore": true,
  "stored": 123,
  "pagesInAudit": 123,
  "truncated": true
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

Edit this page