Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit

Sessions

Fetch all sessions of an App
realtime_kit.sessions.get_sessions(strapp_id, SessionGetSessionsParams**kwargs) -> SessionGetSessionsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions
Fetch details of a session
realtime_kit.sessions.get_session_details(strsession_id, SessionGetSessionDetailsParams**kwargs) -> SessionGetSessionDetailsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}
Fetch participants list of a session
realtime_kit.sessions.get_session_participants(strsession_id, SessionGetSessionParticipantsParams**kwargs) -> SessionGetSessionParticipantsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants
Fetch details of a participant
realtime_kit.sessions.get_session_participant_details(strparticipant_id, SessionGetSessionParticipantDetailsParams**kwargs) -> SessionGetSessionParticipantDetailsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}
Fetch all chat messages of a session
realtime_kit.sessions.get_session_chat(strsession_id, SessionGetSessionChatParams**kwargs) -> SessionGetSessionChatResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat
Fetch the complete transcript for a session
realtime_kit.sessions.get_session_transcripts(strsession_id, SessionGetSessionTranscriptsParams**kwargs) -> SessionGetSessionTranscriptsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript
Fetch summary of transcripts for a session
realtime_kit.sessions.get_session_summary(strsession_id, SessionGetSessionSummaryParams**kwargs) -> SessionGetSessionSummaryResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary
Generate summary of Transcripts for the session
realtime_kit.sessions.generate_summary_of_transcripts(strsession_id, SessionGenerateSummaryOfTranscriptsParams**kwargs) -> SessionGenerateSummaryOfTranscriptsResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary
Fetch details of peer
realtime_kit.sessions.get_participant_data_from_peer_id(strpeer_id, SessionGetParticipantDataFromPeerIDParams**kwargs) -> SessionGetParticipantDataFromPeerIDResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}
ModelsExpand Collapse
class SessionGetSessionsResponse: …
data: Optional[Data]
sessions: Optional[List[DataSession]]
id: str

ID of the session

associated_id: str

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: str

timestamp when session created

live_participants: float

number of participants currently in the session

max_concurrent_participants: float

number of maximum participants that were in the session

meeting_display_name: str

Title of the meeting this session belongs to

minutes_consumed: float

number of minutes consumed since the session started

organization_id: str

App id that hosted this session

started_at: str

timestamp when session started

status: Literal["LIVE", "ENDED"]

current status of session

One of the following:
"LIVE"
"ENDED"
type: Literal["meeting", "livestream", "participant"]

type of session

One of the following:
"meeting"
"livestream"
"participant"
updated_at: str

timestamp when session was last updated

breakout_rooms: Optional[List[object]]
ended_at: Optional[str]

timestamp when session ended

meta: Optional[object]

Any meta data about session.

paging: Optional[Paging]
end_offset: Optional[float]
start_offset: Optional[float]
total_count: Optional[float]
minimum0
success: Optional[bool]
class SessionGetSessionDetailsResponse: …
data: Optional[Data]
id: str

ID of the session

associated_id: str

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: str

timestamp when session created

live_participants: float

number of participants currently in the session

max_concurrent_participants: float

number of maximum participants that were in the session

meeting_display_name: str

Title of the meeting this session belongs to

minutes_consumed: float

number of minutes consumed since the session started

organization_id: str

App id that hosted this session

started_at: str

timestamp when session started

status: Literal["LIVE", "ENDED"]

current status of session

One of the following:
"LIVE"
"ENDED"
type: Literal["meeting", "livestream", "participant"]

type of session

One of the following:
"meeting"
"livestream"
"participant"
updated_at: str

timestamp when session was last updated

breakout_rooms: Optional[List[object]]
ended_at: Optional[str]

timestamp when session ended

meta: Optional[object]

Any meta data about session.

success: Optional[bool]
class SessionGetSessionParticipantsResponse: …
data: Optional[Data]
participants: Optional[List[DataParticipant]]
id: Optional[str]

Participant ID. This maps to the corresponding peerId.

