The status service is independent to the CX Portal API and more in-depth calls can be made to this service.
API documentation for the status service can be accessed with the relevant URL - https://<server>.diseserver.net/player-status/apidoc/
A call to the CX Portal API is required to retrieve a token for the status service. This is to ensure all calls made to the status service are within user permissions.
Query strings can be used to request specific information from the status service.
CX Portal API query example usage:
query {
displayURLs {
info
status
log
overview
}
}This query will limit the amount of displays included to 24, by default.
The _limit:x and _page:x can be used to manage the amount of displays included in the query:
query {
displayURLs (_limit:30, _page:1) {
info
status
log
overview
}
}If too many displays are included in the query, the status service URL will be too long to process.
The CX Portal API will return a URL for use with status service. Optional parameters can be added:
https://<server>.diseserver.net/player-status/<token>?include=statuses,healthExample result from the status service:
{
"displays": [
{
"id": 123,
"name": "Display_1",
"healthStatus": "error",
"totalHealthStatus": "error",
"healthStatusUpdatedAt": "2025-07-20 14:58:12.33874",
"heartbeat": "2022-03-20 08:38:21.141354",
"health": {
"player": "ok",
"screen": "error",
"status": "error",
"content": "warning",
"override": null,
"playerUpdatedAt": "2025-08-20T08:38:21.141354",
"reasonForPlayer": null,
"reasonForScreen": "Error writing to com port 0: Error writing to comport id:undefined, error: Cannot read properties of undefined (reading 'comport')",
"screenUpdatedAt": "2025-08-20T08:38:21.141354",
"contentUpdatedAt": "2025-08-20T08:38:21.141354",
"reasonForContent": "video_1.mp4 (video onerror event fired)",
"isWithinOperatingHours": true
}
}
]
}Status Overview
A status overview of a brand can be retrieved using:
query {
brand (id:<brandid>){
displayOverviewURL
}
}The CX Portal API will return a URL for use with status service:
https://<server>.diseserver.net/player-status/overview/<token>Example result from the status service:
{
"displays": 32,
"playerOk": 5,
"playerWarning": 0,
"playerError": 26,
"contentOk": 26,
"contentWarning": 4,
"contentError": 1,
"screenOk": 30,
"screenWarning": 0,
"screenError": 1,
"statusOk": 2,
"statusWarning": 2,
"statusError": 25,
"statusService": 2,
"statusDisconnected": 0,
"insideOperatingHours": 32,
"outsideOperatingHours": 0,
"noStatus": 1
}A display with no status indicates that it’s an unpaired display.