Skip to main content
GET
Get active viewers in a room

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

roomId
string
required

The ID of the room

Query Parameters

orderBy
enum<string>
Available options:
asc,
desc
limit
integer
default:200

Maximum number of viewers to return

Required range: 1 <= x <= 200

Response

Get room viewers response

List of room viewers

viewers
object[]
required
total
integer
required

Number of viewers returned in this response

limit
integer
required

Maximum number of viewers requested