created_at: Optional[str]

timestamp when this participant was created.

custom_participant_id: Optional[str]

ID passed by client to create this participant.

display_name: Optional[str]

Display name of participant when joining the session.

duration: Optional[float]

number of minutes for which the participant was in the session.

joined_at: Optional[str]

timestamp at which participant joined the session.

left_at: Optional[str]

timestamp at which participant left the session.

peer_events: Optional[List[DataParticipantPeerEvent]]

Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true.

id: Optional[str]

ID of the peer event.

created_at: Optional[str]

Timestamp when this peer event was created.

event_name: Optional[Literal["PEER_CREATED", "PEER_JOINING", "PEER_LEAVING"]]

Name of the peer event.

One of the following:
"PEER_CREATED"
"PEER_JOINING"
"PEER_LEAVING"
minutes_consumed: Optional[float]

Minutes consumed attributed to this event.

participant_id: Optional[str]

ID of the participant this event belongs to.

peer_id: Optional[str]

Peer ID this event belongs to.

preset_view_type: Optional[Literal["GROUP_CALL", "WEBINAR", "AUDIO_ROOM", 2 more]]

View type of the preset associated with the peer.

One of the following:
"GROUP_CALL"
"WEBINAR"
"AUDIO_ROOM"
"LIVESTREAM"
"CHAT"
session_id: Optional[str]

ID of the session this event belongs to.

socket_session_id: Optional[str]

ID of the socket session associated with this event.

updated_at: Optional[str]

Timestamp when this peer event was last updated.

preset_name: Optional[str]

Name of the preset associated with the participant.

updated_at: Optional[str]

timestamp when this participant’s data was last updated.

user_id: Optional[str]

User id for this participant.

success: Optional[bool]
class SessionGetSessionParticipantDetailsResponse: …
data: Optional[Data]
participant: Optional[DataParticipant]
id: Optional[str]

Participant ID. This maps to the corresponding peerId.

created_at: Optional[str]

timestamp when this participant was created.

custom_participant_id: Optional[str]

ID passed by client to create this participant.

display_name: Optional[str]

Display name of participant when joining the session.

duration: Optional[float]

number of minutes for which the participant was in the session.

joined_at: Optional[str]

timestamp at which participant joined the session.

left_at: Optional[str]

timestamp at which participant left the session.

peer_events: Optional[List[DataParticipantPeerEvent]]

Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true.

id: Optional[str]

ID of the peer event.

created_at: Optional[str]

Timestamp when this peer event was created.

event_name: Optional[Literal["PEER_CREATED", "PEER_JOINING", "PEER_LEAVING"]]

Name of the peer event.

One of the following:
"PEER_CREATED"
"PEER_JOINING"
"PEER_LEAVING"
minutes_consumed: Optional[float]

Minutes consumed attributed to this event.

participant_id: Optional[str]

ID of the participant this event belongs to.

peer_id: Optional[str]

Peer ID this event belongs to.

preset_view_type: Optional[Literal["GROUP_CALL", "WEBINAR", "AUDIO_ROOM", 2 more]]

View type of the preset associated with the peer.

One of the following:
"GROUP_CALL"
"WEBINAR"
"AUDIO_ROOM"
"LIVESTREAM"
"CHAT"
session_id: Optional[str]

ID of the session this event belongs to.

socket_session_id: Optional[str]

ID of the socket session associated with this event.

updated_at: Optional[str]

Timestamp when this peer event was last updated.

preset_name: Optional[str]

Name of the preset associated with the participant.

updated_at: Optional[str]

timestamp when this participant’s data was last updated.

user_id: Optional[str]

User id for this participant.

success: Optional[bool]
class SessionGetSessionChatResponse: …
data: Optional[Data]
chat_download_url: str

URL where the chat logs can be downloaded

chat_download_url_expiry: str

Time when the download URL will expire

success: Optional[bool]
class SessionGetSessionTranscriptsResponse: …
data: Optional[Data]
session_id: str
transcript_download_url: str

URL where the transcript can be downloaded

