# Sessions ## Fetch all sessions of an App `client.realtimeKit.sessions.getSessions(stringappID, SessionGetSessionsParamsparams, RequestOptionsoptions?): SessionGetSessionsResponse` **get** `/accounts/{account_id}/realtime/kit/{app_id}/sessions` Returns details of all sessions of an App. ### Parameters - `appID: string` The app identifier tag. - `params: SessionGetSessionsParams` - `account_id: string` Path param: The account identifier tag. - `associated_id?: string` Query param: ID of the meeting that sessions should be associated with - `end_time?: string` Query param: The end time range for which you want to retrieve the meetings. The time must be specified in ISO format. - `page_no?: number` Query param: The page number from which you want your page search results to be displayed. - `participants?: string` Query param - `per_page?: number` Query param: Number of results per page - `search?: string` Query param: Search string that matches sessions based on meeting title, meeting ID, and session ID - `sort_by?: "minutesConsumed" | "createdAt"` Query param - `"minutesConsumed"` - `"createdAt"` - `sort_order?: "ASC" | "DESC"` Query param - `"ASC"` - `"DESC"` - `start_time?: string` Query param: The start time range for which you want to retrieve the meetings. The time must be specified in ISO format. - `status?: "LIVE" | "ENDED"` Query param - `"LIVE"` - `"ENDED"` ### Returns - `SessionGetSessionsResponse` - `data?: Data` - `sessions?: Array` - `id: string` ID of the session - `associated_id: string` ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form `abcdef-ghijkl` - `created_at: string` timestamp when session created - `live_participants: number` number of participants currently in the session - `max_concurrent_participants: number` number of maximum participants that were in the session - `meeting_display_name: string` Title of the meeting this session belongs to - `minutes_consumed: number` number of minutes consumed since the session started - `organization_id: string` App id that hosted this session - `started_at: string` timestamp when session started - `status: "LIVE" | "ENDED"` current status of session - `"LIVE"` - `"ENDED"` - `type: "meeting" | "livestream" | "participant"` type of session - `"meeting"` - `"livestream"` - `"participant"` - `updated_at: string` timestamp when session was last updated - `breakout_rooms?: Array` - `ended_at?: string` timestamp when session ended - `paging?: Paging` - `end_offset?: number` - `start_offset?: number` - `total_count?: number` - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.getSessions('app_id', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(response.data); ``` #### Response ```json { "data": { "sessions": [ { "id": "id", "associated_id": "associated_id", "created_at": "created_at", "live_participants": 0, "max_concurrent_participants": 0, "meeting_display_name": "meeting_display_name", "minutes_consumed": 0, "organization_id": "organization_id", "started_at": "started_at", "status": "LIVE", "type": "meeting", "updated_at": "updated_at", "breakout_rooms": [ {} ], "ended_at": "ended_at" } ] }, "paging": { "end_offset": 0, "start_offset": 0, "total_count": 0 }, "success": true } ``` ## Fetch details of a session `client.realtimeKit.sessions.getSessionDetails(stringsessionID, SessionGetSessionDetailsParamsparams, RequestOptionsoptions?): SessionGetSessionDetailsResponse` **get** `/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}` Returns data of the given session ID including recording details. ### Parameters - `sessionID: string` - `params: SessionGetSessionDetailsParams` - `account_id: string` Path param: The account identifier tag. - `app_id: string` Path param: The app identifier tag. - `include_breakout_rooms?: boolean` Query param: List all breakout rooms ### Returns - `SessionGetSessionDetailsResponse` - `data?: Data` - `id: string` ID of the session - `associated_id: string` ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form `abcdef-ghijkl` - `created_at: string` timestamp when session created - `live_participants: number` number of participants currently in the session - `max_concurrent_participants: number` number of maximum participants that were in the session - `meeting_display_name: string` Title of the meeting this session belongs to - `minutes_consumed: number` number of minutes consumed since the session started - `organization_id: string` App id that hosted this session - `started_at: string` timestamp when session started - `status: "LIVE" | "ENDED"` current status of session - `"LIVE"` - `"ENDED"` - `type: "meeting" | "livestream" | "participant"` type of session - `"meeting"` - `"livestream"` - `"participant"` - `updated_at: string` timestamp when session was last updated - `breakout_rooms?: Array` - `ended_at?: string` timestamp when session ended - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.getSessionDetails( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', app_id: 'app_id' }, ); console.log(response.data); ``` #### Response ```json { "data": { "id": "id", "associated_id": "associated_id", "created_at": "created_at", "live_participants": 0, "max_concurrent_participants": 0, "meeting_display_name": "meeting_display_name", "minutes_consumed": 0, "organization_id": "organization_id", "started_at": "started_at", "status": "LIVE", "type": "meeting", "updated_at": "updated_at", "breakout_rooms": [ {} ], "ended_at": "ended_at" }, "success": true } ``` ## Fetch participants list of a session `client.realtimeKit.sessions.getSessionParticipants(stringsessionID, SessionGetSessionParticipantsParamsparams, RequestOptionsoptions?): SessionGetSessionParticipantsResponse` **get** `/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants` Returns a list of participants for the given session ID. ### Parameters - `sessionID: string` - `params: SessionGetSessionParticipantsParams` - `account_id: string` Path param: The account identifier tag. - `app_id: string` Path param: The app identifier tag. - `include_peer_events?: boolean` Query param: if true, response includes all the peer events of participants. - `page_no?: number` Query param: The page number from which you want your page search results to be displayed. - `per_page?: number` Query param: Number of results per page - `search?: string` Query param: The search query string. You can search using participant ID, custom participant ID, or display name. - `sort_by?: "joinedAt" | "duration"` Query param - `"joinedAt"` - `"duration"` - `sort_order?: "ASC" | "DESC"` Query param - `"ASC"` - `"DESC"` - `view?: "raw" | "consolidated"` Query param: In breakout room sessions, the view parameter can be set to `raw` for session specific duration for participants or `consolidated` to accumulate breakout room durations. - `"raw"` - `"consolidated"` ### Returns - `SessionGetSessionParticipantsResponse` - `data?: Data` - `participants?: Array` - `id?: string` Participant ID. This maps to the corresponding peerId. - `created_at?: string` timestamp when this participant was created. - `custom_participant_id?: string` ID passed by client to create this participant. - `display_name?: string` Display name of participant when joining the session. - `duration?: number` number of minutes for which the participant was in the session. - `joined_at?: string` timestamp at which participant joined the session. - `left_at?: string` timestamp at which participant left the session. - `peer_events?: Array` Connection lifecycle events for the participant's peer. Only included when `include_peer_events` is true. - `id?: string` ID of the peer event. - `created_at?: string` Timestamp when this peer event was created. - `event_name?: "PEER_CREATED" | "PEER_JOINING" | "PEER_LEAVING"` Name of the peer event. - `"PEER_CREATED"` - `"PEER_JOINING"` - `"PEER_LEAVING"` - `minutes_consumed?: number` Minutes consumed attributed to this event. - `participant_id?: string | null` ID of the participant this event belongs to. - `peer_id?: string` Peer ID this event belongs to. - `preset_view_type?: "GROUP_CALL" | "WEBINAR" | "AUDIO_ROOM" | 2 more | null` View type of the preset associated with the peer. - `"GROUP_CALL"` - `"WEBINAR"` - `"AUDIO_ROOM"` - `"LIVESTREAM"` - `"CHAT"` - `session_id?: string | null` ID of the session this event belongs to. - `socket_session_id?: string | null` ID of the socket session associated with this event. - `updated_at?: string` Timestamp when this peer event was last updated. - `preset_name?: string` Name of the preset associated with the participant. - `updated_at?: string` timestamp when this participant's data was last updated. - `user_id?: string` User id for this participant. - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.getSessionParticipants( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', app_id: 'app_id' }, ); console.log(response.data); ``` #### Response ```json { "data": { "paging": { "end_offset": 2, "start_offset": 1, "total_count": 123 }, "participants": [ { "created_at": "2023-02-01T10:51:08.039Z", "custom_participant_id": "83qi0i", "display_name": "Mark", "duration": 5.8097, "id": "005f4e0c-4d08-4d4e-a391-a76be75cd296", "joined_at": "2023-02-01T10:51:08.030Z", "left_at": "2023-02-01T10:56:56.612Z", "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:56:56.618Z", "user_id": "0a08343d-a9dc-45f0-9feb-6a64afcc4f81" }, { "created_at": "2023-02-01T10:50:36.853Z", "custom_participant_id": "3uggr", "display_name": "Henry", "duration": 6.9263, "id": "51fdf95f-d893-471a-922b-7db7adb14453", "joined_at": "2023-02-01T10:50:36.846Z\"", "left_at": "2023-02-01T10:57:32.424Z", "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:57:32.431Z", "user_id": "85e7f0fd-7c16-45e9-9d68-f17ef007c4eb" } ] }, "success": true } ``` ## Fetch details of a participant `client.realtimeKit.sessions.getSessionParticipantDetails(stringparticipantID, SessionGetSessionParticipantDetailsParamsparams, RequestOptionsoptions?): SessionGetSessionParticipantDetailsResponse` **get** `/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}` Returns details of the given participant ID along with call statistics for the given session ID. ### Parameters - `participantID: string` - `params: SessionGetSessionParticipantDetailsParams` - `account_id: string` Path param: The account identifier tag. - `app_id: string` Path param: The app identifier tag. - `session_id: string` Path param: ID of the session - `include_peer_events?: boolean` Query param: if true, response includes all the peer events of participant. ### Returns - `SessionGetSessionParticipantDetailsResponse` - `data?: Data` - `participant?: Participant` - `id?: string` Participant ID. This maps to the corresponding peerId. - `created_at?: string` timestamp when this participant was created. - `custom_participant_id?: string` ID passed by client to create this participant. - `display_name?: string` Display name of participant when joining the session. - `duration?: number` number of minutes for which the participant was in the session. - `joined_at?: string` timestamp at which participant joined the session. - `left_at?: string` timestamp at which participant left the session. - `peer_events?: Array` Connection lifecycle events for the participant's peer. Only included when `include_peer_events` is true. - `id?: string` ID of the peer event. - `created_at?: string` Timestamp when this peer event was created. - `event_name?: "PEER_CREATED" | "PEER_JOINING" | "PEER_LEAVING"` Name of the peer event. - `"PEER_CREATED"` - `"PEER_JOINING"` - `"PEER_LEAVING"` - `minutes_consumed?: number` Minutes consumed attributed to this event. - `participant_id?: string | null` ID of the participant this event belongs to. - `peer_id?: string` Peer ID this event belongs to. - `preset_view_type?: "GROUP_CALL" | "WEBINAR" | "AUDIO_ROOM" | 2 more | null` View type of the preset associated with the peer. - `"GROUP_CALL"` - `"WEBINAR"` - `"AUDIO_ROOM"` - `"LIVESTREAM"` - `"CHAT"` - `session_id?: string | null` ID of the session this event belongs to. - `socket_session_id?: string | null` ID of the socket session associated with this event. - `updated_at?: string` Timestamp when this peer event was last updated. - `preset_name?: string` Name of the preset associated with the participant. - `updated_at?: string` timestamp when this participant's data was last updated. - `user_id?: string` User id for this participant. - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.getSessionParticipantDetails( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', app_id: 'app_id', session_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', }, ); console.log(response.data); ``` #### Response ```json { "data": { "participant": { "id": "id", "created_at": "created_at", "custom_participant_id": "custom_participant_id", "display_name": "display_name", "duration": 0, "joined_at": "joined_at", "left_at": "left_at", "peer_events": [ { "id": "id", "created_at": "created_at", "event_name": "PEER_CREATED", "minutes_consumed": 0, "participant_id": "participant_id", "peer_id": "peer_id", "preset_view_type": "GROUP_CALL", "session_id": "session_id", "socket_session_id": "socket_session_id", "updated_at": "updated_at" } ], "preset_name": "preset_name", "updated_at": "updated_at", "user_id": "user_id" } }, "success": true } ``` ## Fetch all chat messages of a session `client.realtimeKit.sessions.getSessionChat(stringsessionID, SessionGetSessionChatParamsparams, RequestOptionsoptions?): SessionGetSessionChatResponse` **get** `/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat` Returns a URL to download all chat messages of the session ID in CSV format. ### Parameters - `sessionID: string` - `params: SessionGetSessionChatParams` - `account_id: string` The account identifier tag. - `app_id: string` The app identifier tag. ### Returns - `SessionGetSessionChatResponse` - `data?: Data` - `chat_download_url: string` URL where the chat logs can be downloaded - `chat_download_url_expiry: string` Time when the download URL will expire - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.getSessionChat( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', app_id: 'app_id' }, ); console.log(response.data); ``` #### Response ```json { "data": { "chat_download_url": "chat_download_url", "chat_download_url_expiry": "chat_download_url_expiry" }, "success": true } ``` ## Fetch the complete transcript for a session `client.realtimeKit.sessions.getSessionTranscripts(stringsessionID, SessionGetSessionTranscriptsParamsparams, RequestOptionsoptions?): SessionGetSessionTranscriptsResponse` **get** `/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript` Returns a URL to download the transcript for the session ID in CSV format. ### Parameters - `sessionID: string` - `params: SessionGetSessionTranscriptsParams` - `account_id: string` Path param: The account identifier tag. - `app_id: string` Path param: The app identifier tag. - `format?: "SRT" | "VTT" | "JSON" | "CSV"` Query param: Transcript file format to fetch. - `"SRT"` - `"VTT"` - `"JSON"` - `"CSV"` ### Returns - `SessionGetSessionTranscriptsResponse` - `data?: Data` - `sessionId: string` - `transcript_download_url: string` URL where the transcript can be downloaded - `transcript_download_url_expiry: string` Time when the download URL will expire - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.getSessionTranscripts( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', app_id: 'app_id' }, ); console.log(response.data); ``` #### Response ```json { "data": { "sessionId": "sessionId", "transcript_download_url": "transcript_download_url", "transcript_download_url_expiry": "transcript_download_url_expiry" }, "success": true } ``` ## Fetch summary of transcripts for a session `client.realtimeKit.sessions.getSessionSummary(stringsessionID, SessionGetSessionSummaryParamsparams, RequestOptionsoptions?): SessionGetSessionSummaryResponse` **get** `/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary` Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text. ### Parameters - `sessionID: string` - `params: SessionGetSessionSummaryParams` - `account_id: string` The account identifier tag. - `app_id: string` The app identifier tag. ### Returns - `SessionGetSessionSummaryResponse` - `data?: Data` - `sessionId: string` - `summaryDownloadUrl: string` URL where the summary of transcripts can be downloaded - `summaryDownloadUrlExpiry: string` Time of Expiry before when you need to download the csv file. - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.getSessionSummary( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', app_id: 'app_id' }, ); console.log(response.data); ``` #### Response ```json { "data": { "sessionId": "sessionId", "summaryDownloadUrl": "summaryDownloadUrl", "summaryDownloadUrlExpiry": "summaryDownloadUrlExpiry" }, "success": true } ``` ## Generate summary of Transcripts for the session `client.realtimeKit.sessions.generateSummaryOfTranscripts(stringsessionID, SessionGenerateSummaryOfTranscriptsParamsparams, RequestOptionsoptions?): SessionGenerateSummaryOfTranscriptsResponse` **post** `/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary` Trigger Summary generation of Transcripts for the session ID. ### Parameters - `sessionID: string` - `params: SessionGenerateSummaryOfTranscriptsParams` - `account_id: string` The account identifier tag. - `app_id: string` The app identifier tag. ### Returns - `SessionGenerateSummaryOfTranscriptsResponse` - `data?: Data` - `session_id?: string` - `status?: string` - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.generateSummaryOfTranscripts( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', app_id: 'app_id' }, ); console.log(response.data); ``` #### Response ```json { "data": { "session_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "status": "status" }, "success": true } ``` ## Fetch details of peer `client.realtimeKit.sessions.getParticipantDataFromPeerID(stringpeerID, SessionGetParticipantDataFromPeerIDParamsparams, RequestOptionsoptions?): SessionGetParticipantDataFromPeerIDResponse` **get** `/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}` Returns participant details for the given peer ID along with call statistics. ### Parameters - `peerID: string` - `params: SessionGetParticipantDataFromPeerIDParams` - `account_id: string` Path param: The account identifier tag. - `app_id: string` Path param: The app identifier tag. - `filters?: "device_info" | "ip_information" | "precall_network_information" | 2 more` Query param: Filter to apply to the peer report. - `"device_info"` - `"ip_information"` - `"precall_network_information"` - `"events"` - `"quality_stats"` - `include_peer_events?: boolean` Query param: if true, response includes all the peer events of participant. ### Returns - `SessionGetParticipantDataFromPeerIDResponse` - `data?: Data` - `participant?: Participant` - `id?: string` ID of the participant. - `created_at?: string` timestamp when this participant was created. - `custom_participant_id?: string` ID passed by client to create this participant. - `display_name?: string` Display name of participant when joining the session. - `duration?: number` number of minutes for which the participant was in the session. - `joined_at?: string` timestamp at which participant joined the session. - `left_at?: string` timestamp at which participant left the session. - `peer_events?: Array` Connection lifecycle events for the participant's peer. - `id?: string` ID of the peer event. - `created_at?: string` Timestamp when this peer event was created. - `event_name?: "PEER_CREATED" | "PEER_JOINING" | "PEER_LEAVING"` Name of the peer event. - `"PEER_CREATED"` - `"PEER_JOINING"` - `"PEER_LEAVING"` - `minutes_consumed?: number` Minutes consumed attributed to this event. - `participant_id?: string | null` ID of the participant this event belongs to. - `peer_id?: string` Peer ID this event belongs to. - `preset_view_type?: "GROUP_CALL" | "WEBINAR" | "AUDIO_ROOM" | 2 more | null` View type of the preset associated with the peer. - `"GROUP_CALL"` - `"WEBINAR"` - `"AUDIO_ROOM"` - `"LIVESTREAM"` - `"CHAT"` - `session_id?: string | null` ID of the session this event belongs to. - `socket_session_id?: string | null` ID of the socket session associated with this event. - `updated_at?: string` Timestamp when this peer event was last updated. - `peer_report?: PeerReport` Peer call statistics report. - `metadata?: Metadata` Connection and device metadata for the participant. - `audio_devices_updates?: Array` - `added?: Array` Devices that became available. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `removed?: Array` Devices that became unavailable. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `timestamp?: string` Timestamp of the device update. - `browser_metadata?: BrowserMetadata` - `browser?: string` - `browser_version?: string` - `engine?: string` - `user_agent?: string` - `webgl_support?: boolean | null` - `candidate_pairs?: CandidatePairs` - `consuming_transport?: Array` - `available_incoming_bitrate?: number` - `available_outgoing_bitrate?: number` - `bytes_discarded_on_send?: number` - `bytes_received?: number` - `bytes_sent?: number` - `current_round_trip_time?: number` - `last_packet_received_timestamp?: number` Epoch milliseconds when the last packet was received. - `last_packet_sent_timestamp?: number` Epoch milliseconds when the last packet was sent. - `local_candidate_address?: string` - `local_candidate_id?: string` - `local_candidate_network_type?: string` - `local_candidate_port?: number` - `local_candidate_protocol?: string` - `local_candidate_related_address?: string` - `local_candidate_related_port?: number` - `local_candidate_type?: string` - `local_candidate_url?: string` - `nominated?: boolean` - `packets_discarded_on_send?: number` - `packets_received?: number` - `packets_sent?: number` - `remote_candidate_address?: string` - `remote_candidate_id?: string` - `remote_candidate_port?: number` - `remote_candidate_protocol?: string` - `remote_candidate_type?: string` - `remote_candidate_url?: string` - `total_round_trip_time?: number` - `producing_transport?: Array` - `available_incoming_bitrate?: number` - `available_outgoing_bitrate?: number` - `bytes_discarded_on_send?: number` - `bytes_received?: number` - `bytes_sent?: number` - `current_round_trip_time?: number` - `last_packet_received_timestamp?: number` Epoch milliseconds when the last packet was received. - `last_packet_sent_timestamp?: number` Epoch milliseconds when the last packet was sent. - `local_candidate_address?: string` - `local_candidate_id?: string` - `local_candidate_network_type?: string` - `local_candidate_port?: number` - `local_candidate_protocol?: string` - `local_candidate_related_address?: string` - `local_candidate_related_port?: number` - `local_candidate_type?: string` - `local_candidate_url?: string` - `nominated?: boolean` - `packets_discarded_on_send?: number` - `packets_received?: number` - `packets_sent?: number` - `remote_candidate_address?: string` - `remote_candidate_id?: string` - `remote_candidate_port?: number` - `remote_candidate_protocol?: string` - `remote_candidate_type?: string` - `remote_candidate_url?: string` - `total_round_trip_time?: number` - `device_info?: DeviceInfo` - `cpus?: number` - `is_mobile?: boolean` - `os?: string` - `os_version?: string` - `events?: Array` - `metadata?: Record` Event-specific metadata. Keys vary per event; values are primitive scalars (string, number, boolean, or null). - `string` - `number` - `boolean` - `name?: string` Name of the event. - `timestamp?: string` Timestamp when the event occurred. - `ip_information?: IPInformation` - `asn?: ASN` - `asn?: string` - `domain?: string` - `name?: string` - `route?: string` - `type?: string` - `city?: string` - `country?: string` - `ipv4?: string` - `org?: string` - `region?: string` - `timezone?: string` - `native_metadata?: NativeMetadata` - `audio_encoder?: string` - `video_encoder?: string` - `pc_metadata?: Array` - `effective_network_type?: string` - `reflexive_connectivity?: boolean` - `relay_connectivity?: boolean` - `sdp?: Array` - `timestamp?: string` - `turn_connectivity?: boolean` - `room_view_type?: string` - `sdk_name?: string` - `sdk_type?: string` - `sdk_version?: string` - `selected_device_updates?: Array` - `device?: Device` A media device (camera, microphone, or speaker). - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `timestamp?: string` - `speaker_devices_updates?: Array` - `added?: Array` Devices that became available. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `removed?: Array` Devices that became unavailable. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `timestamp?: string` Timestamp of the device update. - `video_devices_updates?: Array` - `added?: Array` Devices that became available. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `removed?: Array` Devices that became unavailable. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `timestamp?: string` Timestamp of the device update. - `quality?: Quality` Media quality statistics for the participant. - `audio_consumer?: Array` - `bytes_received?: number` - `concealment_events?: number` - `consumer_id?: string` - `jitter?: number` - `jitter_buffer_delay?: number` - `jitter_buffer_emitted_count?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_received?: number` - `peer_id?: string` - `producer_id?: string` - `ssrc?: number` - `timestamp?: string` - `audio_consumer_cumulative?: AudioConsumerCumulative` Aggregated inbound (consumer) audio statistics for the session. - `jitter_buffer_delay?: JitterBufferDelay` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `audio_producer?: Array` - `bytes_sent?: number` - `jitter?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_sent?: number` - `producer_id?: string` - `rtt?: number` - `ssrc?: number` - `timestamp?: string` - `audio_producer_cumulative?: AudioProducerCumulative` Aggregated outbound (producer) audio statistics for the session. - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `rtt?: RTT` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `screenshare_audio_consumer?: Array` - `bytes_received?: number` - `concealment_events?: number` - `consumer_id?: string` - `jitter?: number` - `jitter_buffer_delay?: number` - `jitter_buffer_emitted_count?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_received?: number` - `peer_id?: string` - `producer_id?: string` - `ssrc?: number` - `timestamp?: string` - `screenshare_audio_consumer_cumulative?: ScreenshareAudioConsumerCumulative` Aggregated inbound (consumer) audio statistics for the session. - `jitter_buffer_delay?: JitterBufferDelay` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `screenshare_audio_producer?: Array` - `bytes_sent?: number` - `jitter?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_sent?: number` - `producer_id?: string` - `rtt?: number` - `ssrc?: number` - `timestamp?: string` - `screenshare_audio_producer_cumulative?: ScreenshareAudioProducerCumulative` Aggregated outbound (producer) audio statistics for the session. - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `rtt?: RTT` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `screenshare_video_consumer?: Array` - `bytes_received?: number` - `consumer_id?: string` - `fir_count?: number` - `frame_height?: number` - `frame_width?: number` - `frames_decoded?: number` - `frames_dropped?: number` - `frames_per_second?: number` - `jitter?: number` - `jitter_buffer_delay?: number` - `jitter_buffer_emitted_count?: number` - `key_frames_decoded?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_received?: number` - `peer_id?: string` - `producer_id?: string` - `ssrc?: number` - `timestamp?: string` - `screenshare_video_consumer_cumulative?: ScreenshareVideoConsumerCumulative` Aggregated inbound (consumer) video statistics for the session. - `frame_per_second?: FramePerSecond` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `frame_width?: FrameWidth` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `issues?: Issues` - `lag_fraction?: number` - `no_video_fraction?: number` - `poor_resolution_fraction?: number` - `jitter_buffer_delay?: JitterBufferDelay` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `key_frames_decoded_fraction?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `screenshare_video_producer?: Array` - `bytes_sent?: number` - `fir_count?: number` - `frame_height?: number` - `frame_width?: number` - `frames_encoded?: number` - `frames_per_second?: number` - `jitter?: number` - `key_frames_encoded?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_sent?: number` - `pli_count?: number` - `producer_id?: string` - `quality_limitation_durations?: QualityLimitationDurations` - `bandwidth?: number` - `cpu?: number` - `none?: number` - `other?: number` - `quality_limitation_reason?: "cpu" | "bandwidth" | "none" | "other"` - `"cpu"` - `"bandwidth"` - `"none"` - `"other"` - `quality_limitation_resolution_changes?: number` - `rtt?: number` - `ssrc?: number` - `timestamp?: string` - `screenshare_video_producer_cumulative?: ScreenshareVideoProducerCumulative` Aggregated outbound (producer) video statistics for the session. - `frame_per_second?: FramePerSecond` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `frame_width?: FrameWidth` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `high_negative_feedback_fraction?: number` - `issues?: Issues` - `bandwidth_quality_limitation_fraction?: number` - `cpu_quality_limitation_fraction?: number` - `no_video_fraction?: number` - `poor_resolution_fraction?: number` - `quality_limitation_fraction?: number` - `key_frames_encoded_fraction?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `rtt?: RTT` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `video_consumer?: Array` - `bytes_received?: number` - `consumer_id?: string` - `fir_count?: number` - `frame_height?: number` - `frame_width?: number` - `frames_decoded?: number` - `frames_dropped?: number` - `frames_per_second?: number` - `jitter?: number` - `jitter_buffer_delay?: number` - `jitter_buffer_emitted_count?: number` - `key_frames_decoded?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_received?: number` - `peer_id?: string` - `producer_id?: string` - `ssrc?: number` - `timestamp?: string` - `video_consumer_cumulative?: VideoConsumerCumulative` Aggregated inbound (consumer) video statistics for the session. - `frame_per_second?: FramePerSecond` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `frame_width?: FrameWidth` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `issues?: Issues` - `lag_fraction?: number` - `no_video_fraction?: number` - `poor_resolution_fraction?: number` - `jitter_buffer_delay?: JitterBufferDelay` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `key_frames_decoded_fraction?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `video_producer?: Array` - `bytes_sent?: number` - `fir_count?: number` - `frame_height?: number` - `frame_width?: number` - `frames_encoded?: number` - `frames_per_second?: number` - `jitter?: number` - `key_frames_encoded?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_sent?: number` - `pli_count?: number` - `producer_id?: string` - `quality_limitation_durations?: QualityLimitationDurations` - `bandwidth?: number` - `cpu?: number` - `none?: number` - `other?: number` - `quality_limitation_reason?: "cpu" | "bandwidth" | "none" | "other"` - `"cpu"` - `"bandwidth"` - `"none"` - `"other"` - `quality_limitation_resolution_changes?: number` - `rtt?: number` - `ssrc?: number` - `timestamp?: string` - `video_producer_cumulative?: VideoProducerCumulative` Aggregated outbound (producer) video statistics for the session. - `frame_per_second?: FramePerSecond` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `frame_width?: FrameWidth` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `high_negative_feedback_fraction?: number` - `issues?: Issues` - `bandwidth_quality_limitation_fraction?: number` - `cpu_quality_limitation_fraction?: number` - `no_video_fraction?: number` - `poor_resolution_fraction?: number` - `quality_limitation_fraction?: number` - `key_frames_encoded_fraction?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `rtt?: RTT` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `role?: string` Name of the preset associated with the participant. - `session_id?: string` - `updated_at?: string` timestamp when this participant's data was last updated. - `user_id?: string` User id for this participant. - `success?: boolean` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.sessions.getParticipantDataFromPeerID( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', app_id: 'app_id' }, ); console.log(response.data); ``` #### Response ```json { "data": { "participant": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_at": "created_at", "custom_participant_id": "custom_participant_id", "display_name": "display_name", "duration": 0, "joined_at": "joined_at", "left_at": "left_at", "peer_events": [ { "id": "id", "created_at": "created_at", "event_name": "PEER_CREATED", "minutes_consumed": 0, "participant_id": "participant_id", "peer_id": "peer_id", "preset_view_type": "GROUP_CALL", "session_id": "session_id", "socket_session_id": "socket_session_id", "updated_at": "updated_at" } ], "peer_report": { "metadata": { "audio_devices_updates": [ { "added": [ { "device_id": "device_id", "kind": "kind", "label": "label" } ], "removed": [ { "device_id": "device_id", "kind": "kind", "label": "label" } ], "timestamp": "timestamp" } ], "browser_metadata": { "browser": "browser", "browser_version": "browser_version", "engine": "engine", "user_agent": "user_agent", "webgl_support": true }, "candidate_pairs": { "consuming_transport": [ { "available_incoming_bitrate": 0, "available_outgoing_bitrate": 0, "bytes_discarded_on_send": 0, "bytes_received": 0, "bytes_sent": 0, "current_round_trip_time": 0, "last_packet_received_timestamp": 0, "last_packet_sent_timestamp": 0, "local_candidate_address": "local_candidate_address", "local_candidate_id": "local_candidate_id", "local_candidate_network_type": "local_candidate_network_type", "local_candidate_port": 0, "local_candidate_protocol": "local_candidate_protocol", "local_candidate_related_address": "local_candidate_related_address", "local_candidate_related_port": 0, "local_candidate_type": "local_candidate_type", "local_candidate_url": "local_candidate_url", "nominated": true, "packets_discarded_on_send": 0, "packets_received": 0, "packets_sent": 0, "remote_candidate_address": "remote_candidate_address", "remote_candidate_id": "remote_candidate_id", "remote_candidate_port": 0, "remote_candidate_protocol": "remote_candidate_protocol", "remote_candidate_type": "remote_candidate_type", "remote_candidate_url": "remote_candidate_url", "total_round_trip_time": 0 } ], "producing_transport": [ { "available_incoming_bitrate": 0, "available_outgoing_bitrate": 0, "bytes_discarded_on_send": 0, "bytes_received": 0, "bytes_sent": 0, "current_round_trip_time": 0, "last_packet_received_timestamp": 0, "last_packet_sent_timestamp": 0, "local_candidate_address": "local_candidate_address", "local_candidate_id": "local_candidate_id", "local_candidate_network_type": "local_candidate_network_type", "local_candidate_port": 0, "local_candidate_protocol": "local_candidate_protocol", "local_candidate_related_address": "local_candidate_related_address", "local_candidate_related_port": 0, "local_candidate_type": "local_candidate_type", "local_candidate_url": "local_candidate_url", "nominated": true, "packets_discarded_on_send": 0, "packets_received": 0, "packets_sent": 0, "remote_candidate_address": "remote_candidate_address", "remote_candidate_id": "remote_candidate_id", "remote_candidate_port": 0, "remote_candidate_protocol": "remote_candidate_protocol", "remote_candidate_type": "remote_candidate_type", "remote_candidate_url": "remote_candidate_url", "total_round_trip_time": 0 } ] }, "device_info": { "cpus": 0, "is_mobile": true, "os": "os", "os_version": "os_version" }, "events": [ { "metadata": { "foo": "string" }, "name": "name", "timestamp": "timestamp" } ], "ip_information": { "asn": { "asn": "asn", "domain": "domain", "name": "name", "route": "route", "type": "type" }, "city": "city", "country": "country", "ipv4": "ipv4", "org": "org", "region": "region", "timezone": "timezone" }, "native_metadata": { "audio_encoder": "audio_encoder", "video_encoder": "video_encoder" }, "pc_metadata": [ { "effective_network_type": "effective_network_type", "reflexive_connectivity": true, "relay_connectivity": true, "sdp": [ "string" ], "timestamp": "timestamp", "turn_connectivity": true } ], "room_view_type": "room_view_type", "sdk_name": "sdk_name", "sdk_type": "sdk_type", "sdk_version": "sdk_version", "selected_device_updates": [ { "device": { "device_id": "device_id", "kind": "kind", "label": "label" }, "timestamp": "timestamp" } ], "speaker_devices_updates": [ { "added": [ { "device_id": "device_id", "kind": "kind", "label": "label" } ], "removed": [ { "device_id": "device_id", "kind": "kind", "label": "label" } ], "timestamp": "timestamp" } ], "video_devices_updates": [ { "added": [ { "device_id": "device_id", "kind": "kind", "label": "label" } ], "removed": [ { "device_id": "device_id", "kind": "kind", "label": "label" } ], "timestamp": "timestamp" } ] }, "quality": { "audio_consumer": [ { "bytes_received": 0, "concealment_events": 0, "consumer_id": "consumer_id", "jitter": 0, "jitter_buffer_delay": 0, "jitter_buffer_emitted_count": 0, "mid": "mid", "mos_quality": 0, "packets_lost": 0, "packets_received": 0, "peer_id": "peer_id", "producer_id": "producer_id", "ssrc": 0, "timestamp": "timestamp" } ], "audio_consumer_cumulative": { "jitter_buffer_delay": { "100ms_or_greater_event_fraction": 0, "250ms_or_greater_event_fraction": 0, "500ms_or_greater_event_fraction": 0, "avg": 0 }, "packet_loss": { "10_or_greater_event_fraction": 0, "25_or_greater_event_fraction": 0, "5_or_greater_event_fraction": 0, "50_or_greater_event_fraction": 0, "avg": 0 }, "quality_mos": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 } }, "audio_producer": [ { "bytes_sent": 0, "jitter": 0, "mid": "mid", "mos_quality": 0, "packets_lost": 0, "packets_sent": 0, "producer_id": "producer_id", "rtt": 0, "ssrc": 0, "timestamp": "timestamp" } ], "audio_producer_cumulative": { "packet_loss": { "10_or_greater_event_fraction": 0, "25_or_greater_event_fraction": 0, "5_or_greater_event_fraction": 0, "50_or_greater_event_fraction": 0, "avg": 0 }, "quality_mos": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "rtt": { "100ms_or_greater_event_fraction": 0, "250ms_or_greater_event_fraction": 0, "500ms_or_greater_event_fraction": 0, "avg": 0 } }, "screenshare_audio_consumer": [ { "bytes_received": 0, "concealment_events": 0, "consumer_id": "consumer_id", "jitter": 0, "jitter_buffer_delay": 0, "jitter_buffer_emitted_count": 0, "mid": "mid", "mos_quality": 0, "packets_lost": 0, "packets_received": 0, "peer_id": "peer_id", "producer_id": "producer_id", "ssrc": 0, "timestamp": "timestamp" } ], "screenshare_audio_consumer_cumulative": { "jitter_buffer_delay": { "100ms_or_greater_event_fraction": 0, "250ms_or_greater_event_fraction": 0, "500ms_or_greater_event_fraction": 0, "avg": 0 }, "packet_loss": { "10_or_greater_event_fraction": 0, "25_or_greater_event_fraction": 0, "5_or_greater_event_fraction": 0, "50_or_greater_event_fraction": 0, "avg": 0 }, "quality_mos": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 } }, "screenshare_audio_producer": [ { "bytes_sent": 0, "jitter": 0, "mid": "mid", "mos_quality": 0, "packets_lost": 0, "packets_sent": 0, "producer_id": "producer_id", "rtt": 0, "ssrc": 0, "timestamp": "timestamp" } ], "screenshare_audio_producer_cumulative": { "packet_loss": { "10_or_greater_event_fraction": 0, "25_or_greater_event_fraction": 0, "5_or_greater_event_fraction": 0, "50_or_greater_event_fraction": 0, "avg": 0 }, "quality_mos": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "rtt": { "100ms_or_greater_event_fraction": 0, "250ms_or_greater_event_fraction": 0, "500ms_or_greater_event_fraction": 0, "avg": 0 } }, "screenshare_video_consumer": [ { "bytes_received": 0, "consumer_id": "consumer_id", "fir_count": 0, "frame_height": 0, "frame_width": 0, "frames_decoded": 0, "frames_dropped": 0, "frames_per_second": 0, "jitter": 0, "jitter_buffer_delay": 0, "jitter_buffer_emitted_count": 0, "key_frames_decoded": 0, "mid": "mid", "mos_quality": 0, "packets_lost": 0, "packets_received": 0, "peer_id": "peer_id", "producer_id": "producer_id", "ssrc": 0, "timestamp": "timestamp" } ], "screenshare_video_consumer_cumulative": { "frame_per_second": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "frame_width": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "issues": { "lag_fraction": 0, "no_video_fraction": 0, "poor_resolution_fraction": 0 }, "jitter_buffer_delay": { "100ms_or_greater_event_fraction": 0, "250ms_or_greater_event_fraction": 0, "500ms_or_greater_event_fraction": 0, "avg": 0 }, "key_frames_decoded_fraction": 0, "packet_loss": { "10_or_greater_event_fraction": 0, "25_or_greater_event_fraction": 0, "5_or_greater_event_fraction": 0, "50_or_greater_event_fraction": 0, "avg": 0 }, "quality_mos": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 } }, "screenshare_video_producer": [ { "bytes_sent": 0, "fir_count": 0, "frame_height": 0, "frame_width": 0, "frames_encoded": 0, "frames_per_second": 0, "jitter": 0, "key_frames_encoded": 0, "mid": "mid", "mos_quality": 0, "packets_lost": 0, "packets_sent": 0, "pli_count": 0, "producer_id": "producer_id", "quality_limitation_durations": { "bandwidth": 0, "cpu": 0, "none": 0, "other": 0 }, "quality_limitation_reason": "cpu", "quality_limitation_resolution_changes": 0, "rtt": 0, "ssrc": 0, "timestamp": "timestamp" } ], "screenshare_video_producer_cumulative": { "frame_per_second": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "frame_width": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "high_negative_feedback_fraction": 0, "issues": { "bandwidth_quality_limitation_fraction": 0, "cpu_quality_limitation_fraction": 0, "no_video_fraction": 0, "poor_resolution_fraction": 0, "quality_limitation_fraction": 0 }, "key_frames_encoded_fraction": 0, "packet_loss": { "10_or_greater_event_fraction": 0, "25_or_greater_event_fraction": 0, "5_or_greater_event_fraction": 0, "50_or_greater_event_fraction": 0, "avg": 0 }, "quality_mos": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "rtt": { "100ms_or_greater_event_fraction": 0, "250ms_or_greater_event_fraction": 0, "500ms_or_greater_event_fraction": 0, "avg": 0 } }, "video_consumer": [ { "bytes_received": 0, "consumer_id": "consumer_id", "fir_count": 0, "frame_height": 0, "frame_width": 0, "frames_decoded": 0, "frames_dropped": 0, "frames_per_second": 0, "jitter": 0, "jitter_buffer_delay": 0, "jitter_buffer_emitted_count": 0, "key_frames_decoded": 0, "mid": "mid", "mos_quality": 0, "packets_lost": 0, "packets_received": 0, "peer_id": "peer_id", "producer_id": "producer_id", "ssrc": 0, "timestamp": "timestamp" } ], "video_consumer_cumulative": { "frame_per_second": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "frame_width": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "issues": { "lag_fraction": 0, "no_video_fraction": 0, "poor_resolution_fraction": 0 }, "jitter_buffer_delay": { "100ms_or_greater_event_fraction": 0, "250ms_or_greater_event_fraction": 0, "500ms_or_greater_event_fraction": 0, "avg": 0 }, "key_frames_decoded_fraction": 0, "packet_loss": { "10_or_greater_event_fraction": 0, "25_or_greater_event_fraction": 0, "5_or_greater_event_fraction": 0, "50_or_greater_event_fraction": 0, "avg": 0 }, "quality_mos": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 } }, "video_producer": [ { "bytes_sent": 0, "fir_count": 0, "frame_height": 0, "frame_width": 0, "frames_encoded": 0, "frames_per_second": 0, "jitter": 0, "key_frames_encoded": 0, "mid": "mid", "mos_quality": 0, "packets_lost": 0, "packets_sent": 0, "pli_count": 0, "producer_id": "producer_id", "quality_limitation_durations": { "bandwidth": 0, "cpu": 0, "none": 0, "other": 0 }, "quality_limitation_reason": "cpu", "quality_limitation_resolution_changes": 0, "rtt": 0, "ssrc": 0, "timestamp": "timestamp" } ], "video_producer_cumulative": { "frame_per_second": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "frame_width": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "high_negative_feedback_fraction": 0, "issues": { "bandwidth_quality_limitation_fraction": 0, "cpu_quality_limitation_fraction": 0, "no_video_fraction": 0, "poor_resolution_fraction": 0, "quality_limitation_fraction": 0 }, "key_frames_encoded_fraction": 0, "packet_loss": { "10_or_greater_event_fraction": 0, "25_or_greater_event_fraction": 0, "5_or_greater_event_fraction": 0, "50_or_greater_event_fraction": 0, "avg": 0 }, "quality_mos": { "avg": 0, "p50": 0, "p75": 0, "p90": 0 }, "rtt": { "100ms_or_greater_event_fraction": 0, "250ms_or_greater_event_fraction": 0, "500ms_or_greater_event_fraction": 0, "avg": 0 } } } }, "role": "role", "session_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "updated_at": "updated_at", "user_id": "user_id" } }, "success": true } ``` ## Domain Types ### Session Get Sessions Response - `SessionGetSessionsResponse` - `data?: Data` - `sessions?: Array` - `id: string` ID of the session - `associated_id: string` ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form `abcdef-ghijkl` - `created_at: string` timestamp when session created - `live_participants: number` number of participants currently in the session - `max_concurrent_participants: number` number of maximum participants that were in the session - `meeting_display_name: string` Title of the meeting this session belongs to - `minutes_consumed: number` number of minutes consumed since the session started - `organization_id: string` App id that hosted this session - `started_at: string` timestamp when session started - `status: "LIVE" | "ENDED"` current status of session - `"LIVE"` - `"ENDED"` - `type: "meeting" | "livestream" | "participant"` type of session - `"meeting"` - `"livestream"` - `"participant"` - `updated_at: string` timestamp when session was last updated - `breakout_rooms?: Array` - `ended_at?: string` timestamp when session ended - `paging?: Paging` - `end_offset?: number` - `start_offset?: number` - `total_count?: number` - `success?: boolean` ### Session Get Session Details Response - `SessionGetSessionDetailsResponse` - `data?: Data` - `id: string` ID of the session - `associated_id: string` ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form `abcdef-ghijkl` - `created_at: string` timestamp when session created - `live_participants: number` number of participants currently in the session - `max_concurrent_participants: number` number of maximum participants that were in the session - `meeting_display_name: string` Title of the meeting this session belongs to - `minutes_consumed: number` number of minutes consumed since the session started - `organization_id: string` App id that hosted this session - `started_at: string` timestamp when session started - `status: "LIVE" | "ENDED"` current status of session - `"LIVE"` - `"ENDED"` - `type: "meeting" | "livestream" | "participant"` type of session - `"meeting"` - `"livestream"` - `"participant"` - `updated_at: string` timestamp when session was last updated - `breakout_rooms?: Array` - `ended_at?: string` timestamp when session ended - `success?: boolean` ### Session Get Session Participants Response - `SessionGetSessionParticipantsResponse` - `data?: Data` - `participants?: Array` - `id?: string` Participant ID. This maps to the corresponding peerId. - `created_at?: string` timestamp when this participant was created. - `custom_participant_id?: string` ID passed by client to create this participant. - `display_name?: string` Display name of participant when joining the session. - `duration?: number` number of minutes for which the participant was in the session. - `joined_at?: string` timestamp at which participant joined the session. - `left_at?: string` timestamp at which participant left the session. - `peer_events?: Array` Connection lifecycle events for the participant's peer. Only included when `include_peer_events` is true. - `id?: string` ID of the peer event. - `created_at?: string` Timestamp when this peer event was created. - `event_name?: "PEER_CREATED" | "PEER_JOINING" | "PEER_LEAVING"` Name of the peer event. - `"PEER_CREATED"` - `"PEER_JOINING"` - `"PEER_LEAVING"` - `minutes_consumed?: number` Minutes consumed attributed to this event. - `participant_id?: string | null` ID of the participant this event belongs to. - `peer_id?: string` Peer ID this event belongs to. - `preset_view_type?: "GROUP_CALL" | "WEBINAR" | "AUDIO_ROOM" | 2 more | null` View type of the preset associated with the peer. - `"GROUP_CALL"` - `"WEBINAR"` - `"AUDIO_ROOM"` - `"LIVESTREAM"` - `"CHAT"` - `session_id?: string | null` ID of the session this event belongs to. - `socket_session_id?: string | null` ID of the socket session associated with this event. - `updated_at?: string` Timestamp when this peer event was last updated. - `preset_name?: string` Name of the preset associated with the participant. - `updated_at?: string` timestamp when this participant's data was last updated. - `user_id?: string` User id for this participant. - `success?: boolean` ### Session Get Session Participant Details Response - `SessionGetSessionParticipantDetailsResponse` - `data?: Data` - `participant?: Participant` - `id?: string` Participant ID. This maps to the corresponding peerId. - `created_at?: string` timestamp when this participant was created. - `custom_participant_id?: string` ID passed by client to create this participant. - `display_name?: string` Display name of participant when joining the session. - `duration?: number` number of minutes for which the participant was in the session. - `joined_at?: string` timestamp at which participant joined the session. - `left_at?: string` timestamp at which participant left the session. - `peer_events?: Array` Connection lifecycle events for the participant's peer. Only included when `include_peer_events` is true. - `id?: string` ID of the peer event. - `created_at?: string` Timestamp when this peer event was created. - `event_name?: "PEER_CREATED" | "PEER_JOINING" | "PEER_LEAVING"` Name of the peer event. - `"PEER_CREATED"` - `"PEER_JOINING"` - `"PEER_LEAVING"` - `minutes_consumed?: number` Minutes consumed attributed to this event. - `participant_id?: string | null` ID of the participant this event belongs to. - `peer_id?: string` Peer ID this event belongs to. - `preset_view_type?: "GROUP_CALL" | "WEBINAR" | "AUDIO_ROOM" | 2 more | null` View type of the preset associated with the peer. - `"GROUP_CALL"` - `"WEBINAR"` - `"AUDIO_ROOM"` - `"LIVESTREAM"` - `"CHAT"` - `session_id?: string | null` ID of the session this event belongs to. - `socket_session_id?: string | null` ID of the socket session associated with this event. - `updated_at?: string` Timestamp when this peer event was last updated. - `preset_name?: string` Name of the preset associated with the participant. - `updated_at?: string` timestamp when this participant's data was last updated. - `user_id?: string` User id for this participant. - `success?: boolean` ### Session Get Session Chat Response - `SessionGetSessionChatResponse` - `data?: Data` - `chat_download_url: string` URL where the chat logs can be downloaded - `chat_download_url_expiry: string` Time when the download URL will expire - `success?: boolean` ### Session Get Session Transcripts Response - `SessionGetSessionTranscriptsResponse` - `data?: Data` - `sessionId: string` - `transcript_download_url: string` URL where the transcript can be downloaded - `transcript_download_url_expiry: string` Time when the download URL will expire - `success?: boolean` ### Session Get Session Summary Response - `SessionGetSessionSummaryResponse` - `data?: Data` - `sessionId: string` - `summaryDownloadUrl: string` URL where the summary of transcripts can be downloaded - `summaryDownloadUrlExpiry: string` Time of Expiry before when you need to download the csv file. - `success?: boolean` ### Session Generate Summary Of Transcripts Response - `SessionGenerateSummaryOfTranscriptsResponse` - `data?: Data` - `session_id?: string` - `status?: string` - `success?: boolean` ### Session Get Participant Data From Peer ID Response - `SessionGetParticipantDataFromPeerIDResponse` - `data?: Data` - `participant?: Participant` - `id?: string` ID of the participant. - `created_at?: string` timestamp when this participant was created. - `custom_participant_id?: string` ID passed by client to create this participant. - `display_name?: string` Display name of participant when joining the session. - `duration?: number` number of minutes for which the participant was in the session. - `joined_at?: string` timestamp at which participant joined the session. - `left_at?: string` timestamp at which participant left the session. - `peer_events?: Array` Connection lifecycle events for the participant's peer. - `id?: string` ID of the peer event. - `created_at?: string` Timestamp when this peer event was created. - `event_name?: "PEER_CREATED" | "PEER_JOINING" | "PEER_LEAVING"` Name of the peer event. - `"PEER_CREATED"` - `"PEER_JOINING"` - `"PEER_LEAVING"` - `minutes_consumed?: number` Minutes consumed attributed to this event. - `participant_id?: string | null` ID of the participant this event belongs to. - `peer_id?: string` Peer ID this event belongs to. - `preset_view_type?: "GROUP_CALL" | "WEBINAR" | "AUDIO_ROOM" | 2 more | null` View type of the preset associated with the peer. - `"GROUP_CALL"` - `"WEBINAR"` - `"AUDIO_ROOM"` - `"LIVESTREAM"` - `"CHAT"` - `session_id?: string | null` ID of the session this event belongs to. - `socket_session_id?: string | null` ID of the socket session associated with this event. - `updated_at?: string` Timestamp when this peer event was last updated. - `peer_report?: PeerReport` Peer call statistics report. - `metadata?: Metadata` Connection and device metadata for the participant. - `audio_devices_updates?: Array` - `added?: Array` Devices that became available. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `removed?: Array` Devices that became unavailable. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `timestamp?: string` Timestamp of the device update. - `browser_metadata?: BrowserMetadata` - `browser?: string` - `browser_version?: string` - `engine?: string` - `user_agent?: string` - `webgl_support?: boolean | null` - `candidate_pairs?: CandidatePairs` - `consuming_transport?: Array` - `available_incoming_bitrate?: number` - `available_outgoing_bitrate?: number` - `bytes_discarded_on_send?: number` - `bytes_received?: number` - `bytes_sent?: number` - `current_round_trip_time?: number` - `last_packet_received_timestamp?: number` Epoch milliseconds when the last packet was received. - `last_packet_sent_timestamp?: number` Epoch milliseconds when the last packet was sent. - `local_candidate_address?: string` - `local_candidate_id?: string` - `local_candidate_network_type?: string` - `local_candidate_port?: number` - `local_candidate_protocol?: string` - `local_candidate_related_address?: string` - `local_candidate_related_port?: number` - `local_candidate_type?: string` - `local_candidate_url?: string` - `nominated?: boolean` - `packets_discarded_on_send?: number` - `packets_received?: number` - `packets_sent?: number` - `remote_candidate_address?: string` - `remote_candidate_id?: string` - `remote_candidate_port?: number` - `remote_candidate_protocol?: string` - `remote_candidate_type?: string` - `remote_candidate_url?: string` - `total_round_trip_time?: number` - `producing_transport?: Array` - `available_incoming_bitrate?: number` - `available_outgoing_bitrate?: number` - `bytes_discarded_on_send?: number` - `bytes_received?: number` - `bytes_sent?: number` - `current_round_trip_time?: number` - `last_packet_received_timestamp?: number` Epoch milliseconds when the last packet was received. - `last_packet_sent_timestamp?: number` Epoch milliseconds when the last packet was sent. - `local_candidate_address?: string` - `local_candidate_id?: string` - `local_candidate_network_type?: string` - `local_candidate_port?: number` - `local_candidate_protocol?: string` - `local_candidate_related_address?: string` - `local_candidate_related_port?: number` - `local_candidate_type?: string` - `local_candidate_url?: string` - `nominated?: boolean` - `packets_discarded_on_send?: number` - `packets_received?: number` - `packets_sent?: number` - `remote_candidate_address?: string` - `remote_candidate_id?: string` - `remote_candidate_port?: number` - `remote_candidate_protocol?: string` - `remote_candidate_type?: string` - `remote_candidate_url?: string` - `total_round_trip_time?: number` - `device_info?: DeviceInfo` - `cpus?: number` - `is_mobile?: boolean` - `os?: string` - `os_version?: string` - `events?: Array` - `metadata?: Record` Event-specific metadata. Keys vary per event; values are primitive scalars (string, number, boolean, or null). - `string` - `number` - `boolean` - `name?: string` Name of the event. - `timestamp?: string` Timestamp when the event occurred. - `ip_information?: IPInformation` - `asn?: ASN` - `asn?: string` - `domain?: string` - `name?: string` - `route?: string` - `type?: string` - `city?: string` - `country?: string` - `ipv4?: string` - `org?: string` - `region?: string` - `timezone?: string` - `native_metadata?: NativeMetadata` - `audio_encoder?: string` - `video_encoder?: string` - `pc_metadata?: Array` - `effective_network_type?: string` - `reflexive_connectivity?: boolean` - `relay_connectivity?: boolean` - `sdp?: Array` - `timestamp?: string` - `turn_connectivity?: boolean` - `room_view_type?: string` - `sdk_name?: string` - `sdk_type?: string` - `sdk_version?: string` - `selected_device_updates?: Array` - `device?: Device` A media device (camera, microphone, or speaker). - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `timestamp?: string` - `speaker_devices_updates?: Array` - `added?: Array` Devices that became available. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `removed?: Array` Devices that became unavailable. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `timestamp?: string` Timestamp of the device update. - `video_devices_updates?: Array` - `added?: Array` Devices that became available. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `removed?: Array` Devices that became unavailable. - `device_id?: string` ID of the device. - `kind?: string` Kind of device, for example audioinput or videoinput. - `label?: string` Human-readable label of the device. - `timestamp?: string` Timestamp of the device update. - `quality?: Quality` Media quality statistics for the participant. - `audio_consumer?: Array` - `bytes_received?: number` - `concealment_events?: number` - `consumer_id?: string` - `jitter?: number` - `jitter_buffer_delay?: number` - `jitter_buffer_emitted_count?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_received?: number` - `peer_id?: string` - `producer_id?: string` - `ssrc?: number` - `timestamp?: string` - `audio_consumer_cumulative?: AudioConsumerCumulative` Aggregated inbound (consumer) audio statistics for the session. - `jitter_buffer_delay?: JitterBufferDelay` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `audio_producer?: Array` - `bytes_sent?: number` - `jitter?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_sent?: number` - `producer_id?: string` - `rtt?: number` - `ssrc?: number` - `timestamp?: string` - `audio_producer_cumulative?: AudioProducerCumulative` Aggregated outbound (producer) audio statistics for the session. - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `rtt?: RTT` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `screenshare_audio_consumer?: Array` - `bytes_received?: number` - `concealment_events?: number` - `consumer_id?: string` - `jitter?: number` - `jitter_buffer_delay?: number` - `jitter_buffer_emitted_count?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_received?: number` - `peer_id?: string` - `producer_id?: string` - `ssrc?: number` - `timestamp?: string` - `screenshare_audio_consumer_cumulative?: ScreenshareAudioConsumerCumulative` Aggregated inbound (consumer) audio statistics for the session. - `jitter_buffer_delay?: JitterBufferDelay` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `screenshare_audio_producer?: Array` - `bytes_sent?: number` - `jitter?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_sent?: number` - `producer_id?: string` - `rtt?: number` - `ssrc?: number` - `timestamp?: string` - `screenshare_audio_producer_cumulative?: ScreenshareAudioProducerCumulative` Aggregated outbound (producer) audio statistics for the session. - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `rtt?: RTT` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `screenshare_video_consumer?: Array` - `bytes_received?: number` - `consumer_id?: string` - `fir_count?: number` - `frame_height?: number` - `frame_width?: number` - `frames_decoded?: number` - `frames_dropped?: number` - `frames_per_second?: number` - `jitter?: number` - `jitter_buffer_delay?: number` - `jitter_buffer_emitted_count?: number` - `key_frames_decoded?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_received?: number` - `peer_id?: string` - `producer_id?: string` - `ssrc?: number` - `timestamp?: string` - `screenshare_video_consumer_cumulative?: ScreenshareVideoConsumerCumulative` Aggregated inbound (consumer) video statistics for the session. - `frame_per_second?: FramePerSecond` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `frame_width?: FrameWidth` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `issues?: Issues` - `lag_fraction?: number` - `no_video_fraction?: number` - `poor_resolution_fraction?: number` - `jitter_buffer_delay?: JitterBufferDelay` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `key_frames_decoded_fraction?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `screenshare_video_producer?: Array` - `bytes_sent?: number` - `fir_count?: number` - `frame_height?: number` - `frame_width?: number` - `frames_encoded?: number` - `frames_per_second?: number` - `jitter?: number` - `key_frames_encoded?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_sent?: number` - `pli_count?: number` - `producer_id?: string` - `quality_limitation_durations?: QualityLimitationDurations` - `bandwidth?: number` - `cpu?: number` - `none?: number` - `other?: number` - `quality_limitation_reason?: "cpu" | "bandwidth" | "none" | "other"` - `"cpu"` - `"bandwidth"` - `"none"` - `"other"` - `quality_limitation_resolution_changes?: number` - `rtt?: number` - `ssrc?: number` - `timestamp?: string` - `screenshare_video_producer_cumulative?: ScreenshareVideoProducerCumulative` Aggregated outbound (producer) video statistics for the session. - `frame_per_second?: FramePerSecond` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `frame_width?: FrameWidth` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `high_negative_feedback_fraction?: number` - `issues?: Issues` - `bandwidth_quality_limitation_fraction?: number` - `cpu_quality_limitation_fraction?: number` - `no_video_fraction?: number` - `poor_resolution_fraction?: number` - `quality_limitation_fraction?: number` - `key_frames_encoded_fraction?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `rtt?: RTT` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `video_consumer?: Array` - `bytes_received?: number` - `consumer_id?: string` - `fir_count?: number` - `frame_height?: number` - `frame_width?: number` - `frames_decoded?: number` - `frames_dropped?: number` - `frames_per_second?: number` - `jitter?: number` - `jitter_buffer_delay?: number` - `jitter_buffer_emitted_count?: number` - `key_frames_decoded?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_received?: number` - `peer_id?: string` - `producer_id?: string` - `ssrc?: number` - `timestamp?: string` - `video_consumer_cumulative?: VideoConsumerCumulative` Aggregated inbound (consumer) video statistics for the session. - `frame_per_second?: FramePerSecond` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `frame_width?: FrameWidth` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `issues?: Issues` - `lag_fraction?: number` - `no_video_fraction?: number` - `poor_resolution_fraction?: number` - `jitter_buffer_delay?: JitterBufferDelay` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `key_frames_decoded_fraction?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `video_producer?: Array` - `bytes_sent?: number` - `fir_count?: number` - `frame_height?: number` - `frame_width?: number` - `frames_encoded?: number` - `frames_per_second?: number` - `jitter?: number` - `key_frames_encoded?: number` - `mid?: string` - `mos_quality?: number` - `packets_lost?: number` - `packets_sent?: number` - `pli_count?: number` - `producer_id?: string` - `quality_limitation_durations?: QualityLimitationDurations` - `bandwidth?: number` - `cpu?: number` - `none?: number` - `other?: number` - `quality_limitation_reason?: "cpu" | "bandwidth" | "none" | "other"` - `"cpu"` - `"bandwidth"` - `"none"` - `"other"` - `quality_limitation_resolution_changes?: number` - `rtt?: number` - `ssrc?: number` - `timestamp?: string` - `video_producer_cumulative?: VideoProducerCumulative` Aggregated outbound (producer) video statistics for the session. - `frame_per_second?: FramePerSecond` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `frame_width?: FrameWidth` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `high_negative_feedback_fraction?: number` - `issues?: Issues` - `bandwidth_quality_limitation_fraction?: number` - `cpu_quality_limitation_fraction?: number` - `no_video_fraction?: number` - `poor_resolution_fraction?: number` - `quality_limitation_fraction?: number` - `key_frames_encoded_fraction?: number` - `packet_loss?: PacketLoss` Cumulative packet loss distribution. - `"10_or_greater_event_fraction"?: number` - `"25_or_greater_event_fraction"?: number` - `"5_or_greater_event_fraction"?: number` - `"50_or_greater_event_fraction"?: number` - `avg?: number` - `quality_mos?: QualityMos` Distribution summary with average and percentiles. - `avg?: number` - `p50?: number` - `p75?: number` - `p90?: number` - `rtt?: RTT` Cumulative latency distribution (milliseconds-based thresholds). - `"100ms_or_greater_event_fraction"?: number` - `"250ms_or_greater_event_fraction"?: number` - `"500ms_or_greater_event_fraction"?: number` - `avg?: number` - `role?: string` Name of the preset associated with the participant. - `session_id?: string` - `updated_at?: string` timestamp when this participant's data was last updated. - `user_id?: string` User id for this participant. - `success?: boolean`