List Screenshot Reports API

Overview

List Reports

The Snapshot List Reports API lets you retrieve a paginated list of screenshot reports that have already been generated. Each report record can include its report ID, associated schedule execution, schedule name, number of screenshots, report status, download URL, and generation timestamp. Pagination and sorting options make it possible to efficiently browse a large collection of generated reports. Use this endpoint when your application needs to display, manage, or provide access to previously generated website screenshot reports.

Endpoint

GEThttps://snapshot-api.mindiqglobal.com/api/v1/reports

Query Parameters

Name	Required	Type	Default	Description
page	No	integer	0	Zero-based page index.
size	No	integer	20	Number of records per page.
sort	No	string	id,desc	Sorting format: field,direction.

Success Response

{
  "content": [
    {
      "reportId": 10,
      "executionId": 21,
      "scheduleName": "Daily Website Monitoring",
      "totalScreenshots": 18,
      "debitAmount": 0.01,
      "status": "COMPLETED",
      "downloadUrl": "http://localhost:8080/reports/report-10.pdf",
      "generatedAt": "2026-07-31T00:00:00Z"
    }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 1,
  "totalPages": 1
}

Response Body Parameters

Name	Type	Description
content	array	Report records.
content[].reportId	integer	Report ID.
content[].executionId	integer	Schedule execution ID.
content[].scheduleName	string	Schedule name used for report generation.
content[].totalScreenshots	integer	Number of screenshots included in the report.
content[].debitAmount	number	Charged amount for report generation.
content[].status	string	Report generation status (example: COMPLETED).
content[].downloadUrl	string	Report download URL.
content[].generatedAt	datetime	Report generation datetime in ISO-8601 format.
page	integer	Current page index.
size	integer	Page size.
totalElements	integer	Total number of records.
totalPages	integer	Total number of pages.