--- title: Sessions --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Realtime Kit](https://developers.cloudflare.com/api/typescript/resources/realtime_kit) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Sessions ##### [Fetch all sessions of an App](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_sessions) client.realtimeKit.sessions.getSessions(stringappID, SessionGetSessionsParams {account\_id, associated\_id, end\_time, 8 more } params, RequestOptionsoptions?): [SessionGetSessionsResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions ##### [Fetch details of a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_details) client.realtimeKit.sessions.getSessionDetails(stringsessionID, SessionGetSessionDetailsParams {account\_id, app\_id, include\_breakout\_rooms } params, RequestOptionsoptions?): [SessionGetSessionDetailsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id} ##### [Fetch participants list of a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_participants) client.realtimeKit.sessions.getSessionParticipants(stringsessionID, SessionGetSessionParticipantsParams {account\_id, app\_id, include\_peer\_events, 6 more } params, RequestOptionsoptions?): [SessionGetSessionParticipantsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/participants ##### [Fetch details of a participant](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_participant_details) client.realtimeKit.sessions.getSessionParticipantDetails(stringparticipantID, SessionGetSessionParticipantDetailsParams {account\_id, app\_id, session\_id, include\_peer\_events } params, RequestOptionsoptions?): [SessionGetSessionParticipantDetailsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/participants/{participant\_id} ##### [Fetch all chat messages of a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_chat) client.realtimeKit.sessions.getSessionChat(stringsessionID, SessionGetSessionChatParams {account\_id, app\_id } params, RequestOptionsoptions?): [SessionGetSessionChatResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/chat ##### [Fetch the complete transcript for a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_transcripts) client.realtimeKit.sessions.getSessionTranscripts(stringsessionID, SessionGetSessionTranscriptsParams {account\_id, app\_id, format } params, RequestOptionsoptions?): [SessionGetSessionTranscriptsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/transcript ##### [Fetch summary of transcripts for a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_summary) client.realtimeKit.sessions.getSessionSummary(stringsessionID, SessionGetSessionSummaryParams {account\_id, app\_id } params, RequestOptionsoptions?): [SessionGetSessionSummaryResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/summary ##### [Generate summary of Transcripts for the session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/generate_summary_of_transcripts) client.realtimeKit.sessions.generateSummaryOfTranscripts(stringsessionID, SessionGenerateSummaryOfTranscriptsParams {account\_id, app\_id } params, RequestOptionsoptions?): [SessionGenerateSummaryOfTranscriptsResponse]() {data, success } POST/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/summary ##### [Fetch details of peer](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_participant_data_from_peer_id) client.realtimeKit.sessions.getParticipantDataFromPeerID(stringpeerID, SessionGetParticipantDataFromPeerIDParams {account\_id, app\_id, filters, include\_peer\_events } params, RequestOptionsoptions?): [SessionGetParticipantDataFromPeerIDResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/peer-report/{peer\_id} ##### ModelsExpand Collapse
SessionGetSessionsResponse {data, paging, success }
data?: Data {sessions }
sessions?: Array<Session> id: string ID of the session Link to this property 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 Link to this property created\_at: string timestamp when session created Link to this property live\_participants: number number of participants currently in the session Link to this property max\_concurrent\_participants: number number of maximum participants that were in the session Link to this property meeting\_display\_name: string Title of the meeting this session belongs to Link to this property minutes\_consumed: number number of minutes consumed since the session started Link to this property organization\_id: string App id that hosted this session Link to this property started\_at: string timestamp when session started Link to this property
status: "LIVE"| "ENDED" current status of session One of the following: "LIVE" Link to this property "ENDED" Link to this property
Link to this property
type: "meeting"| "livestream"| "participant" type of session One of the following: "meeting" Link to this property "livestream" Link to this property "participant" Link to this property
Link to this property updated\_at: string timestamp when session was last updated Link to this property breakout\_rooms?: Array<unknown> Link to this property ended\_at?: string timestamp when session ended Link to this property
Link to this property
Link to this property
paging?: Paging {end\_offset, start\_offset, total\_count } end\_offset?: number Link to this property start\_offset?: number Link to this property total\_count?: number minimum0 Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_sessions_response%20%3E%20(schema)>)
SessionGetSessionDetailsResponse {data, success }
data?: Data {id, associated\_id, created\_at, 11 more } id: string ID of the session Link to this property 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 Link to this property created\_at: string timestamp when session created Link to this property live\_participants: number number of participants currently in the session Link to this property max\_concurrent\_participants: number number of maximum participants that were in the session Link to this property meeting\_display\_name: string Title of the meeting this session belongs to Link to this property minutes\_consumed: number number of minutes consumed since the session started Link to this property organization\_id: string App id that hosted this session Link to this property started\_at: string timestamp when session started Link to this property
status: "LIVE"| "ENDED" current status of session One of the following: "LIVE" Link to this property "ENDED" Link to this property
Link to this property
type: "meeting"| "livestream"| "participant" type of session One of the following: "meeting" Link to this property "livestream" Link to this property "participant" Link to this property
Link to this property updated\_at: string timestamp when session was last updated Link to this property breakout\_rooms?: Array<unknown> Link to this property ended\_at?: string timestamp when session ended Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_details_response%20%3E%20(schema)>)
SessionGetSessionParticipantsResponse {data, success }
data?: Data {participants }
participants?: Array<Participant> id?: string Participant ID. This maps to the corresponding peerId. Link to this property created\_at?: string timestamp when this participant was created. Link to this property custom\_participant\_id?: string ID passed by client to create this participant. Link to this property display\_name?: string Display name of participant when joining the session. Link to this property duration?: number number of minutes for which the participant was in the session. Link to this property joined\_at?: string timestamp at which participant joined the session. Link to this property left\_at?: string timestamp at which participant left the session. Link to this property
peer\_events?: Array<PeerEvent> Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true. id?: string ID of the peer event. Link to this property created\_at?: string Timestamp when this peer event was created. Link to this property
event\_name?: "PEER\_CREATED"| "PEER\_JOINING"| "PEER\_LEAVING" Name of the peer event. One of the following: "PEER\_CREATED" Link to this property "PEER\_JOINING" Link to this property "PEER\_LEAVING" Link to this property
Link to this property minutes\_consumed?: number Minutes consumed attributed to this event. Link to this property participant\_id?: string| null ID of the participant this event belongs to. Link to this property peer\_id?: string Peer ID this event belongs to. Link to this property
preset\_view\_type?: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| 2 more| null View type of the preset associated with the peer. One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property "CHAT" Link to this property
Link to this property session\_id?: string| null ID of the session this event belongs to. Link to this property socket\_session\_id?: string| null ID of the socket session associated with this event. Link to this property updated\_at?: string Timestamp when this peer event was last updated. Link to this property
Link to this property preset\_name?: string Name of the preset associated with the participant. Link to this property updated\_at?: string timestamp when this participant’s data was last updated. Link to this property user\_id?: string User id for this participant. Link to this property
Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_participants_response%20%3E%20(schema)>)
SessionGetSessionParticipantDetailsResponse {data, success }
data?: Data {participant }
participant?: Participant {id, created\_at, custom\_participant\_id, 8 more } id?: string Participant ID. This maps to the corresponding peerId. Link to this property created\_at?: string timestamp when this participant was created. Link to this property custom\_participant\_id?: string ID passed by client to create this participant. Link to this property display\_name?: string Display name of participant when joining the session. Link to this property duration?: number number of minutes for which the participant was in the session. Link to this property joined\_at?: string timestamp at which participant joined the session. Link to this property left\_at?: string timestamp at which participant left the session. Link to this property
peer\_events?: Array<PeerEvent> Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true. id?: string ID of the peer event. Link to this property created\_at?: string Timestamp when this peer event was created. Link to this property
event\_name?: "PEER\_CREATED"| "PEER\_JOINING"| "PEER\_LEAVING" Name of the peer event. One of the following: "PEER\_CREATED" Link to this property "PEER\_JOINING" Link to this property "PEER\_LEAVING" Link to this property
Link to this property minutes\_consumed?: number Minutes consumed attributed to this event. Link to this property participant\_id?: string| null ID of the participant this event belongs to. Link to this property peer\_id?: string Peer ID this event belongs to. Link to this property
preset\_view\_type?: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| 2 more| null View type of the preset associated with the peer. One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property "CHAT" Link to this property
Link to this property session\_id?: string| null ID of the session this event belongs to. Link to this property socket\_session\_id?: string| null ID of the socket session associated with this event. Link to this property updated\_at?: string Timestamp when this peer event was last updated. Link to this property
Link to this property preset\_name?: string Name of the preset associated with the participant. Link to this property updated\_at?: string timestamp when this participant’s data was last updated. Link to this property user\_id?: string User id for this participant. Link to this property
Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_participant_details_response%20%3E%20(schema)>)
SessionGetSessionChatResponse {data, success }
data?: Data {chat\_download\_url, chat\_download\_url\_expiry } chat\_download\_url: string URL where the chat logs can be downloaded Link to this property chat\_download\_url\_expiry: string Time when the download URL will expire Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_chat_response%20%3E%20(schema)>)
SessionGetSessionTranscriptsResponse {data, success }
data?: Data {sessionId, transcript\_download\_url, transcript\_download\_url\_expiry } sessionId: string Link to this property transcript\_download\_url: string URL where the transcript can be downloaded Link to this property transcript\_download\_url\_expiry: string Time when the download URL will expire Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_transcripts_response%20%3E%20(schema)>)
SessionGetSessionSummaryResponse {data, success }
data?: Data {sessionId, summaryDownloadUrl, summaryDownloadUrlExpiry } sessionId: string Link to this property summaryDownloadUrl: string URL where the summary of transcripts can be downloaded Link to this property summaryDownloadUrlExpiry: string Time of Expiry before when you need to download the csv file. Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_summary_response%20%3E%20(schema)>)
SessionGenerateSummaryOfTranscriptsResponse {data, success }
data?: Data {session\_id, status } session\_id?: string formatuuid Link to this property status?: string Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_generate_summary_of_transcripts_response%20%3E%20(schema)>)
SessionGetParticipantDataFromPeerIDResponse {data, success }
data?: Data {participant }
participant?: Participant {id, created\_at, custom\_participant\_id, 10 more } id?: string ID of the participant. formatuuid Link to this property created\_at?: string timestamp when this participant was created. Link to this property custom\_participant\_id?: string ID passed by client to create this participant. Link to this property display\_name?: string Display name of participant when joining the session. Link to this property duration?: number number of minutes for which the participant was in the session. Link to this property joined\_at?: string timestamp at which participant joined the session. Link to this property left\_at?: string timestamp at which participant left the session. Link to this property
peer\_events?: Array<PeerEvent> Connection lifecycle events for the participant’s peer. id?: string ID of the peer event. Link to this property created\_at?: string Timestamp when this peer event was created. Link to this property
event\_name?: "PEER\_CREATED"| "PEER\_JOINING"| "PEER\_LEAVING" Name of the peer event. One of the following: "PEER\_CREATED" Link to this property "PEER\_JOINING" Link to this property "PEER\_LEAVING" Link to this property
Link to this property minutes\_consumed?: number Minutes consumed attributed to this event. Link to this property participant\_id?: string| null ID of the participant this event belongs to. Link to this property peer\_id?: string Peer ID this event belongs to. Link to this property
preset\_view\_type?: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| 2 more| null View type of the preset associated with the peer. One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property "CHAT" Link to this property
Link to this property session\_id?: string| null ID of the session this event belongs to. Link to this property socket\_session\_id?: string| null ID of the socket session associated with this event. Link to this property updated\_at?: string Timestamp when this peer event was last updated. Link to this property
Link to this property
peer\_report?: PeerReport {metadata, quality } Peer call statistics report.
metadata?: Metadata {audio\_devices\_updates, browser\_metadata, candidate\_pairs, 12 more } Connection and device metadata for the participant.
audio\_devices\_updates?: Array<AudioDevicesUpdate>
added?: Array<Added> Devices that became available. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property
removed?: Array<Removed> Devices that became unavailable. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property timestamp?: string Timestamp of the device update. Link to this property
Link to this property
browser\_metadata?: BrowserMetadata {browser, browser\_version, engine, 2 more } browser?: string Link to this property browser\_version?: string Link to this property engine?: string Link to this property user\_agent?: string Link to this property webgl\_support?: boolean| null Link to this property
Link to this property
candidate\_pairs?: CandidatePairs {consuming\_transport, producing\_transport }
consuming\_transport?: Array<ConsumingTransport> available\_incoming\_bitrate?: number Link to this property available\_outgoing\_bitrate?: number Link to this property bytes\_discarded\_on\_send?: number Link to this property bytes\_received?: number Link to this property bytes\_sent?: number Link to this property current\_round\_trip\_time?: number Link to this property last\_packet\_received\_timestamp?: number Epoch milliseconds when the last packet was received. Link to this property last\_packet\_sent\_timestamp?: number Epoch milliseconds when the last packet was sent. Link to this property local\_candidate\_address?: string Link to this property local\_candidate\_id?: string Link to this property local\_candidate\_network\_type?: string Link to this property local\_candidate\_port?: number Link to this property local\_candidate\_protocol?: string Link to this property local\_candidate\_related\_address?: string Link to this property local\_candidate\_related\_port?: number Link to this property local\_candidate\_type?: string Link to this property local\_candidate\_url?: string Link to this property nominated?: boolean Link to this property packets\_discarded\_on\_send?: number Link to this property packets\_received?: number Link to this property packets\_sent?: number Link to this property remote\_candidate\_address?: string Link to this property remote\_candidate\_id?: string Link to this property remote\_candidate\_port?: number Link to this property remote\_candidate\_protocol?: string Link to this property remote\_candidate\_type?: string Link to this property remote\_candidate\_url?: string Link to this property total\_round\_trip\_time?: number Link to this property
Link to this property
producing\_transport?: Array<ProducingTransport> available\_incoming\_bitrate?: number Link to this property available\_outgoing\_bitrate?: number Link to this property bytes\_discarded\_on\_send?: number Link to this property bytes\_received?: number Link to this property bytes\_sent?: number Link to this property current\_round\_trip\_time?: number Link to this property last\_packet\_received\_timestamp?: number Epoch milliseconds when the last packet was received. Link to this property last\_packet\_sent\_timestamp?: number Epoch milliseconds when the last packet was sent. Link to this property local\_candidate\_address?: string Link to this property local\_candidate\_id?: string Link to this property local\_candidate\_network\_type?: string Link to this property local\_candidate\_port?: number Link to this property local\_candidate\_protocol?: string Link to this property local\_candidate\_related\_address?: string Link to this property local\_candidate\_related\_port?: number Link to this property local\_candidate\_type?: string Link to this property local\_candidate\_url?: string Link to this property nominated?: boolean Link to this property packets\_discarded\_on\_send?: number Link to this property packets\_received?: number Link to this property packets\_sent?: number Link to this property remote\_candidate\_address?: string Link to this property remote\_candidate\_id?: string Link to this property remote\_candidate\_port?: number Link to this property remote\_candidate\_protocol?: string Link to this property remote\_candidate\_type?: string Link to this property remote\_candidate\_url?: string Link to this property total\_round\_trip\_time?: number Link to this property
Link to this property
Link to this property
device\_info?: DeviceInfo {cpus, is\_mobile, os, os\_version } cpus?: number Link to this property is\_mobile?: boolean Link to this property os?: string Link to this property os\_version?: string Link to this property
Link to this property
events?: Array<Event>
metadata?: Record<string, string| number| boolean| null> Event-specific metadata. Keys vary per event; values are primitive scalars (string, number, boolean, or null). One of the following: string Link to this property number Link to this property boolean Link to this property
Link to this property name?: string Name of the event. Link to this property timestamp?: string Timestamp when the event occurred. Link to this property
Link to this property
ip\_information?: IPInformation {asn, city, country, 4 more }
asn?: ASN {asn, domain, name, 2 more } asn?: string Link to this property domain?: string Link to this property name?: string Link to this property route?: string Link to this property type?: string Link to this property
Link to this property city?: string Link to this property country?: string Link to this property ipv4?: string Link to this property org?: string Link to this property region?: string Link to this property timezone?: string Link to this property
Link to this property
native\_metadata?: NativeMetadata {audio\_encoder, video\_encoder } audio\_encoder?: string Link to this property video\_encoder?: string Link to this property
Link to this property
pc\_metadata?: Array<PcMetadata> effective\_network\_type?: string Link to this property reflexive\_connectivity?: boolean Link to this property relay\_connectivity?: boolean Link to this property sdp?: Array<string> Link to this property timestamp?: string Link to this property turn\_connectivity?: boolean Link to this property
Link to this property room\_view\_type?: string Link to this property sdk\_name?: string Link to this property sdk\_type?: string Link to this property sdk\_version?: string Link to this property
selected\_device\_updates?: Array<SelectedDeviceUpdate>
device?: Device {device\_id, kind, label } A media device (camera, microphone, or speaker). device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property timestamp?: string Link to this property
Link to this property
speaker\_devices\_updates?: Array<SpeakerDevicesUpdate>
added?: Array<Added> Devices that became available. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property
removed?: Array<Removed> Devices that became unavailable. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property timestamp?: string Timestamp of the device update. Link to this property
Link to this property
video\_devices\_updates?: Array<VideoDevicesUpdate>
added?: Array<Added> Devices that became available. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property
removed?: Array<Removed> Devices that became unavailable. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property timestamp?: string Timestamp of the device update. Link to this property
Link to this property
Link to this property
quality?: Quality {audio\_consumer, audio\_consumer\_cumulative, audio\_producer, 13 more } Media quality statistics for the participant.
audio\_consumer?: Array<AudioConsumer> bytes\_received?: number Link to this property concealment\_events?: number Link to this property consumer\_id?: string Link to this property jitter?: number Link to this property jitter\_buffer\_delay?: number Link to this property jitter\_buffer\_emitted\_count?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_received?: number Link to this property peer\_id?: string Link to this property producer\_id?: string Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
audio\_consumer\_cumulative?: AudioConsumerCumulative {jitter\_buffer\_delay, packet\_loss, quality\_mos } Aggregated inbound (consumer) audio statistics for the session.
jitter\_buffer\_delay?: JitterBufferDelay {100ms\_or\_greater\_event\_fraction, 250ms\_or\_greater\_event\_fraction, 500ms\_or\_greater\_event\_fraction, avg } Cumulative latency distribution (milliseconds-based thresholds). "100ms\_or\_greater\_event\_fraction"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
packet\_loss?: PacketLoss {10\_or\_greater\_event\_fraction, 25\_or\_greater\_event\_fraction, 5\_or\_greater\_event\_fraction, 2 more } Cumulative packet loss distribution. "10\_or\_greater\_event\_fraction"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
Link to this property
audio\_producer?: Array<AudioProducer> bytes\_sent?: number Link to this property jitter?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_sent?: number Link to this property producer\_id?: string Link to this property rtt?: number Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
audio\_producer\_cumulative?: AudioProducerCumulative {packet\_loss, quality\_mos, rtt } Aggregated outbound (producer) audio statistics for the session.
packet\_loss?: PacketLoss {10\_or\_greater\_event\_fraction, 25\_or\_greater\_event\_fraction, 5\_or\_greater\_event\_fraction, 2 more } Cumulative packet loss distribution. "10\_or\_greater\_event\_fraction"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
rtt?: RTT {100ms\_or\_greater\_event\_fraction, 250ms\_or\_greater\_event\_fraction, 500ms\_or\_greater\_event\_fraction, avg } Cumulative latency distribution (milliseconds-based thresholds). "100ms\_or\_greater\_event\_fraction"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
Link to this property
screenshare\_audio\_consumer?: Array<ScreenshareAudioConsumer> bytes\_received?: number Link to this property concealment\_events?: number Link to this property consumer\_id?: string Link to this property jitter?: number Link to this property jitter\_buffer\_delay?: number Link to this property jitter\_buffer\_emitted\_count?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_received?: number Link to this property peer\_id?: string Link to this property producer\_id?: string Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
screenshare\_audio\_consumer\_cumulative?: ScreenshareAudioConsumerCumulative {jitter\_buffer\_delay, packet\_loss, quality\_mos } Aggregated inbound (consumer) audio statistics for the session.
jitter\_buffer\_delay?: JitterBufferDelay {100ms\_or\_greater\_event\_fraction, 250ms\_or\_greater\_event\_fraction, 500ms\_or\_greater\_event\_fraction, avg } Cumulative latency distribution (milliseconds-based thresholds). "100ms\_or\_greater\_event\_fraction"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
packet\_loss?: PacketLoss {10\_or\_greater\_event\_fraction, 25\_or\_greater\_event\_fraction, 5\_or\_greater\_event\_fraction, 2 more } Cumulative packet loss distribution. "10\_or\_greater\_event\_fraction"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
Link to this property
screenshare\_audio\_producer?: Array<ScreenshareAudioProducer> bytes\_sent?: number Link to this property jitter?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_sent?: number Link to this property producer\_id?: string Link to this property rtt?: number Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
screenshare\_audio\_producer\_cumulative?: ScreenshareAudioProducerCumulative {packet\_loss, quality\_mos, rtt } Aggregated outbound (producer) audio statistics for the session.
packet\_loss?: PacketLoss {10\_or\_greater\_event\_fraction, 25\_or\_greater\_event\_fraction, 5\_or\_greater\_event\_fraction, 2 more } Cumulative packet loss distribution. "10\_or\_greater\_event\_fraction"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
rtt?: RTT {100ms\_or\_greater\_event\_fraction, 250ms\_or\_greater\_event\_fraction, 500ms\_or\_greater\_event\_fraction, avg } Cumulative latency distribution (milliseconds-based thresholds). "100ms\_or\_greater\_event\_fraction"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
Link to this property
screenshare\_video\_consumer?: Array<ScreenshareVideoConsumer> bytes\_received?: number Link to this property consumer\_id?: string Link to this property fir\_count?: number Link to this property frame\_height?: number Link to this property frame\_width?: number Link to this property frames\_decoded?: number Link to this property frames\_dropped?: number Link to this property frames\_per\_second?: number Link to this property jitter?: number Link to this property jitter\_buffer\_delay?: number Link to this property jitter\_buffer\_emitted\_count?: number Link to this property key\_frames\_decoded?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_received?: number Link to this property peer\_id?: string Link to this property producer\_id?: string Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
screenshare\_video\_consumer\_cumulative?: ScreenshareVideoConsumerCumulative {frame\_per\_second, frame\_width, issues, 4 more } Aggregated inbound (consumer) video statistics for the session.
frame\_per\_second?: FramePerSecond {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
frame\_width?: FrameWidth {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
issues?: Issues {lag\_fraction, no\_video\_fraction, poor\_resolution\_fraction } lag\_fraction?: number Link to this property no\_video\_fraction?: number Link to this property poor\_resolution\_fraction?: number Link to this property
Link to this property
jitter\_buffer\_delay?: JitterBufferDelay {100ms\_or\_greater\_event\_fraction, 250ms\_or\_greater\_event\_fraction, 500ms\_or\_greater\_event\_fraction, avg } Cumulative latency distribution (milliseconds-based thresholds). "100ms\_or\_greater\_event\_fraction"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property key\_frames\_decoded\_fraction?: number Link to this property
packet\_loss?: PacketLoss {10\_or\_greater\_event\_fraction, 25\_or\_greater\_event\_fraction, 5\_or\_greater\_event\_fraction, 2 more } Cumulative packet loss distribution. "10\_or\_greater\_event\_fraction"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
Link to this property
screenshare\_video\_producer?: Array<ScreenshareVideoProducer> bytes\_sent?: number Link to this property fir\_count?: number Link to this property frame\_height?: number Link to this property frame\_width?: number Link to this property frames\_encoded?: number Link to this property frames\_per\_second?: number Link to this property jitter?: number Link to this property key\_frames\_encoded?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_sent?: number Link to this property pli\_count?: number Link to this property producer\_id?: string Link to this property
quality\_limitation\_durations?: QualityLimitationDurations {bandwidth, cpu, none, other } bandwidth?: number Link to this property cpu?: number Link to this property none?: number Link to this property other?: number Link to this property
Link to this property
quality\_limitation\_reason?: "cpu"| "bandwidth"| "none"| "other" One of the following: "cpu" Link to this property "bandwidth" Link to this property "none" Link to this property "other" Link to this property
Link to this property quality\_limitation\_resolution\_changes?: number Link to this property rtt?: number Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
screenshare\_video\_producer\_cumulative?: ScreenshareVideoProducerCumulative {frame\_per\_second, frame\_width, high\_negative\_feedback\_fraction, 5 more } Aggregated outbound (producer) video statistics for the session.
frame\_per\_second?: FramePerSecond {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
frame\_width?: FrameWidth {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property high\_negative\_feedback\_fraction?: number Link to this property
issues?: Issues {bandwidth\_quality\_limitation\_fraction, cpu\_quality\_limitation\_fraction, no\_video\_fraction, 2 more } bandwidth\_quality\_limitation\_fraction?: number Link to this property cpu\_quality\_limitation\_fraction?: number Link to this property no\_video\_fraction?: number Link to this property poor\_resolution\_fraction?: number Link to this property quality\_limitation\_fraction?: number Link to this property
Link to this property key\_frames\_encoded\_fraction?: number Link to this property
packet\_loss?: PacketLoss {10\_or\_greater\_event\_fraction, 25\_or\_greater\_event\_fraction, 5\_or\_greater\_event\_fraction, 2 more } Cumulative packet loss distribution. "10\_or\_greater\_event\_fraction"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
rtt?: RTT {100ms\_or\_greater\_event\_fraction, 250ms\_or\_greater\_event\_fraction, 500ms\_or\_greater\_event\_fraction, avg } Cumulative latency distribution (milliseconds-based thresholds). "100ms\_or\_greater\_event\_fraction"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
Link to this property
video\_consumer?: Array<VideoConsumer> bytes\_received?: number Link to this property consumer\_id?: string Link to this property fir\_count?: number Link to this property frame\_height?: number Link to this property frame\_width?: number Link to this property frames\_decoded?: number Link to this property frames\_dropped?: number Link to this property frames\_per\_second?: number Link to this property jitter?: number Link to this property jitter\_buffer\_delay?: number Link to this property jitter\_buffer\_emitted\_count?: number Link to this property key\_frames\_decoded?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_received?: number Link to this property peer\_id?: string Link to this property producer\_id?: string Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
video\_consumer\_cumulative?: VideoConsumerCumulative {frame\_per\_second, frame\_width, issues, 4 more } Aggregated inbound (consumer) video statistics for the session.
frame\_per\_second?: FramePerSecond {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
frame\_width?: FrameWidth {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
issues?: Issues {lag\_fraction, no\_video\_fraction, poor\_resolution\_fraction } lag\_fraction?: number Link to this property no\_video\_fraction?: number Link to this property poor\_resolution\_fraction?: number Link to this property
Link to this property
jitter\_buffer\_delay?: JitterBufferDelay {100ms\_or\_greater\_event\_fraction, 250ms\_or\_greater\_event\_fraction, 500ms\_or\_greater\_event\_fraction, avg } Cumulative latency distribution (milliseconds-based thresholds). "100ms\_or\_greater\_event\_fraction"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property key\_frames\_decoded\_fraction?: number Link to this property
packet\_loss?: PacketLoss {10\_or\_greater\_event\_fraction, 25\_or\_greater\_event\_fraction, 5\_or\_greater\_event\_fraction, 2 more } Cumulative packet loss distribution. "10\_or\_greater\_event\_fraction"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
Link to this property
video\_producer?: Array<VideoProducer> bytes\_sent?: number Link to this property fir\_count?: number Link to this property frame\_height?: number Link to this property frame\_width?: number Link to this property frames\_encoded?: number Link to this property frames\_per\_second?: number Link to this property jitter?: number Link to this property key\_frames\_encoded?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_sent?: number Link to this property pli\_count?: number Link to this property producer\_id?: string Link to this property
quality\_limitation\_durations?: QualityLimitationDurations {bandwidth, cpu, none, other } bandwidth?: number Link to this property cpu?: number Link to this property none?: number Link to this property other?: number Link to this property
Link to this property
quality\_limitation\_reason?: "cpu"| "bandwidth"| "none"| "other" One of the following: "cpu" Link to this property "bandwidth" Link to this property "none" Link to this property "other" Link to this property
Link to this property quality\_limitation\_resolution\_changes?: number Link to this property rtt?: number Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
video\_producer\_cumulative?: VideoProducerCumulative {frame\_per\_second, frame\_width, high\_negative\_feedback\_fraction, 5 more } Aggregated outbound (producer) video statistics for the session.
frame\_per\_second?: FramePerSecond {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
frame\_width?: FrameWidth {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property high\_negative\_feedback\_fraction?: number Link to this property
issues?: Issues {bandwidth\_quality\_limitation\_fraction, cpu\_quality\_limitation\_fraction, no\_video\_fraction, 2 more } bandwidth\_quality\_limitation\_fraction?: number Link to this property cpu\_quality\_limitation\_fraction?: number Link to this property no\_video\_fraction?: number Link to this property poor\_resolution\_fraction?: number Link to this property quality\_limitation\_fraction?: number Link to this property
Link to this property key\_frames\_encoded\_fraction?: number Link to this property
packet\_loss?: PacketLoss {10\_or\_greater\_event\_fraction, 25\_or\_greater\_event\_fraction, 5\_or\_greater\_event\_fraction, 2 more } Cumulative packet loss distribution. "10\_or\_greater\_event\_fraction"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
rtt?: RTT {100ms\_or\_greater\_event\_fraction, 250ms\_or\_greater\_event\_fraction, 500ms\_or\_greater\_event\_fraction, avg } Cumulative latency distribution (milliseconds-based thresholds). "100ms\_or\_greater\_event\_fraction"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
Link to this property
Link to this property
Link to this property role?: string Name of the preset associated with the participant. Link to this property session\_id?: string formatuuid Link to this property updated\_at?: string timestamp when this participant’s data was last updated. Link to this property user\_id?: string User id for this participant. Link to this property
Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_participant_data_from_peer_id_response%20%3E%20(schema)>)