Get a site crawl
get_crawlOne site crawl: where it is, each of its pages with its status and image counts, the totals saved, and, once every page has finished, the site's report in audit: how many image addresses the pages had, how many are worth fixing, and how many have each finding (oversized, without width and height or alt text, lazy loading in the wrong place, the largest contentful paint unprioritized), an image the pages share counted once. Poll this, a few seconds apart, while a crawl runs: it is done once its status is completed or failed and pages_in_progress and images_in_progress are 0. Each page is a page scan: call get_scan with its id (and audit_images true) for what to fix on that page, list_images with scan set to its id for its images, and create_zip with crawl_id to download every page's images at once, a folder per page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The crawl's id, as crawl_site returned it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The crawl's id. | |
| url | No | The sitemap read, or the first page listed. | |
| hint | No | What to do next: poll again while pages or images are at work, then where each page's images and report are. | |
| note | No | Why the crawl failed. | |
| audit | No | The site's report, an image the pages share counted once. Null until the crawl is done. | |
| pages | No | Each page, in the order the crawl took them. | |
| source | No | ||
| status | No | completed once every page and its images have finished. failed: the crawl could not start its pages; note says why. | |
| settings | No | ||
| created_at | No | ||
| monitor_id | No | The weekly site check this crawl is a run of, or null. | |
| updated_at | No | ||
| pages_count | No | ||
| saved_bytes | No | ||
| images_count | No | ||
| pages_failed | No | ||
| original_size | No | Bytes, over the finished images. | |
| saved_percent | No | ||
| optimized_size | No | Bytes, over the finished images. | |
| pages_left_out | No | Pages past the plan's pages per crawl, not scanned. | |
| images_finished | No | ||
| pages_in_progress | No | ||
| images_in_progress | No |