API Reference

Overview

List Schedule Executions

The Snapshot Schedule Executions API lets you retrieve the execution history of a scheduled screenshot workflow. For a given schedule, you can view each execution's status, number of attempted screenshots, successful and failed captures, start and completion times, and processing duration. The endpoint supports pagination and sorting so applications can efficiently retrieve execution history even when a schedule has run many times. Use this endpoint to monitor scheduled screenshot jobs, review execution results, and identify failed or slow capture runs over time.

Endpoint

GEThttps://snapshot-api.mindiqglobal.com/api/v1/schedules/{scheduleId}/executions

Query Parameters

NameRequiredTypeDefaultDescription
pageNointeger0Zero-based page index.
sizeNointeger20Number of records per page.
sortNostringcreatedAt,descSorting format: field,direction.

Path Parameters

NameRequiredTypeDescription
scheduleIdYesintegerSchedule ID.

Success Response

{
  "content": [
    {
      "id": 3001,
      "status": "COMPLETED",
      "totalItems": 4,
      "successfulItems": 4,
      "failedItems": 0,
      "startedAt": "2026-08-06T09:00:00Z",
      "completedAt": "2026-08-06T09:01:10Z",
      "processingTimeMs": 70123,
      "createdAt": "2026-08-06T09:00:00Z"
    }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 1,
  "totalPages": 1
}

Response Body Parameters

NameTypeDescription
contentarraySchedule execution records.
content[].idintegerExecution ID.
content[].statusenumExecution status. Possible values: PROCESSING, COMPLETED, FAILED.
content[].totalItemsintegerTotal attempted items.
content[].successfulItemsintegerNumber of successful items.
content[].failedItemsintegerNumber of failed items.
content[].startedAtdatetimeExecution start datetime in ISO-8601 format.
content[].completedAtdatetime | nullExecution completion datetime in ISO-8601 format.
content[].processingTimeMsintegerExecution processing time in milliseconds.
content[].createdAtdatetimeExecution creation datetime in ISO-8601 format.
pageintegerCurrent page index.
sizeintegerPage size.
totalElementsintegerTotal number of records.
totalPagesintegerTotal number of pages.