latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Get details for a participant in a session

Returns session data such as user agent, bandwidth and packet loss for the participant.

get/insights/participant

Query parameters

session ID.

participant ID.

Response

Array of sorted sessions participants with insights.

displayNamestring required

Display name of the participant.

userRolestring required

The role of the participant.

userAgentstring required

User agent string of the participant.

timeStampstring required

Timestamp the participant joined the session.

sampleRateMsnumber required

The interval (in milliseconds) the samples are collected in.

samplesobject required

Data object arrays with network data. packetLossSend, packetLossRecv, bitrateSend and bitrateRecv.

Example response

[
  {
    "userRole": "host",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36",
    "sampleRateMs": 2000
  }
]