latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Get room session insights

Gets a summary of usage for each session of a given room.

get/insights/room-sessions

Query parameters

Room name.

Room session identifier.

Sort results by a field.

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request.

limitinteger

Example:30

Limit the number of results.

Response

Array of sorted sessions with their insights.

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

Example response

{
  "results": [
    {
      "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
      "roomName": "/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd",
      "startedAt": "2025-01-01T00:00:00.000Z",
      "endedAt": "2025-01-01T01:00:00.000Z",
      "totalParticipantMinutes": 124,
      "totalRecorderMinutes": 120,
      "totalStreamerMinutes": 120,
      "totalUniqueParticipants": 4,
      "totalUniqueRecorders": 3,
      "totalUniqueStreamers": 2,
      "rating": 4.5,
      "totalRatings": 2
    }
  ]
}