transcript_download_url_expiry: str

Time when the download URL will expire

success: Optional[bool]
class SessionGetSessionSummaryResponse: …
data: Optional[Data]
session_id: str
summary_download_url: str

URL where the summary of transcripts can be downloaded

summary_download_url_expiry: str

Time of Expiry before when you need to download the csv file.

success: Optional[bool]
class SessionGenerateSummaryOfTranscriptsResponse: …
data: Optional[Data]
session_id: Optional[str]
formatuuid
status: Optional[str]
success: Optional[bool]
class SessionGetParticipantDataFromPeerIDResponse: …
data: Optional[Data]
participant: Optional[DataParticipant]
id: Optional[str]

ID of the participant.

formatuuid
created_at: Optional[str]

timestamp when this participant was created.

custom_participant_id: Optional[str]

ID passed by client to create this participant.

display_name: Optional[str]

Display name of participant when joining the session.

duration: Optional[float]

number of minutes for which the participant was in the session.

joined_at: Optional[str]

timestamp at which participant joined the session.

left_at: Optional[str]

timestamp at which participant left the session.

peer_events: Optional[List[DataParticipantPeerEvent]]

Connection lifecycle events for the participant’s peer.

id: Optional[str]

ID of the peer event.

created_at: Optional[str]

Timestamp when this peer event was created.

event_name: Optional[Literal["PEER_CREATED", "PEER_JOINING", "PEER_LEAVING"]]

Name of the peer event.

One of the following:
"PEER_CREATED"
"PEER_JOINING"
"PEER_LEAVING"
minutes_consumed: Optional[float]

Minutes consumed attributed to this event.

participant_id: Optional[str]

ID of the participant this event belongs to.

peer_id: Optional[str]

Peer ID this event belongs to.

preset_view_type: Optional[Literal["GROUP_CALL", "WEBINAR", "AUDIO_ROOM", 2 more]]

View type of the preset associated with the peer.

One of the following:
"GROUP_CALL"
"WEBINAR"
"AUDIO_ROOM"
"LIVESTREAM"
"CHAT"
session_id: Optional[str]

ID of the session this event belongs to.

socket_session_id: Optional[str]

ID of the socket session associated with this event.

updated_at: Optional[str]

Timestamp when this peer event was last updated.

peer_report: Optional[DataParticipantPeerReport]

Peer call statistics report.

metadata: Optional[DataParticipantPeerReportMetadata]

Connection and device metadata for the participant.

audio_devices_updates: Optional[List[DataParticipantPeerReportMetadataAudioDevicesUpdate]]
added: Optional[List[DataParticipantPeerReportMetadataAudioDevicesUpdateAdded]]

Devices that became available.

device_id: Optional[str]

ID of the device.

kind: Optional[str]

Kind of device, for example audioinput or videoinput.

label: Optional[str]

Human-readable label of the device.

removed: Optional[List[DataParticipantPeerReportMetadataAudioDevicesUpdateRemoved]]

Devices that became unavailable.

device_id: Optional[str]

ID of the device.

kind: Optional[str]

Kind of device, for example audioinput or videoinput.

label: Optional[str]

Human-readable label of the device.

timestamp: Optional[str]

Timestamp of the device update.

browser_metadata: Optional[DataParticipantPeerReportMetadataBrowserMetadata]
browser: Optional[str]
browser_version: Optional[str]
engine: Optional[str]
user_agent: Optional[str]
webgl_support: Optional[bool]
candidate_pairs: Optional[DataParticipantPeerReportMetadataCandidatePairs]
consuming_transport: Optional[List[DataParticipantPeerReportMetadataCandidatePairsConsumingTransport]]
available_incoming_bitrate: Optional[float]
available_outgoing_bitrate: Optional[float]
bytes_discarded_on_send: Optional[float]
bytes_received: Optional[float]
bytes_sent: Optional[float]
current_round_trip_time: Optional[float]
last_packet_received_timestamp: Optional[float]

Epoch milliseconds when the last packet was received.

last_packet_sent_timestamp: Optional[float]

