Crawler
Get job
Get details of a job including its current status.
GET
/
crawler
/
jobs
/
{id}
Crawler jobs may take several minutes to complete. Use this endpoint to check the status of a job, and fetch the results from the Get job data endpoint when the job is complete.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id
string
requiredJob ID
Response
200 - application/json
id
string
requiredorg
string
requiredurls
string[]
requiredoutput_format
enum<string>
requiredAvailable options:
text, html, markdown output_expiry
integer
requiredRequired range:
x > 0min_length
number
requireduse_browser
boolean
requiredcreatedAt
number
requiredUNIX timestamp
status
enum<string>
requiredAvailable options:
starting, running, succeeded, failed, cancelled notices
object[]
requiredsitemapPageCount
number
requiredexclude_globs
string[]
exclude_elements
string
webhook_url
string
link_crawling
boolean
page_limit
number
Required range:
x > 0force_crawling_mode
enum<string>
Available options:
link, sitemap block_resources
boolean
default: trueinclude_linked_files
boolean
default: falsefinishedAt
number
UNIX timestamp
costMillicents
number
costCents
number
progress
object
webhookFails
any