listArchivedScreens

GET

/api/v1/screens/archive

const url = 'https://example.com/api/v1/screens/archive';
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/archive

List archived screens. Requires an authenticated dashboard user with the read scope.

Responses

200

Archived screens

application/json

object

data

required

object

items

required

Array<object>

object

required

string format: uuid

name

required

string

description

required

string

location

required

string

locationId

string format: uuid

locationDetails

object

required

string format: uuid

name

required

string

addressLine1

required

string

addressLine2

required

string

city

required

string

state

required

string

postalCode

required

string

country

required

string

latitude

number

longitude

number

screenCount

required

integer

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

roomName

required

string

roomNumber

required

string

mapPositionOverride

object

latitude

required

number

>= -90 <= 90

longitude

required

number

>= -180 <= 180

mapPosition

object

latitude

required

number

>= -90 <= 90

longitude

required

number

>= -180 <= 180

source

required

string

Allowed values: screen location

syncGroupId

string format: uuid

syncGroupName

string

nowPlayingName

string

nowPlayingType

string

platform

required

string

deviceManufacturer

required

string

deviceModel

required

string

androidVersion

required

string

playerVersion

required

string

playerVersionCode

integer format: int64

androidSdk

integer

installerSource

string

installPermissionStatus

string

currentUpdateDeploymentId

string format: uuid

updateState

string

updateDownloadedBytes

integer format: int64

updateExpectedBytes

integer format: int64

updateError

string

playerFamily

string

playerArchitecture

string

screenWidth

required

integer

screenHeight

required

integer

density

required

number format: float

locale

required

string

timezone

required

string

availableStorageBytes

integer format: int64

uptimeSeconds

integer format: int64

enabled

required

boolean

pairedAt

required

string format: date-time

lastConnectedAt

string format: date-time

lastDisconnectedAt

string format: date-time

lastHeartbeatAt

string format: date-time

lastKnownIp

string

lastContactAt

string format: date-time

status

required

The Server-computed Screen status. awaiting_player is a Browser Player Screen whose managed launch link has not been used yet. The set grows with new Player kinds; clients must tolerate values they do not recognize.

string

hasActiveCredential

required

boolean

archivedAt

string format: date-time

archivedReason

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

total

required

integer

Example

{
  "data": {
    "items": [
      {
        "mapPosition": {
          "source": "screen"
        }
      }
    ]
  }
}

401

Dashboard authentication required