crawler_job_status
Read-onlyIdempotent
Track the progress of a crawl job by retrieving counts of done, failed, and active pages. Use to detect completion after starting a job.
Instructions
Get the status of a ScraperAPI crawl job.
Returns counts of pages that are done, failed, and active for the job,
letting you track progress and detect completion. Poll this after
'crawler_job_start' until the job is finished.
When to use:
- Tracking progress or detecting completion of a job from 'crawler_job_start'
When NOT to use:
- Retrieving the crawled page contents (those are delivered to the job's
callback_url webhook, not returned here)
Args:
params (CrawlerJobRefParams): job_id (required) — the id returned by
crawler_job_start.
Returns:
str: JSON with the job's page counts (done/failed/active).
Raises:
ToolError: If the API key is missing, the rate limit is exceeded, or
the request fails.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |