Snapshot | Website Screenshot API

Overview

Create Schedule

Creates a screenshot schedule with one or more items. Use this to automate recurring screenshot captures using one-time, interval, or cron scheduling.

Endpoint

POSThttps://snapshot-api.mindiqglobal.com/api/v1/schedules

Request Body

{
  "name": "Daily Homepage Check",
  "description": "Track homepage changes",
  "schedule": {
    "type": "INTERVAL",
    "firstRunAt": "2026-08-07T09:00:00Z",
    "intervalValue": 1,
    "intervalUnit": "DAYS"
  },
  "items": [
    {
      "url": "https://example.com",
      "width": 1920,
      "height": 1080,
      "fullPage": true,
      "format": "png"
    }
  ]
}

Request Body Parameters

Field	Required	Type	Description
name	Yes	string	Schedule name.
description	No	string	Schedule description.
schedule	Yes	object	Schedule timing configuration object.
schedule.type	Yes	enum	Schedule type. Possible values: ONCE, INTERVAL, CRON.
schedule.firstRunAt	Conditional	datetime	First run datetime in ISO-8601 format. Required for ONCE; optional for other types based on workflow.
schedule.intervalValue	Conditional	integer	Interval amount. Required when schedule.type is INTERVAL. Expected positive integer (for example, 1, 2, 12).
schedule.intervalUnit	Conditional	enum	Interval unit. Required when schedule.type is INTERVAL. Possible values: MINUTES, HOURS, DAYS, WEEKS, MONTHS.
schedule.cronExpression	Conditional	string	Cron expression. Required when schedule.type is CRON.
items	Yes	array	List of screenshot items to capture.
items[].url	Yes	string	Target URL (http:// or https://).
items[].width	No	integer	Viewport width. Expected positive integer (for example, 1280, 1920).
items[].height	No	integer	Viewport height. Expected positive integer (for example, 720, 1080).
items[].fullPage	No	boolean	Capture full page. Possible values: true, false.
items[].format	No	enum	Image format. Possible values: png, jpeg.

Success Response

{
  "id": 21,
  "name": "Daily Homepage Check",
  "description": "Track homepage changes",
  "status": "ACTIVE",
  "schedule": {
    "type": "INTERVAL",
    "firstRunAt": "2026-08-07T09:00:00Z",
    "intervalValue": 1,
    "intervalUnit": "DAYS",
    "cronExpression": null
  },
  "nextRunAt": "2026-08-07T09:00:00Z",
  "lastRunAt": null,
  "items": [
    {
      "id": 44,
      "url": "https://example.com",
      "width": 1920,
      "height": 1080,
      "fullPage": true,
      "format": "png",
      "createdAt": "2026-08-06T10:00:00Z",
      "updatedAt": "2026-08-06T10:00:00Z"
    }
  ],
  "createdAt": "2026-08-06T10:00:00Z",
  "updatedAt": "2026-08-06T10:00:00Z"
}

Response Body Parameters

Name	Type	Description
id	integer	Schedule ID.
name	string	Schedule name.
description	string \| null	Schedule description.
status	enum	Schedule status, Possible values: ACTIVE, COMPLETED
schedule	object	Schedule timing configuration.
schedule.type	enum	Possible values: ONCE, INTERVAL, CRON.
schedule.firstRunAt	datetime \| null	First run datetime in ISO-8601 format.
schedule.intervalValue	integer \| null	Interval value for interval schedules.
schedule.intervalUnit	enum \| null	Possible values: MINUTES, HOURS, DAYS, WEEKS, MONTHS.
schedule.cronExpression	string \| null	Cron expression for cron schedules.
nextRunAt	datetime \| null	Next run datetime in ISO-8601 format.
lastRunAt	datetime \| null	Last run datetime in ISO-8601 format.
items	array	Schedule items.
items[].id	integer	Schedule item ID.
items[].url	string	Target URL.
items[].width	integer \| null	Viewport width.
items[].height	integer \| null	Viewport height.
items[].fullPage	boolean	Full page flag. Possible values: true, false.
items[].format	enum	Possible values: png, jpeg.
items[].createdAt	datetime	Item creation datetime in ISO-8601 format.
items[].updatedAt	datetime	Item update datetime in ISO-8601 format.
createdAt	datetime	Schedule creation datetime in ISO-8601 format.
updatedAt	datetime	Schedule update datetime in ISO-8601 format.