Epoch milliseconds when the last packet was sent.

local_candidate_address: Optional[str]
local_candidate_id: Optional[str]
local_candidate_network_type: Optional[str]
local_candidate_port: Optional[float]
local_candidate_protocol: Optional[str]
local_candidate_type: Optional[str]
local_candidate_url: Optional[str]
nominated: Optional[bool]
packets_discarded_on_send: Optional[float]
packets_received: Optional[float]
packets_sent: Optional[float]
remote_candidate_address: Optional[str]
remote_candidate_id: Optional[str]
remote_candidate_port: Optional[float]
remote_candidate_protocol: Optional[str]
remote_candidate_type: Optional[str]
remote_candidate_url: Optional[str]
total_round_trip_time: Optional[float]
producing_transport: Optional[List[DataParticipantPeerReportMetadataCandidatePairsProducingTransport]]
available_incoming_bitrate: Optional[float]
available_outgoing_bitrate: Optional[float]
bytes_discarded_on_send: Optional[float]
bytes_received: Optional[float]
bytes_sent: Optional[float]
current_round_trip_time: Optional[float]
last_packet_received_timestamp: Optional[float]

Epoch milliseconds when the last packet was received.

last_packet_sent_timestamp: Optional[float]

Epoch milliseconds when the last packet was sent.

local_candidate_address: Optional[str]
local_candidate_id: Optional[str]
local_candidate_network_type: Optional[str]
local_candidate_port: Optional[float]
local_candidate_protocol: Optional[str]
local_candidate_type: Optional[str]
local_candidate_url: Optional[str]
nominated: Optional[bool]
packets_discarded_on_send: Optional[float]
packets_received: Optional[float]
packets_sent: Optional[float]
remote_candidate_address: Optional[str]
remote_candidate_id: Optional[str]
remote_candidate_port: Optional[float]
remote_candidate_protocol: Optional[str]
remote_candidate_type: Optional[str]
remote_candidate_url: Optional[str]
total_round_trip_time: Optional[float]
device_info: Optional[DataParticipantPeerReportMetadataDeviceInfo]
cpus: Optional[float]
is_mobile: Optional[bool]
os: Optional[str]
os_version: Optional[str]
events: Optional[List[DataParticipantPeerReportMetadataEvent]]
metadata: Optional[Dict[str, object]]

Event-specific metadata. Keys vary per event; values are primitive scalars (string, number, boolean, or null).

name: Optional[str]

Name of the event.

timestamp: Optional[str]

Timestamp when the event occurred.

ip_information: Optional[DataParticipantPeerReportMetadataIPInformation]
asn: Optional[DataParticipantPeerReportMetadataIPInformationASN]
asn: Optional[str]
domain: Optional[str]
name: Optional[str]
route: Optional[str]
type: Optional[str]
city: Optional[str]
country: Optional[str]
ipv4: Optional[str]
org: Optional[str]
region: Optional[str]
timezone: Optional[str]
native_metadata: Optional[DataParticipantPeerReportMetadataNativeMetadata]
audio_encoder: Optional[str]
video_encoder: Optional[str]
pc_metadata: Optional[List[DataParticipantPeerReportMetadataPcMetadata]]
effective_network_type: Optional[str]
reflexive_connectivity: Optional[bool]
relay_connectivity: Optional[bool]
sdp: Optional[List[str]]
timestamp: Optional[str]
turn_connectivity: Optional[bool]
room_view_type: Optional[str]
sdk_name: Optional[str]
sdk_type: Optional[str]
sdk_version: Optional[str]
selected_device_updates: Optional[List[DataParticipantPeerReportMetadataSelectedDeviceUpdate]]
device: Optional[DataParticipantPeerReportMetadataSelectedDeviceUpdateDevice]

A media device (camera, microphone, or speaker).

device_id: Optional[str]

ID of the device.

kind: Optional[str]

Kind of device, for example audioinput or videoinput.

label: Optional[str]

Human-readable label of the device.

