Documentation Index

Fetch the complete documentation index at: https://support.dise.com/llms.txt

Use this file to discover all available pages before exploring further.

New Dise One & CX Portal release! Click this link to read the release notes: Dise One 5.0 & CX Portal V42

Get display/player info

Prev Next
Get
/info/{token}

Returns grouped display/player information for IDs in the token payload. The token payload can be display, player or brand IDs. If metadata is provided, metadata is automatically included.

Path parameters
token
stringRequired

Short-lived access token returned by GET /token.

Query parameters
include
string

Comma-separated fields to include. Allowed values: health,status,hardware,metadata,services.

metadata
string

Comma-separated metadata field names, or all. If set, metadata is automatically included in the output.

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.

id
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.