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

# Get display/player info

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

## OpenAPI

````json GET /info/{token}
{
  "openapi": "3.1.0",
  "info": {
    "title": "Dise CX Player Status Service API",
    "version": "1.0.0",
    "description": "OpenAPI 3.1 specification for the Dise CX Player Status Service. The service creates short-lived path tokens, then uses those tokens to read display/player information, status history, logs, and overview counts. This upload-safe variant avoids advanced JSON Schema constructs that are often rejected by API action importers. Replace the server URL with your deployed HTTPS API host."
  },
  "servers": [
    {
      "url": "https://api.example.com",
      "description": "Replace with your public HTTPS service URL."
    }
  ],
  "tags": [
    {
      "name": "Token",
      "description": "Create short-lived access tokens."
    },
    {
      "name": "Info",
      "description": "Read display/player information."
    },
    {
      "name": "Status",
      "description": "Read display/player status history."
    },
    {
      "name": "Logs",
      "description": "Read display/player logs."
    },
    {
      "name": "Overview",
      "description": "Read high-level health overview counts."
    }
  ],
  "paths": {
    "/info/{token}": {
      "get": {
        "tags": [
          "Info"
        ],
        "operationId": "getInfo",
        "summary": "Get display/player info",
        "description": "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.",
        "parameters": [
          {
            "$ref": "#/components/parameters/TokenPath"
          },
          {
            "$ref": "#/components/parameters/Include"
          },
          {
            "$ref": "#/components/parameters/Metadata"
          }
        ],
        "responses": {
          "200": {
            "description": "Grouped display/player information.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InfoResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "TokenPath": {
        "name": "token",
        "in": "path",
        "required": true,
        "description": "Short-lived access token returned by GET /token.",
        "schema": {
          "type": "string"
        }
      },
      "Include": {
        "name": "include",
        "in": "query",
        "required": false,
        "description": "Comma-separated fields to include. Allowed values: health,status,hardware,metadata,services.",
        "schema": {
          "type": "string"
        }
      },
      "Metadata": {
        "name": "metadata",
        "in": "query",
        "required": false,
        "description": "Comma-separated metadata field names, or all. If set, metadata is automatically included in the output.",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "InfoResponse": {
        "type": "object",
        "description": "Grouped display/player information. Common group keys include displays, players, and displaysByBrand.",
        "properties": {
          "displays": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeviceInfo"
            }
          }
        },
        "additionalProperties": true
      },
      "DeviceInfo": {
        "type": "object",
        "description": "Display or player information. Included fields depend on include and metadata filters.",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/EncodedId"
          },
          "displayId": {
            "$ref": "#/components/schemas/EncodedId"
          },
          "playerId": {
            "$ref": "#/components/schemas/EncodedId"
          },
          "name": {
            "type": "string"
          },
          "health": {
            "$ref": "#/components/schemas/HealthSummary"
          },
          "metadata": {
            "$ref": "#/components/schemas/DeviceMetadata"
          },
          "status": {
            "$ref": "#/components/schemas/CurrentStatusMap"
          },
          "hardware": {
            "type": "object",
            "additionalProperties": true
          },
          "services": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "additionalProperties": true
      },
      "ErrorResponse": {
        "type": "object",
        "required": [
          "reason",
          "message",
          "timestamp",
          "status"
        ],
        "properties": {
          "reason": {
            "type": "string",
            "description": "Error category."
          },
          "message": {
            "type": "string",
            "description": "Human-readable error message."
          },
          "timestamp": {
            "type": "string",
            "description": "Error timestamp."
          },
          "status": {
            "type": "integer",
            "description": "HTTP status code."
          }
        },
        "additionalProperties": true
      },
      "EncodedId": {
        "type": "string",
        "description": "Encoded DISE UID for a location, display, or player."
      },
      "HealthSummary": {
        "type": "object",
        "description": "Health summary. Some fields may be null in actual responses.",
        "properties": {
          "player": {
            "type": "string",
            "description": "Player health state such as ok, warning, or error."
          },
          "screen": {
            "type": "string",
            "description": "Screen health state such as ok, warning, or error."
          },
          "status": {
            "type": "string",
            "description": "Overall status health state."
          },
          "content": {
            "type": "string",
            "description": "Content health state."
          },
          "playerUpdatedAt": {
            "type": "string",
            "description": "Timestamp when player health was last updated."
          },
          "screenUpdatedAt": {
            "type": "string",
            "description": "Timestamp when screen health was last updated."
          },
          "contentUpdatedAt": {
            "type": "string",
            "description": "Timestamp when content health was last updated."
          },
          "isWithinOperatingHours": {
            "type": "boolean",
            "description": "Whether the display/player is inside operating hours."
          }
        },
        "additionalProperties": true
      },
      "DeviceMetadata": {
        "type": "object",
        "description": "Device metadata. Keys vary by platform and requested metadata fields.",
        "properties": {
          "gateway": {
            "type": "string"
          },
          "Monitors": {
            "type": "string"
          },
          "Platform": {
            "type": "string"
          },
          "RemoteIP": {
            "type": "string"
          },
          "ModelCode": {
            "type": "string"
          },
          "ModelName": {
            "type": "string"
          },
          "ipAddress": {
            "type": "string"
          },
          "MemoryUsed": {
            "type": "string"
          },
          "TimeOffset": {
            "type": "string"
          },
          "macAddress": {
            "type": "string"
          },
          "BrowserName": {
            "type": "string"
          },
          "MemoryTotal": {
            "type": "string"
          },
          "Temperature": {
            "type": "string"
          },
          "Manufacturer": {
            "type": "string"
          },
          "PlatformName": {
            "type": "string"
          },
          "SerialNumber": {
            "type": "string"
          },
          "ClientVersion": {
            "type": "string"
          },
          "PlayerVersion": {
            "type": "string"
          },
          "FirmwareVersion": {
            "type": "string"
          },
          "MemoryAvailable": {
            "type": "string"
          },
          "PlatformVersion": {
            "type": "string"
          },
          "SoftwareVersion": {
            "type": "string"
          },
          "SubPlatformName": {
            "type": "string"
          },
          "BrowserUserAgent": {
            "type": "string"
          },
          "StorageSpaceUsed": {
            "type": "string"
          },
          "StorageSpaceTotal": {
            "type": "string"
          },
          "StorageSpaceAvailable": {
            "type": "string"
          },
          "StorageSpacePercentage": {
            "type": "string"
          }
        },
        "additionalProperties": {
          "type": "string"
        }
      },
      "CurrentStatusMap": {
        "type": "object",
        "description": "Map of current status names to status entries. Common keys include WAMP, Heartbeat, Application, and ClientAlarm.",
        "additionalProperties": {
          "$ref": "#/components/schemas/CurrentStatusEntry"
        }
      },
      "CurrentStatusEntry": {
        "type": "object",
        "description": "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.",
        "additionalProperties": true
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Authentication failed, or the path token is invalid or expired.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "UnprocessableEntity": {
        "description": "Invalid query or body parameters.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "ServerError": {
        "description": "Unexpected server error.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      }
    }
  }
}
````