getScreenPreviewImage

GET

/api/v1/screens/{id}/preview/image

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

Download a screen’s latest preview image. Requires an enrolled dashboard session.

Parameters

Path Parameters

required

string format: uuid

Responses

200

Preview JPEG image

application/octet-stream

string format: binary

401

Dashboard authentication required

404

Screen or preview not found

409

Preview session expired