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[]
requiredexclude_globs
string[]
exclude_elements
string
output_format
enum<string>
requiredAvailable options:
text
, html
, markdown
output_expiry
integer
requiredmin_length
number
requiredwebhook_url
string
use_browser
boolean
requiredlink_crawling
boolean
page_limit
number
force_crawling_mode
enum<string>
Available options:
link
, sitemap
block_resources
boolean
default: trueinclude_linked_files
boolean
default: falsecreatedAt
number
requiredUNIX timestamp
finishedAt
number
UNIX timestamp
costMillicents
number
costCents
number
status
enum<string>
requiredAvailable options:
starting
, running
, succeeded
, failed
, cancelled
notices
object[]
requiredsitemapPageCount
number
requiredprogress
object
webhookFails
any