Overview
Generate Report
Generates a report for a selected schedule and date range. Use this endpoint to prepare downloadable report output for sharing, auditing, and trend analysis across captured screenshots.
Endpoint
POST
https://snapshot-api.mindiqglobal.com/api/v1/reports/screenshotRequest 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. |