timestamp: Optional[str]
speaker_devices_updates: Optional[List[DataParticipantPeerReportMetadataSpeakerDevicesUpdate]]
added: Optional[List[DataParticipantPeerReportMetadataSpeakerDevicesUpdateAdded]]

Devices that became available.

device_id: Optional[str]

ID of the device.

kind: Optional[str]

Kind of device, for example audioinput or videoinput.

label: Optional[str]

Human-readable label of the device.

removed: Optional[List[DataParticipantPeerReportMetadataSpeakerDevicesUpdateRemoved]]

Devices that became unavailable.

device_id: Optional[str]

ID of the device.

kind: Optional[str]

Kind of device, for example audioinput or videoinput.

label: Optional[str]

Human-readable label of the device.

timestamp: Optional[str]

Timestamp of the device update.

video_devices_updates: Optional[List[DataParticipantPeerReportMetadataVideoDevicesUpdate]]
added: Optional[List[DataParticipantPeerReportMetadataVideoDevicesUpdateAdded]]

Devices that became available.

device_id: Optional[str]

ID of the device.

kind: Optional[str]

Kind of device, for example audioinput or videoinput.

label: Optional[str]

Human-readable label of the device.

removed: Optional[List[DataParticipantPeerReportMetadataVideoDevicesUpdateRemoved]]

Devices that became unavailable.

device_id: Optional[str]

ID of the device.

kind: Optional[str]

Kind of device, for example audioinput or videoinput.

label: Optional[str]

Human-readable label of the device.

timestamp: Optional[str]

Timestamp of the device update.

quality: Optional[DataParticipantPeerReportQuality]

Media quality statistics for the participant.

audio_consumer: Optional[List[DataParticipantPeerReportQualityAudioConsumer]]
bytes_received: Optional[float]
concealment_events: Optional[float]
consumer_id: Optional[str]
jitter: Optional[float]
jitter_buffer_delay: Optional[float]
jitter_buffer_emitted_count: Optional[float]
mid: Optional[str]
mos_quality: Optional[float]
packets_lost: Optional[float]
packets_received: Optional[float]
peer_id: Optional[str]
producer_id: Optional[str]
ssrc: Optional[float]
timestamp: Optional[str]
audio_consumer_cumulative: Optional[DataParticipantPeerReportQualityAudioConsumerCumulative]

Aggregated inbound (consumer) audio statistics for the session.

jitter_buffer_delay: Optional[DataParticipantPeerReportQualityAudioConsumerCumulativeJitterBufferDelay]

Cumulative latency distribution (milliseconds-based thresholds).

_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
packet_loss: Optional[DataParticipantPeerReportQualityAudioConsumerCumulativePacketLoss]

Cumulative packet loss distribution.

_10_or_greater_event_fraction: Optional[float]
_25_or_greater_event_fraction: Optional[float]
_5_or_greater_event_fraction: Optional[float]
_50_or_greater_event_fraction: Optional[float]
avg: Optional[float]
quality_mos: Optional[DataParticipantPeerReportQualityAudioConsumerCumulativeQualityMos]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
audio_producer: Optional[List[DataParticipantPeerReportQualityAudioProducer]]
bytes_sent: Optional[float]
jitter: Optional[float]
mid: Optional[str]
mos_quality: Optional[float]
packets_lost: Optional[float]
packets_sent: Optional[float]
producer_id: Optional[str]
rtt: Optional[float]
ssrc: Optional[float]
timestamp: Optional[str]
audio_producer_cumulative: Optional[DataParticipantPeerReportQualityAudioProducerCumulative]

Aggregated outbound (producer) audio statistics for the session.

packet_loss: Optional[DataParticipantPeerReportQualityAudioProducerCumulativePacketLoss]

Cumulative packet loss distribution.

_10_or_greater_event_fraction: Optional[float]
_25_or_greater_event_fraction: Optional[float]
_5_or_greater_event_fraction: Optional[float]
_50_or_greater_event_fraction: Optional[float]
avg: Optional[float]
quality_mos: Optional[DataParticipantPeerReportQualityAudioProducerCumulativeQualityMos]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
rtt: Optional[DataParticipantPeerReportQualityAudioProducerCumulativeRTT]

