getScreenSnapshotImage

GET

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

const url = 'https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/snapshots/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/image';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/image

Download a screen snapshot image. Requires an authenticated dashboard user with the read scope.

Parameters

Path Parameters

required

string format: uuid

snapshotId

required

string format: uuid

Responses

200

Snapshot image

application/octet-stream

string format: binary

401

Dashboard authentication required

403

Screen scope forbids this screen

404

Snapshot not found