/insights
Last updated
Was this helpful?
Last updated
Was this helpful?
Gets a summary of insights collected for rooms.
Sort results by a field.
totalSessions:ascThe cursor for paginating through the results. To fetch the next page,
set the cursor to the cursor returned by the previous request.
8f4031bfc7640c5f267b11b6fe0c2507Limit the number of results.
10Example: 30GET /v1/insights/rooms HTTP/1.1
Host: api.whereby.dev
Accept: */*
{
"cursor": "text",
"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
}
]
}Gets a summary of usage for each session of a given room.
Room name.
/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fdRoom session identifier.
e2f29530-46ec-4cee-8b27-e565cb5bb2e9Sort results by a field.
totalUniqueParticipants:ascThe cursor for paginating through the results. To fetch the next page,
set the cursor to the cursor returned by the previous request.
8f4031bfc7640c5f267b11b6fe0c2507Limit the number of results.
10Example: 30GET /v1/insights/room-sessions HTTP/1.1
Host: api.whereby.dev
Accept: */*
{
"cursor": "text",
"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
}
]
}Gets a list of participants, by either a given session id or external id.
session ID. Either roomSessionId or externalId is required.
e2f29530-46ec-4cee-8b27-e565cb5bb2e9an externalId that was originally passed in query params by the participant when joining. Either roomSessionId or externalId is required.
Sort results by a field. Accepted values are joinedAt and leftAt. Accepted sort values are asc and desc.
joinedAt:ascThe cursor for paginating through the results. To fetch the next page,
set the cursor to the cursor returned by the previous request.
8f4031bfc7640c5f267b11b6fe0c2507Limit the number of results.
10Example: 30GET /v1/insights/participants HTTP/1.1
Host: api.whereby.dev
Accept: */*
{
"cursor": "text",
"results": [
{
"roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
"participantId": "/4b3bd908-cb88-11ec-9d64-0242ac120002",
"deviceId": "text",
"userId": "32ba120a-a691-4e8e-aec3-a610239271de",
"roleName": "granted_visited",
"displayName": "John Doe",
"joinedAt": "2025-01-01T00:00:00.000Z",
"leftAt": "2025-01-01T01:00:00.000Z",
"externalId": "text"
}
]
}Returns session data such as user agent, bandwidth and packet loss for the participant.
session ID.
e2f29530-46ec-4cee-8b27-e565cb5bb2e9participant ID.
32ba120a-a691-4e8e-aec3-a610239271deGET /v1/insights/participant HTTP/1.1
Host: api.whereby.dev
Accept: */*
[
{
"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": {}
}
]