Screenshot Report API

Overview

Generate Report

The Snapshot Screenshot Report API lets you generate a downloadable report from a completed screenshot schedule execution. Reports can include schedule information, screenshot item details, and image URLs depending on the options provided in the request. The generated report response includes the report ID, generation status, download URL, number of screenshots included, and generation timestamp. Use this endpoint to create shareable screenshot reports for website monitoring, audits, client reporting, historical review, and other workflows that require a consolidated record of captured screenshots.

Endpoint

POSThttps://snapshot-api.mindiqglobal.com/api/v1/reports/screenshot

Request Body

{
  "executionId": 21,
  "includeScheduleName": true,
  "includeScheduleDescription": true,
  "includeItemInformation": true,
  "includeImageUrl": true
}

Request Body Parameters

Field	Required	Type	Description
executionId	Yes	integer	Schedule execution ID used for report generation.
includeScheduleName	No	boolean	Include schedule name in the report. Possible values: `true`, `false`.
includeScheduleDescription	No	boolean	Include schedule description in the report. Possible values: `true`, `false`.
includeItemInformation	No	boolean	Include schedule item metadata in the report. Possible values: `true`, `false`.
includeImageUrl	No	boolean	Include image URL text in the report. Possible values: `true`, `false`.

Success Response

{
  "reportId": 10,
  "status": "COMPLETED",
  "downloadUrl": "https://mindiqglobal-snapshot-public-data-prod.s3.amazonaws.com/reports/report-10.pdf",
  "totalScreenshots": 18,
  "generatedAt": "2026-07-31T00:00:00Z"
}

Response Body Parameters

Name	Type	Description
reportId	integer	Generated report ID.
status	string	Report generation status (example: `COMPLETED`).
downloadUrl	string	Report download URL.
totalScreenshots	integer	Number of screenshots included in the generated report.
generatedAt	datetime	Report generation datetime in ISO-8601 format.