Cumulative latency distribution (milliseconds-based thresholds).

_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
screenshare_audio_consumer: Optional[List[DataParticipantPeerReportQualityScreenshareAudioConsumer]]
bytes_received: Optional[float]
concealment_events: Optional[float]
consumer_id: Optional[str]
jitter: Optional[float]
jitter_buffer_delay: Optional[float]
jitter_buffer_emitted_count: Optional[float]
mid: Optional[str]
mos_quality: Optional[float]
packets_lost: Optional[float]
packets_received: Optional[float]
peer_id: Optional[str]
producer_id: Optional[str]
ssrc: Optional[float]
timestamp: Optional[str]
screenshare_audio_consumer_cumulative: Optional[DataParticipantPeerReportQualityScreenshareAudioConsumerCumulative]

Aggregated inbound (consumer) audio statistics for the session.

jitter_buffer_delay: Optional[DataParticipantPeerReportQualityScreenshareAudioConsumerCumulativeJitterBufferDelay]

Cumulative latency distribution (milliseconds-based thresholds).

_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
packet_loss: Optional[DataParticipantPeerReportQualityScreenshareAudioConsumerCumulativePacketLoss]

Cumulative packet loss distribution.

_10_or_greater_event_fraction: Optional[float]
_25_or_greater_event_fraction: Optional[float]
_5_or_greater_event_fraction: Optional[float]
_50_or_greater_event_fraction: Optional[float]
avg: Optional[float]
quality_mos: Optional[DataParticipantPeerReportQualityScreenshareAudioConsumerCumulativeQualityMos]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
screenshare_audio_producer: Optional[List[DataParticipantPeerReportQualityScreenshareAudioProducer]]
bytes_sent: Optional[float]
jitter: Optional[float]
mid: Optional[str]
mos_quality: Optional[float]
packets_lost: Optional[float]
packets_sent: Optional[float]
producer_id: Optional[str]
rtt: Optional[float]
ssrc: Optional[float]
timestamp: Optional[str]
screenshare_audio_producer_cumulative: Optional[DataParticipantPeerReportQualityScreenshareAudioProducerCumulative]

Aggregated outbound (producer) audio statistics for the session.

packet_loss: Optional[DataParticipantPeerReportQualityScreenshareAudioProducerCumulativePacketLoss]

Cumulative packet loss distribution.

_10_or_greater_event_fraction: Optional[float]
_25_or_greater_event_fraction: Optional[float]
_5_or_greater_event_fraction: Optional[float]
_50_or_greater_event_fraction: Optional[float]
avg: Optional[float]
quality_mos: Optional[DataParticipantPeerReportQualityScreenshareAudioProducerCumulativeQualityMos]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
rtt: Optional[DataParticipantPeerReportQualityScreenshareAudioProducerCumulativeRTT]

Cumulative latency distribution (milliseconds-based thresholds).

_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
screenshare_video_consumer: Optional[List[DataParticipantPeerReportQualityScreenshareVideoConsumer]]
bytes_received: Optional[float]
consumer_id: Optional[str]
fir_count: Optional[float]
frame_height: Optional[float]
frame_width: Optional[float]
frames_decoded: Optional[float]
frames_dropped: Optional[float]
frames_per_second: Optional[float]
jitter: Optional[float]
jitter_buffer_delay: Optional[float]
jitter_buffer_emitted_count: Optional[float]
key_frames_decoded: Optional[float]
mid: Optional[str]
mos_quality: Optional[float]
packets_lost: Optional[float]
packets_received: Optional[float]
peer_id: Optional[str]
producer_id: Optional[str]
ssrc: Optional[float]
timestamp: Optional[str]
screenshare_video_consumer_cumulative: Optional[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulative]

Aggregated inbound (consumer) video statistics for the session.

