API Reference

Overview

List Reports

Retrieves a paginated list of generated screenshot reports. Use this endpoint to browse, view, and download previously generated reports. Pagination is supported for efficient retrieval of large result sets.

Endpoint

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

Query Parameters

NameRequiredTypeDefaultDescription
pageNointeger0Zero-based page index.
sizeNointeger20Number of records per page.
sortNostringid,descSorting 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

NameTypeDescription
contentarrayReport records.
content[].reportIdintegerReport ID.
content[].executionIdintegerSchedule execution ID.
content[].scheduleNamestringSchedule name used for report generation.
content[].totalScreenshotsintegerNumber of screenshots included in the report.
content[].debitAmountnumberCharged amount for report generation.
content[].statusstringReport generation status (example: COMPLETED).
content[].downloadUrlstringReport download URL.
content[].generatedAtdatetimeReport generation datetime in ISO-8601 format.
pageintegerCurrent page index.
sizeintegerPage size.
totalElementsintegerTotal number of records.
totalPagesintegerTotal number of pages.