getScreenPreview

GET

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

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

Read a screen’s latest preview metadata. Requires an enrolled dashboard session.

Parameters

Path Parameters

required

string format: uuid

Responses

200

Latest screen preview

application/json

object

data

required

object

screenId

required

string format: uuid

status

required

string

Allowed values: unavailable capture_error available loading

leaseExpiresAt

string format: date-time

capturedAt

string format: date-time

playerVersion

string

width

integer

height

integer

fileSize

integer

captureFailureStatus

string

imageAvailable

required

boolean

updatedAt

required

string format: date-time

Example

{
  "data": {
    "status": "unavailable"
  }
}

401

Dashboard authentication required