Skip to main content
GET
Get Crawl Report
Every finished crawl has a report. Use it when a page you expected is missing from the results: it lists every link the crawl didn’t follow, why, and the page the link was on.

Example Request

Response

A real report for a crawl of three book pages from a category page:
report is null while the crawl is still running, and for crawls that ran before reports existed.

Reasons

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

jobId
string
required

The crawl job ID.

Query Parameters

reason
enum<string>

Only list skipped URLs with this reason.

Available options:
not_relevant,
outside_domain,
include_pattern,
exclude_pattern,
file_type,
other_version_or_language,
duplicate_page,
redirected_off_site,
robots_txt,
action_link
limit
integer
default:200

How many skipped URLs to return.

Required range: 1 <= x <= 2000
offset
integer
default:0

How many skipped URLs to skip, for paging.

Required range: x >= 0

Response

The crawl report. report is null while the crawl is running, and for crawls that ran before reports existed.

status
enum<string>
Available options:
success
report
object | null
message
string