Sign in

v1

latestOpenAPI 3.0.02026-07-224452146.0 KB
Crawling

Get the status of a crawl job

get/crawl/{id}

Response

Successful response

statusstring

The current status of the crawl. Can be scraping, completed, or failed.

totalinteger

The total number of pages that were attempted to be crawled.

completedinteger

The number of pages that have been successfully crawled.

creditsUsedinteger

The number of credits used for the crawl.

expiresAtstring date-time

The date and time when the crawl will expire.

createdAtstring date-time

The date and time when the crawl was started.

completedAtstring date-time

The date and time when the crawl finished. Present only when the crawl is in a terminal state (completed, failed, or cancelled).

durationnumber

Crawl duration in seconds. For terminal crawls, this is the elapsed time from createdAt to completedAt. For in-progress crawls, it is the elapsed time from createdAt to now.

nextstring nullable

The URL to retrieve the next 10MB of data. Returned if the crawl is not completed or if the response is larger than 10MB.