listScreenSnapshots

GET

/api/v1/screens/{id}/snapshots

const url = 'https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/snapshots';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/snapshots

List a screen’s snapshots. Requires an authenticated dashboard user with the read scope.

Parameters

Path Parameters

required

string format: uuid

Query Parameters

limit

integer

>= 1 <= 200

Responses

200

Screen snapshots

application/json

object

data

required

object

items

required

Array<object>

object

required

string format: uuid

screenId

required

string format: uuid

capturedAt

required

string format: date-time

width

required

integer

height

required

integer

fileSize

required

integer

playerVersion

string

trigger

required

string

Allowed values: scheduled manual

enabled

required

boolean

retentionDays

required

integer

maxPerScreen

required

integer

proofNote

required

string

Example

{
  "data": {
    "items": [
      {
        "trigger": "scheduled"
      }
    ]
  }
}

401

Dashboard authentication required

403

Screen scope forbids this screen