Get display/player info for explicit IDs

Updated on Jun 30, 2026
Published on Jun 30, 2026

2 minute(s) read

Prev Next

Post

/info/{token}

Token is used for auth and scope; body ids are the request target set. At least one location id must be included.

Path parameters

token

stringRequired

Short-lived access token returned by GET /token.

Body parameters

object

ids

Array of string (EncodedId) Required

Encoded display or player IDs to fetch, filtered by token scope.

Min items1

string

Encoded DISE UID for a location, display, or player.

include

Array of string

Fields to include. The API also accepts a comma-separated string, but arrays are recommended for POST.

string

Valid values[ "health", "status", "hardware", "metadata", "services" ]

metadata

Array of string

Metadata fields to include. Use all to include all metadata.

string

Responses

200

Grouped display/player information.

Expand All

object

Grouped display/player information. Common group keys include displays, players, and displaysByBrand.

displays

Array of object (DeviceInfo)

object

Display or player information. Included fields depend on include and metadata filters.

string

Encoded DISE UID for a location, display, or player.

displayId

string

Encoded DISE UID for a location, display, or player.

playerId

string

Encoded DISE UID for a location, display, or player.

name

string

health

object (HealthSummary)

Health summary. Some fields may be null in actual responses.

player

string

Player health state such as ok, warning, or error.

screen

string

Screen health state such as ok, warning, or error.

status

string

Overall status health state.

content

string

Content health state.

playerUpdatedAt

string

Timestamp when player health was last updated.

screenUpdatedAt

string

Timestamp when screen health was last updated.

contentUpdatedAt

string

Timestamp when content health was last updated.

isWithinOperatingHours

boolean

Whether the display/player is inside operating hours.

metadata

object (DeviceMetadata)

Device metadata. Keys vary by platform and requested metadata fields.

gateway

string

Monitors

string

Platform

string

RemoteIP

string

ModelCode

string

ModelName

string

ipAddress

string

MemoryUsed

string

TimeOffset

string

macAddress

string

BrowserName

string

MemoryTotal

string

Temperature

string

Manufacturer

string

PlatformName

string

SerialNumber

string

ClientVersion

string

PlayerVersion

string

FirmwareVersion

string

MemoryAvailable

string

PlatformVersion

string

SoftwareVersion

string

SubPlatformName

string

BrowserUserAgent

string

StorageSpaceUsed

string

StorageSpaceTotal

string

StorageSpaceAvailable

string

StorageSpacePercentage

string

property*

string additionalProperties

status

object (CurrentStatusMap)

Map of current status names to status entries. Common keys include WAMP, Heartbeat, Application, and ClientAlarm.

property*

object (CurrentStatusEntry) additionalProperties

Current status entry. Common fields are since and value; value may be a boolean, string, number, object, null, or JSON-encoded string depending on the status type.

hardware

object

services

object

401

Authentication failed, or the path token is invalid or expired.

object

reason

string

Error category.

message

string

Human-readable error message.

timestamp

string

Error timestamp.

status

integer

HTTP status code.

422

Invalid query or body parameters.

object

reason

string

Error category.

message

string

Human-readable error message.

timestamp

string

Error timestamp.

status

integer

HTTP status code.

500

Unexpected server error.

object

reason

string

Error category.

message

string

Human-readable error message.

timestamp

string

Error timestamp.

status

integer

HTTP status code.

Was this article helpful?

Documentation Index

Get display/player info for explicit IDs