This endpoint is intended for live monitoring use cases such as wallboard displays, supervisor dashboards, or agent-facing widgets that surface queue depth, wait times, or agent availability in real time.

Endoint

wss /rest/api/v1/realtime-metric-subscription

Query Parameters

Parameter	Type	Required	Description
`id`	string	Yes	The unique identifier of the reporting real-time metric
`auth_token`	string	Yes	The Service User API bearer token

Request

wss://<hostname>.xima.cloud/rest/api/v1/realtime-metric-subscription?id=<metric_id>&auth_token=<api_bearer_token>

Response

Returns a Handshake Details and JSON objects containing the subscribed real-time metrics of the CCaaS tenant.