Share a page report
share_scan_reportIdempotent
Give a finished page scan's report a public page, returned as share_url, where anyone with the link can read it, with thumbnails of the compressed images, without signing in. For handing the report to a client or a colleague. The page is kept out of search engines and answers only while the account has Pro. A Pro feature, refused with pro_required on other plans. Sharing a report that is already shared keeps its link. The link can be switched off from the website's report or the API.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The scan's id, as scan_page returned it. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The scan's id. | |
| url | No | The page scanned. | |
| hint | No | What to do next, while the scan or its images are still running. | |
| note | No | What the scan found, or why it stopped. | |
| audit | No | The page audit: oversized images, missing dimensions and alt text, lazy loading in the wrong place, the largest contentful paint. Null until the scan has finished. | |
| images | No | The images the scan found, newest first. | |
| status | No | ||
| skipped | No | The images the scan found and did not compress, each with why. | |
| settings | No | ||
| share_url | No | The page report's public link while it is shared; it answers only while the account has Pro. | |
| created_at | No | ||
| updated_at | No | ||
| saved_bytes | No | ||
| images_count | No | ||
| original_size | No | Bytes, over the finished images. | |
| saved_percent | No | ||
| optimized_size | No | Bytes, over the finished images. | |
| images_finished | No | ||
| images_in_progress | No | ||
| alt_texts_in_progress | No | Finished images whose AI alt text for the audit's suggested_alt is still being written. |