Cluster Viewer List (Batch)

Returns information about specific viewers by their IDs.

Request

Property	Value
Method	`POST`
URL	`/api/cluster/viewers/batch`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X POST "{BASE_URL}/api/cluster/viewers/batch" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Request Body

Parameter	Type	Required	Description
`connectionIds`	string[]	Yes	Array of viewer session IDs

Request Body

json

{
  "ids": [
    "v_1h1q37abmiiu8rvk",
    "v_xc4sdz3mmiisil28"
  ]
}

Response Body

Result Arrays

Parameter	Type	Description
`data.found`	array	Array of viewer objects that were found
`data.notFound`	string[]	Array of viewer IDs that were not found

Viewer

Parameter	Type	Description
`data.found[].id`	string	Unique identifier of the viewer session
`data.found[].state`	string	Connection state
`data.found[].class`	string	Internal harness class name
`data.found[].pipelineType`	string	Pipeline type
`data.found[].harnessType`	string	Harness type
`data.found[].applicationName`	string	Application name
`data.found[].streamKey`	string	Stream key being viewed
`data.found[].subStream`	string	Sub-stream variant
`data.found[].remoteAddress`	string	Client IP address
`data.found[].deviceType`	string	Device type, possible values: `"MOBILE"`, `"TABLET"`, `"DESKTOP"`
`data.found[].osName`	string	Operating system name
`data.found[].browserName`	string	Browser name
`data.found[].startTime`	integer	Connection start time (Unix timestamp in ms)
`data.found[].duration`	integer	Connection duration in milliseconds
`data.found[].inBandwidth`	integer	Incoming bandwidth in bytes/sec
`data.found[].outBandwidth`	integer	Outgoing bandwidth in bytes/sec
`data.found[].inTotalBytes`	integer	Total incoming bytes
`data.found[].outTotalBytes`	integer	Total outgoing bytes
`data.found[].healthScore`	integer	Connection health score (0-100, 0 when no data available)
`data.found[].healthGrade`	string	Connection health grade (e.g., `"Very Good"`, `"Bad"`, `"No Data"`)

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "found": [
      {
        "id": "v_1h1q37abmiiu8rvk",
        "state": "PUBLISHED",
        "class": "MSEPlaybackHarness",
        "pipelineType": "CLIENT_OUTPUT",
        "harnessType": "STORM_MSE_VIEWER",
        "applicationName": "edge",
        "streamKey": "f1",
        "subStream": "native",
        "remoteAddress": "83.11.204.8",
        "deviceType": "DESKTOP",
        "osName": "Windows 10/11",
        "browserName": "Chrome",
        "startTime": 1764332881283,
        "duration": 191361,
        "inBandwidth": 96,
        "outBandwidth": 446099,
        "inTotalBytes": 8703,
        "outTotalBytes": 97829494,
        "healthScore": 90,
        "healthGrade": "Very Good"
      }
    ],
    "notFound": [
      "v_nonexistent123"
    ]
  },
  "meta": {
    "executionTime": 1,
    "generatedAt": 1764333072645
  }
}

Parameter	Type	Description
`message`	string	Human-readable error message

Error Response (4xx/5xx)

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.