v1

latestOpenAPI 3.0.02026-07-224452146.0 KB
Scraping

Get the status of a batch scrape job

get/batch/scrape/{id}

Response

Successful response

statusstring

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

totalinteger

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

completedinteger

The number of pages that have been successfully scraped.

creditsUsedinteger

The number of credits used for the batch scrape.

expiresAtstring date-time

The date and time when the batch scrape will expire.

createdAtstring date-time

The date and time when the batch scrape was started.

completedAtstring date-time

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

durationnumber

Batch scrape duration in seconds. For terminal batch scrapes, this is the elapsed time from createdAt to completedAt. For in-progress batch scrapes, it is the elapsed time from createdAt to now.

nextstring nullable

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