frame_per_second: Optional[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeFramePerSecond]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
frame_width: Optional[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeFrameWidth]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
issues: Optional[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeIssues]
lag_fraction: Optional[float]
no_video_fraction: Optional[float]
poor_resolution_fraction: Optional[float]
jitter_buffer_delay: Optional[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeJitterBufferDelay]

Cumulative latency distribution (milliseconds-based thresholds).

_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
key_frames_decoded_fraction: Optional[float]
packet_loss: Optional[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativePacketLoss]

Cumulative packet loss distribution.

_10_or_greater_event_fraction: Optional[float]
_25_or_greater_event_fraction: Optional[float]
_5_or_greater_event_fraction: Optional[float]
_50_or_greater_event_fraction: Optional[float]
avg: Optional[float]
quality_mos: Optional[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeQualityMos]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
screenshare_video_producer: Optional[List[DataParticipantPeerReportQualityScreenshareVideoProducer]]
bytes_sent: Optional[float]
fir_count: Optional[float]
frame_height: Optional[float]
frame_width: Optional[float]
frames_encoded: Optional[float]
frames_per_second: Optional[float]
jitter: Optional[float]
key_frames_encoded: Optional[float]
mid: Optional[str]
mos_quality: Optional[float]
packets_lost: Optional[float]
packets_sent: Optional[float]
pli_count: Optional[float]
producer_id: Optional[str]
quality_limitation_durations: Optional[DataParticipantPeerReportQualityScreenshareVideoProducerQualityLimitationDurations]
bandwidth: Optional[float]
cpu: Optional[float]
none: Optional[float]
other: Optional[float]
quality_limitation_reason: Optional[Literal["cpu", "bandwidth", "none", "other"]]
One of the following:
"cpu"
"bandwidth"
"none"
"other"
quality_limitation_resolution_changes: Optional[float]
rtt: Optional[float]
ssrc: Optional[float]
timestamp: Optional[str]
screenshare_video_producer_cumulative: Optional[DataParticipantPeerReportQualityScreenshareVideoProducerCumulative]

Aggregated outbound (producer) video statistics for the session.

frame_per_second: Optional[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeFramePerSecond]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
frame_width: Optional[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeFrameWidth]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
high_negative_feedback_fraction: Optional[float]
issues: Optional[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeIssues]
bandwidth_quality_limitation_fraction: Optional[float]
cpu_quality_limitation_fraction: Optional[float]
no_video_fraction: Optional[float]
poor_resolution_fraction: Optional[float]
quality_limitation_fraction: Optional[float]
key_frames_encoded_fraction: Optional[float]
packet_loss: Optional[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativePacketLoss]

Cumulative packet loss distribution.

_10_or_greater_event_fraction: Optional[float]
_25_or_greater_event_fraction: Optional[float]
_5_or_greater_event_fraction: Optional[float]
_50_or_greater_event_fraction: Optional[float]
avg: Optional[float]
quality_mos: Optional[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeQualityMos]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
rtt: Optional[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeRTT]

Cumulative latency distribution (milliseconds-based thresholds).

_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
video_consumer: Optional[List[DataParticipantPeerReportQualityVideoConsumer]]
bytes_received: Optional[float]
consumer_id: Optional[str]
fir_count: Optional[float]
frame_height: Optional[float]
frame_width: Optional[float]
frames_decoded: Optional[float]
frames_dropped: Optional[float]
frames_per_second: Optional[float]
jitter: Optional[float]
jitter_buffer_delay: Optional[float]
jitter_buffer_emitted_count: Optional[float]
key_frames_decoded: Optional[float]
mid: Optional[str]
mos_quality: Optional[float]
packets_lost: Optional[float]
packets_received: Optional[float]
peer_id: Optional[str]
producer_id: Optional[str]
ssrc: Optional[float]
timestamp: Optional[str]
video_consumer_cumulative: Optional[DataParticipantPeerReportQualityVideoConsumerCumulative]

Aggregated inbound (consumer) video statistics for the session.

