Sign in
latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Get room insights

Gets a summary of insights collected for rooms.

get/insights/rooms

Query parameters

exactstring

Example: roomName[exact]=/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd

startsWithstring

Example: roomName[startsWith]=/room-prefix

containsstring

Example: roomName[contains]=793e9ec1

Filter results by room name.

fromstring date-time

Example: createdAt[from]=2025-01-01T00:00:00.000Z

tostring date-time

Example: createdAt[to]=2025-05-01T00:01:00.000Z

Filter rooms by the date they were created.

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 rooms 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": [
    {
      "roomName": "/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "endAt": "2025-01-01T01:00:00.000Z",
      "firstSessionStartedAt": "2025-01-01T00:15:00.000Z",
      "lastSessionStartedAt": "2025-01-01T00:45:00.000Z",
      "totalParticipantMinutes": 124,
      "totalRecorderMinutes": 120,
      "totalStreamerMinutes": 120,
      "totalUniqueParticipants": 4,
      "totalUniqueRecorders": 2,
      "totalUniqueStreamers": 1,
      "totalSessions": 2,
      "rating": 4.5,
      "totalRatings": 3
    }
  ]
}