/insights

Last updated 3 months ago

Was this helpful?

Get room insights

Gets a summary of insights collected for rooms.

get

/insights/rooms

Query parameters

roomNameobject

Filter results by room name.

createdAtobject

Filter rooms by the date they were created.

sortByany

Sort results by a field.

Example: totalSessions:asc

cursorany

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

Example: 8f4031bfc7640c5f267b11b6fe0c2507

limitinteger · min: 1 · max: 100 · default: 10

Limit the number of results.

Example: 30

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/insights/rooms'

200

401

429

{
  "cursor": "text",
  "results": [
    {
      "roomName": "/4b3bd908-cb88-11ec-9d64-0242ac120002",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "endAt": "2020-01-01T01:00:00.000Z",
      "firstSessionStartedAt": "2020-01-01T00:15:00.000Z",
      "lastSessionStartedAt": "2020-01-01T00:45:00.000Z",
      "totalParticipantMinutes": 124,
      "totalRecorderMinutes": 120,
      "totalStreamerMinutes": 120,
      "totalUniqueParticipants": 4,
      "totalUniqueRecorders": 2,
      "totalUniqueStreamers": 1,
      "totalSessions": 2
    }
  ]
}

Array of sorted rooms with their insights.

Get room session insights

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

get

/insights/room-sessions

Query parameters

roomNameanyrequired

Room name.

Example: /4b3bd908-cb88-11ec-9d64-0242ac120002

roomSessionIdany

Room session identifier.

Example: 32ba120a-a691-4e8e-aec3-a610239271de

sortByany

Sort results by a field.

Example: totalUniqueParticipants:asc

cursorany

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

Example: 8f4031bfc7640c5f267b11b6fe0c2507

limitinteger · min: 1 · max: 100 · default: 10

Limit the number of results.

Example: 30

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/insights/room-sessions'

200

401

429

{
  "cursor": "text",
  "results": [
    {
      "roomSessionId": "32ba120a-a691-4e8e-aec3-a610239271de",
      "roomName": "/4b3bd908-cb88-11ec-9d64-0242ac120002",
      "startedAt": "2020-01-01T00:00:00.000Z",
      "endedAt": "2020-01-01T01:00:00.000Z",
      "totalParticipantMinutes": 124,
      "totalRecorderMinutes": 120,
      "totalStreamerMinutes": 120,
      "totalUniqueParticipants": 4,
      "totalUniqueRecorders": 3,
      "totalUniqueStreamers": 2
    }
  ]
}

Array of sorted sessions with their insights.

Get participants

Gets a list of participants, by either a given session id or external id.

get

/insights/participants

Query parameters

roomSessionIdanyrequired

session ID. Either roomSessionId or externalId is required.

Example: 4b3bd908-cb88-11ec-9d64-0242ac120002

externalIdany

an externalId that was originally passed in query params by the participant when joining. Either roomSessionId or externalId is required.

sortByany

Sort results by a field. Accepted values are joinedAt and leftAt. Accepted sort values are asc and desc.

Example: joinedAt:asc

cursorany

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

Example: 8f4031bfc7640c5f267b11b6fe0c2507

limitinteger · min: 1 · max: 100 · default: 10

Limit the number of results.

Example: 30

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/insights/participants'

200

401

429

{
  "cursor": "text",
  "results": [
    {
      "roomSessionId": "32ba120a-a691-4e8e-aec3-a610239271de",
      "participantId": "/4b3bd908-cb88-11ec-9d64-0242ac120002",
      "deviceId": "text",
      "userId": "32ba120a-a691-4e8e-aec3-a610239271de",
      "roleName": "granted_visited",
      "displayName": "John Doe",
      "joinedAt": "2020-01-01T00:00:00.000Z",
      "leftAt": "2020-01-01T01:00:00.000Z",
      "externalId": "text"
    }
  ]
}

Array of sorted sessions participants with insights.

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

roomSessionIdanyrequired

session ID.

Example: 4b3bd908-cb88-11ec-9d64-0242ac120002

participantIdanyrequired

participant ID.

Example: 32ba120a-a691-4e8e-aec3-a610239271de

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/insights/participant'

200

401

429

[
  {
    "displayName": "text",
    "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",
    "timeStamp": "text",
    "sampleRateMs": 2000,
    "samples": {}
  }
]

Array of sorted sessions participants with insights.