frame_per_second: Optional[DataParticipantPeerReportQualityVideoConsumerCumulativeFramePerSecond]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
frame_width: Optional[DataParticipantPeerReportQualityVideoConsumerCumulativeFrameWidth]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
issues: Optional[DataParticipantPeerReportQualityVideoConsumerCumulativeIssues]
lag_fraction: Optional[float]
no_video_fraction: Optional[float]
poor_resolution_fraction: Optional[float]
jitter_buffer_delay: Optional[DataParticipantPeerReportQualityVideoConsumerCumulativeJitterBufferDelay]

Cumulative latency distribution (milliseconds-based thresholds).

_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
key_frames_decoded_fraction: Optional[float]
packet_loss: Optional[DataParticipantPeerReportQualityVideoConsumerCumulativePacketLoss]

Cumulative packet loss distribution.

_10_or_greater_event_fraction: Optional[float]
_25_or_greater_event_fraction: Optional[float]
_5_or_greater_event_fraction: Optional[float]
_50_or_greater_event_fraction: Optional[float]
avg: Optional[float]
quality_mos: Optional[DataParticipantPeerReportQualityVideoConsumerCumulativeQualityMos]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
video_producer: Optional[List[DataParticipantPeerReportQualityVideoProducer]]
bytes_sent: Optional[float]
fir_count: Optional[float]
frame_height: Optional[float]
frame_width: Optional[float]
frames_encoded: Optional[float]
frames_per_second: Optional[float]
jitter: Optional[float]
key_frames_encoded: Optional[float]
mid: Optional[str]
mos_quality: Optional[float]
packets_lost: Optional[float]
packets_sent: Optional[float]
pli_count: Optional[float]
producer_id: Optional[str]
quality_limitation_durations: Optional[DataParticipantPeerReportQualityVideoProducerQualityLimitationDurations]
bandwidth: Optional[float]
cpu: Optional[float]
none: Optional[float]
other: Optional[float]
quality_limitation_reason: Optional[Literal["cpu", "bandwidth", "none", "other"]]
One of the following:
"cpu"
"bandwidth"
"none"
"other"
quality_limitation_resolution_changes: Optional[float]
rtt: Optional[float]
ssrc: Optional[float]
timestamp: Optional[str]
video_producer_cumulative: Optional[DataParticipantPeerReportQualityVideoProducerCumulative]

Aggregated outbound (producer) video statistics for the session.

frame_per_second: Optional[DataParticipantPeerReportQualityVideoProducerCumulativeFramePerSecond]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
frame_width: Optional[DataParticipantPeerReportQualityVideoProducerCumulativeFrameWidth]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
high_negative_feedback_fraction: Optional[float]
issues: Optional[DataParticipantPeerReportQualityVideoProducerCumulativeIssues]
bandwidth_quality_limitation_fraction: Optional[float]
cpu_quality_limitation_fraction: Optional[float]
no_video_fraction: Optional[float]
poor_resolution_fraction: Optional[float]
quality_limitation_fraction: Optional[float]
key_frames_encoded_fraction: Optional[float]
packet_loss: Optional[DataParticipantPeerReportQualityVideoProducerCumulativePacketLoss]

Cumulative packet loss distribution.

_10_or_greater_event_fraction: Optional[float]
_25_or_greater_event_fraction: Optional[float]
_5_or_greater_event_fraction: Optional[float]
_50_or_greater_event_fraction: Optional[float]
avg: Optional[float]
quality_mos: Optional[DataParticipantPeerReportQualityVideoProducerCumulativeQualityMos]

Distribution summary with average and percentiles.

avg: Optional[float]
p50: Optional[float]
p75: Optional[float]
p90: Optional[float]
rtt: Optional[DataParticipantPeerReportQualityVideoProducerCumulativeRTT]

Cumulative latency distribution (milliseconds-based thresholds).

_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
role: Optional[str]

Name of the preset associated with the participant.

session_id: Optional[str]
formatuuid
updated_at: Optional[str]

timestamp when this participant’s data was last updated.

user_id: Optional[str]

User id for this participant.

success: Optional[bool]