API referenceWebsite

Get Website Status

Get the status of a website crawling job.

Authentication

AuthorizationBearer

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

Path Parameters

domainstringRequired

Query Parameters

job_idstringRequired
The job ID returned from the index endpoint

Response

Successful Response
job_idstring
statusstring

Job status: PENDING, PROCESSING, COMPLETED, or FAILED

base_urlstring
pages_indexedinteger
Number of pages successfully indexed
pages_failedinteger
Number of pages that failed to index
errorstring or null
Error message if the job failed

Errors