API Reference

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

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions

Fetch details of a session

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}

Fetch participants list of a session

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants

Fetch details of a participant

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}

Fetch all chat messages of a session

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat

Fetch the complete transcript for a session

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript

Fetch summary of transcripts for a session

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Generate summary of Transcripts for the session

POST/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Fetch details of peer

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}

ModelsExpand Collapse

SessionGetSessionsResponse object { data, paging, success }

data: optional object { sessions }

sessions: optional array of object { id, associated_id, created_at, 11 more }

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" or "ENDED"

current status of session

One of the following:

"LIVE"

"ENDED"

type: "meeting" or "livestream" or "participant"

type of session

One of the following:

"meeting"

"livestream"

"participant"

updated_at: string

timestamp when session was last updated

breakout_rooms: optional array of unknown

ended_at: optional string

timestamp when session ended

paging: optional object { end_offset, start_offset, total_count }

end_offset: optional number

start_offset: optional number

total_count: optional number

minimum0

success: optional boolean

SessionGetSessionDetailsResponse object { data, success }

data: optional object { id, associated_id, created_at, 11 more }

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" or "ENDED"

current status of session

One of the following:

"LIVE"

"ENDED"

type: "meeting" or "livestream" or "participant"

type of session

One of the following:

"meeting"

"livestream"

"participant"

updated_at: string

timestamp when session was last updated

breakout_rooms: optional array of unknown

ended_at: optional string

timestamp when session ended

success: optional boolean

SessionGetSessionParticipantsResponse object { data, success }

data: optional object { participants }

participants: optional array of object { id, created_at, custom_participant_id, 8 more }

id: optional string

Participant ID. This maps to the corresponding peerId.

created_at: optional string

timestamp when this participant was created.

custom_participant_id: optional string

ID passed by client to create this participant.

display_name: optional string

Display name of participant when joining the session.

duration: optional number

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

joined_at: optional string

timestamp at which participant joined the session.

left_at: optional string

timestamp at which participant left the session.

peer_events: optional array of object { id, created_at, event_name, 7 more }

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

id: optional string

ID of the peer event.

created_at: optional string

Timestamp when this peer event was created.

event_name: optional "PEER_CREATED" or "PEER_JOINING" or "PEER_LEAVING"

Name of the peer event.

One of the following:

"PEER_CREATED"

"PEER_JOINING"

"PEER_LEAVING"

minutes_consumed: optional number

Minutes consumed attributed to this event.

participant_id: optional string

ID of the participant this event belongs to.

peer_id: optional string

Peer ID this event belongs to.

preset_view_type: optional "GROUP_CALL" or "WEBINAR" or "AUDIO_ROOM" or 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 string

ID of the session this event belongs to.

socket_session_id: optional string

ID of the socket session associated with this event.

updated_at: optional string

Timestamp when this peer event was last updated.

preset_name: optional string

Name of the preset associated with the participant.

updated_at: optional string

timestamp when this participant’s data was last updated.

user_id: optional string

User id for this participant.

success: optional boolean

SessionGetSessionParticipantDetailsResponse object { data, success }

data: optional object { participant }

participant: optional object { id, created_at, custom_participant_id, 8 more }

id: optional string

Participant ID. This maps to the corresponding peerId.

created_at: optional string

timestamp when this participant was created.

custom_participant_id: optional string

ID passed by client to create this participant.

display_name: optional string

Display name of participant when joining the session.

duration: optional number

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

joined_at: optional string

timestamp at which participant joined the session.

left_at: optional string

timestamp at which participant left the session.

peer_events: optional array of object { id, created_at, event_name, 7 more }

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

id: optional string

ID of the peer event.

created_at: optional string

Timestamp when this peer event was created.

event_name: optional "PEER_CREATED" or "PEER_JOINING" or "PEER_LEAVING"

Name of the peer event.

One of the following:

"PEER_CREATED"

"PEER_JOINING"

"PEER_LEAVING"

minutes_consumed: optional number

Minutes consumed attributed to this event.

participant_id: optional string

ID of the participant this event belongs to.

peer_id: optional string

Peer ID this event belongs to.

preset_view_type: optional "GROUP_CALL" or "WEBINAR" or "AUDIO_ROOM" or 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 string

ID of the session this event belongs to.

socket_session_id: optional string

ID of the socket session associated with this event.

updated_at: optional string

Timestamp when this peer event was last updated.

preset_name: optional string

Name of the preset associated with the participant.

updated_at: optional string

timestamp when this participant’s data was last updated.

user_id: optional string

User id for this participant.

success: optional boolean

SessionGetSessionChatResponse object { data, success }

data: optional object { chat_download_url, chat_download_url_expiry }

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: optional boolean

SessionGetSessionTranscriptsResponse object { data, success }

data: optional object { sessionId, transcript_download_url, transcript_download_url_expiry }

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: optional boolean

SessionGetSessionSummaryResponse object { data, success }

data: optional object { sessionId, summaryDownloadUrl, summaryDownloadUrlExpiry }

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: optional boolean

SessionGenerateSummaryOfTranscriptsResponse object { data, success }

data: optional object { session_id, status }

session_id: optional string

formatuuid

status: optional string

success: optional boolean

SessionGetParticipantDataFromPeerIDResponse object { data, success }

data: optional object { participant }

participant: optional object { id, created_at, custom_participant_id, 10 more }

id: optional string

ID of the participant.

formatuuid

created_at: optional string

timestamp when this participant was created.

custom_participant_id: optional string

ID passed by client to create this participant.

display_name: optional string

Display name of participant when joining the session.

duration: optional number

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

joined_at: optional string

timestamp at which participant joined the session.

left_at: optional string

timestamp at which participant left the session.

peer_events: optional array of object { id, created_at, event_name, 7 more }

Connection lifecycle events for the participant’s peer.

id: optional string

ID of the peer event.

created_at: optional string

Timestamp when this peer event was created.

event_name: optional "PEER_CREATED" or "PEER_JOINING" or "PEER_LEAVING"

Name of the peer event.

One of the following:

"PEER_CREATED"

"PEER_JOINING"

"PEER_LEAVING"

minutes_consumed: optional number

Minutes consumed attributed to this event.

participant_id: optional string

ID of the participant this event belongs to.

peer_id: optional string

Peer ID this event belongs to.

preset_view_type: optional "GROUP_CALL" or "WEBINAR" or "AUDIO_ROOM" or 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 string

ID of the session this event belongs to.

socket_session_id: optional string

ID of the socket session associated with this event.

updated_at: optional string

Timestamp when this peer event was last updated.

peer_report: optional object { metadata, quality }

Peer call statistics report.

metadata: optional object { audio_devices_updates, browser_metadata, candidate_pairs, 12 more }

Connection and device metadata for the participant.

audio_devices_updates: optional array of object { added, removed, timestamp }

added: optional array of object { device_id, kind, label }

Devices that became available.

device_id: optional string

ID of the device.

kind: optional string

Kind of device, for example audioinput or videoinput.

label: optional string

Human-readable label of the device.

removed: optional array of object { device_id, kind, label }

Devices that became unavailable.

device_id: optional string

ID of the device.

kind: optional string

Kind of device, for example audioinput or videoinput.

label: optional string

Human-readable label of the device.

timestamp: optional string

Timestamp of the device update.

browser_metadata: optional object { browser, browser_version, engine, 2 more }

browser: optional string

browser_version: optional string

engine: optional string

user_agent: optional string

webgl_support: optional boolean

candidate_pairs: optional object { consuming_transport, producing_transport }

consuming_transport: optional array of object { available_incoming_bitrate, available_outgoing_bitrate, bytes_discarded_on_send, 25 more }

available_incoming_bitrate: optional number

available_outgoing_bitrate: optional number

bytes_discarded_on_send: optional number

bytes_received: optional number

bytes_sent: optional number

current_round_trip_time: optional number

last_packet_received_timestamp: optional number

Epoch milliseconds when the last packet was received.

last_packet_sent_timestamp: optional number

Epoch milliseconds when the last packet was sent.

local_candidate_address: optional string

local_candidate_id: optional string

local_candidate_network_type: optional string

local_candidate_port: optional number

local_candidate_protocol: optional string

local_candidate_related_address: optional string

local_candidate_related_port: optional number

local_candidate_type: optional string

local_candidate_url: optional string

nominated: optional boolean

packets_discarded_on_send: optional number

packets_received: optional number

packets_sent: optional number

remote_candidate_address: optional string

remote_candidate_id: optional string

remote_candidate_port: optional number

remote_candidate_protocol: optional string

remote_candidate_type: optional string

remote_candidate_url: optional string

total_round_trip_time: optional number

producing_transport: optional array of object { available_incoming_bitrate, available_outgoing_bitrate, bytes_discarded_on_send, 25 more }

available_incoming_bitrate: optional number

available_outgoing_bitrate: optional number

bytes_discarded_on_send: optional number

bytes_received: optional number

bytes_sent: optional number

current_round_trip_time: optional number

last_packet_received_timestamp: optional number

Epoch milliseconds when the last packet was received.

last_packet_sent_timestamp: optional number

Epoch milliseconds when the last packet was sent.

local_candidate_address: optional string

local_candidate_id: optional string

local_candidate_network_type: optional string

local_candidate_port: optional number

local_candidate_protocol: optional string

local_candidate_related_address: optional string

local_candidate_related_port: optional number

local_candidate_type: optional string

local_candidate_url: optional string

nominated: optional boolean

packets_discarded_on_send: optional number

packets_received: optional number

packets_sent: optional number

remote_candidate_address: optional string

remote_candidate_id: optional string

remote_candidate_port: optional number

remote_candidate_protocol: optional string

remote_candidate_type: optional string

remote_candidate_url: optional string

total_round_trip_time: optional number

device_info: optional object { cpus, is_mobile, os, os_version }

cpus: optional number

is_mobile: optional boolean

os: optional string

os_version: optional string

events: optional array of object { metadata, name, timestamp }

metadata: optional map[string or number or boolean]

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

One of the following:

string

number

boolean

name: optional string

Name of the event.

timestamp: optional string

Timestamp when the event occurred.

ip_information: optional object { asn, city, country, 4 more }

asn: optional object { asn, domain, name, 2 more }

asn: optional string

domain: optional string

name: optional string

route: optional string

type: optional string

city: optional string

country: optional string

ipv4: optional string

org: optional string

region: optional string

timezone: optional string

native_metadata: optional object { audio_encoder, video_encoder }

audio_encoder: optional string

video_encoder: optional string

pc_metadata: optional array of object { effective_network_type, reflexive_connectivity, relay_connectivity, 3 more }

effective_network_type: optional string

reflexive_connectivity: optional boolean

relay_connectivity: optional boolean

sdp: optional array of string

timestamp: optional string

turn_connectivity: optional boolean

room_view_type: optional string

sdk_name: optional string

sdk_type: optional string

sdk_version: optional string

selected_device_updates: optional array of object { device, timestamp }

device: optional object { device_id, kind, label }

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

device_id: optional string

ID of the device.

kind: optional string

Kind of device, for example audioinput or videoinput.

label: optional string

Human-readable label of the device.

timestamp: optional string

speaker_devices_updates: optional array of object { added, removed, timestamp }

added: optional array of object { device_id, kind, label }

Devices that became available.

device_id: optional string

ID of the device.

kind: optional string

Kind of device, for example audioinput or videoinput.

label: optional string

Human-readable label of the device.

removed: optional array of object { device_id, kind, label }

Devices that became unavailable.

device_id: optional string

ID of the device.

kind: optional string

Kind of device, for example audioinput or videoinput.

label: optional string

Human-readable label of the device.

timestamp: optional string

Timestamp of the device update.

video_devices_updates: optional array of object { added, removed, timestamp }

added: optional array of object { device_id, kind, label }

Devices that became available.

device_id: optional string

ID of the device.

kind: optional string

Kind of device, for example audioinput or videoinput.

label: optional string

Human-readable label of the device.

removed: optional array of object { device_id, kind, label }

Devices that became unavailable.

device_id: optional string

ID of the device.

kind: optional string

Kind of device, for example audioinput or videoinput.

label: optional string

Human-readable label of the device.

timestamp: optional string

Timestamp of the device update.

quality: optional object { audio_consumer, audio_consumer_cumulative, audio_producer, 13 more }

Media quality statistics for the participant.

audio_consumer: optional array of object { bytes_received, concealment_events, consumer_id, 11 more }

bytes_received: optional number

concealment_events: optional number

consumer_id: optional string

jitter: optional number

jitter_buffer_delay: optional number

jitter_buffer_emitted_count: optional number

mid: optional string

mos_quality: optional number

packets_lost: optional number

packets_received: optional number

peer_id: optional string

producer_id: optional string

ssrc: optional number

timestamp: optional string

audio_consumer_cumulative: optional object { jitter_buffer_delay, packet_loss, quality_mos }

Aggregated inbound (consumer) audio statistics for the session.

jitter_buffer_delay: optional object { "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": optional number

"250ms_or_greater_event_fraction": optional number

"500ms_or_greater_event_fraction": optional number

avg: optional number

packet_loss: optional object { "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": optional number

"25_or_greater_event_fraction": optional number

"5_or_greater_event_fraction": optional number

"50_or_greater_event_fraction": optional number

avg: optional number

quality_mos: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

audio_producer: optional array of object { bytes_sent, jitter, mid, 7 more }

bytes_sent: optional number

jitter: optional number

mid: optional string

mos_quality: optional number

packets_lost: optional number

packets_sent: optional number

producer_id: optional string

rtt: optional number

ssrc: optional number

timestamp: optional string

audio_producer_cumulative: optional object { packet_loss, quality_mos, rtt }

Aggregated outbound (producer) audio statistics for the session.

packet_loss: optional object { "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": optional number

"25_or_greater_event_fraction": optional number

"5_or_greater_event_fraction": optional number

"50_or_greater_event_fraction": optional number

avg: optional number

quality_mos: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

rtt: optional object { "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": optional number

"250ms_or_greater_event_fraction": optional number

"500ms_or_greater_event_fraction": optional number

avg: optional number

screenshare_audio_consumer: optional array of object { bytes_received, concealment_events, consumer_id, 11 more }

bytes_received: optional number

concealment_events: optional number

consumer_id: optional string

jitter: optional number

jitter_buffer_delay: optional number

jitter_buffer_emitted_count: optional number

mid: optional string

mos_quality: optional number

packets_lost: optional number

packets_received: optional number

peer_id: optional string

producer_id: optional string

ssrc: optional number

timestamp: optional string

screenshare_audio_consumer_cumulative: optional object { jitter_buffer_delay, packet_loss, quality_mos }

Aggregated inbound (consumer) audio statistics for the session.

jitter_buffer_delay: optional object { "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": optional number

"250ms_or_greater_event_fraction": optional number

"500ms_or_greater_event_fraction": optional number

avg: optional number

packet_loss: optional object { "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": optional number

"25_or_greater_event_fraction": optional number

"5_or_greater_event_fraction": optional number

"50_or_greater_event_fraction": optional number

avg: optional number

quality_mos: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

screenshare_audio_producer: optional array of object { bytes_sent, jitter, mid, 7 more }

bytes_sent: optional number

jitter: optional number

mid: optional string

mos_quality: optional number

packets_lost: optional number

packets_sent: optional number

producer_id: optional string

rtt: optional number

ssrc: optional number

timestamp: optional string

screenshare_audio_producer_cumulative: optional object { packet_loss, quality_mos, rtt }

Aggregated outbound (producer) audio statistics for the session.

packet_loss: optional object { "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": optional number

"25_or_greater_event_fraction": optional number

"5_or_greater_event_fraction": optional number

"50_or_greater_event_fraction": optional number

avg: optional number

quality_mos: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

rtt: optional object { "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": optional number

"250ms_or_greater_event_fraction": optional number

"500ms_or_greater_event_fraction": optional number

avg: optional number

screenshare_video_consumer: optional array of object { bytes_received, consumer_id, fir_count, 17 more }

bytes_received: optional number

consumer_id: optional string

fir_count: optional number

frame_height: optional number

frame_width: optional number

frames_decoded: optional number

frames_dropped: optional number

frames_per_second: optional number

jitter: optional number

jitter_buffer_delay: optional number

jitter_buffer_emitted_count: optional number

key_frames_decoded: optional number

mid: optional string

mos_quality: optional number

packets_lost: optional number

packets_received: optional number

peer_id: optional string

producer_id: optional string

ssrc: optional number

timestamp: optional string

screenshare_video_consumer_cumulative: optional object { frame_per_second, frame_width, issues, 4 more }

Aggregated inbound (consumer) video statistics for the session.

frame_per_second: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

frame_width: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

issues: optional object { lag_fraction, no_video_fraction, poor_resolution_fraction }

lag_fraction: optional number

no_video_fraction: optional number

poor_resolution_fraction: optional number

jitter_buffer_delay: optional object { "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": optional number

"250ms_or_greater_event_fraction": optional number

"500ms_or_greater_event_fraction": optional number

avg: optional number

key_frames_decoded_fraction: optional number

packet_loss: optional object { "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": optional number

"25_or_greater_event_fraction": optional number

"5_or_greater_event_fraction": optional number

"50_or_greater_event_fraction": optional number

avg: optional number

quality_mos: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

screenshare_video_producer: optional array of object { bytes_sent, fir_count, frame_height, 17 more }

bytes_sent: optional number

fir_count: optional number

frame_height: optional number

frame_width: optional number

frames_encoded: optional number

frames_per_second: optional number

jitter: optional number

key_frames_encoded: optional number

mid: optional string

mos_quality: optional number

packets_lost: optional number

packets_sent: optional number

pli_count: optional number

producer_id: optional string

quality_limitation_durations: optional object { bandwidth, cpu, none, other }

bandwidth: optional number

cpu: optional number

none: optional number

other: optional number

quality_limitation_reason: optional "cpu" or "bandwidth" or "none" or "other"

One of the following:

"cpu"

"bandwidth"

"none"

"other"

quality_limitation_resolution_changes: optional number

rtt: optional number

ssrc: optional number

timestamp: optional string

screenshare_video_producer_cumulative: optional object { frame_per_second, frame_width, high_negative_feedback_fraction, 5 more }

Aggregated outbound (producer) video statistics for the session.

frame_per_second: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

frame_width: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

high_negative_feedback_fraction: optional number

issues: optional object { bandwidth_quality_limitation_fraction, cpu_quality_limitation_fraction, no_video_fraction, 2 more }

bandwidth_quality_limitation_fraction: optional number

cpu_quality_limitation_fraction: optional number

no_video_fraction: optional number

poor_resolution_fraction: optional number

quality_limitation_fraction: optional number

key_frames_encoded_fraction: optional number

packet_loss: optional object { "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": optional number

"25_or_greater_event_fraction": optional number

"5_or_greater_event_fraction": optional number

"50_or_greater_event_fraction": optional number

avg: optional number

quality_mos: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

rtt: optional object { "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": optional number

"250ms_or_greater_event_fraction": optional number

"500ms_or_greater_event_fraction": optional number

avg: optional number

video_consumer: optional array of object { bytes_received, consumer_id, fir_count, 17 more }

bytes_received: optional number

consumer_id: optional string

fir_count: optional number

frame_height: optional number

frame_width: optional number

frames_decoded: optional number

frames_dropped: optional number

frames_per_second: optional number

jitter: optional number

jitter_buffer_delay: optional number

jitter_buffer_emitted_count: optional number

key_frames_decoded: optional number

mid: optional string

mos_quality: optional number

packets_lost: optional number

packets_received: optional number

peer_id: optional string

producer_id: optional string

ssrc: optional number

timestamp: optional string

video_consumer_cumulative: optional object { frame_per_second, frame_width, issues, 4 more }

Aggregated inbound (consumer) video statistics for the session.

frame_per_second: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

frame_width: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

issues: optional object { lag_fraction, no_video_fraction, poor_resolution_fraction }

lag_fraction: optional number

no_video_fraction: optional number

poor_resolution_fraction: optional number

jitter_buffer_delay: optional object { "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": optional number

"250ms_or_greater_event_fraction": optional number

"500ms_or_greater_event_fraction": optional number

avg: optional number

key_frames_decoded_fraction: optional number

packet_loss: optional object { "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": optional number

"25_or_greater_event_fraction": optional number

"5_or_greater_event_fraction": optional number

"50_or_greater_event_fraction": optional number

avg: optional number

quality_mos: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

video_producer: optional array of object { bytes_sent, fir_count, frame_height, 17 more }

bytes_sent: optional number

fir_count: optional number

frame_height: optional number

frame_width: optional number

frames_encoded: optional number

frames_per_second: optional number

jitter: optional number

key_frames_encoded: optional number

mid: optional string

mos_quality: optional number

packets_lost: optional number

packets_sent: optional number

pli_count: optional number

producer_id: optional string

quality_limitation_durations: optional object { bandwidth, cpu, none, other }

bandwidth: optional number

cpu: optional number

none: optional number

other: optional number

quality_limitation_reason: optional "cpu" or "bandwidth" or "none" or "other"

One of the following:

"cpu"

"bandwidth"

"none"

"other"

quality_limitation_resolution_changes: optional number

rtt: optional number

ssrc: optional number

timestamp: optional string

video_producer_cumulative: optional object { frame_per_second, frame_width, high_negative_feedback_fraction, 5 more }

Aggregated outbound (producer) video statistics for the session.

frame_per_second: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

frame_width: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

high_negative_feedback_fraction: optional number

issues: optional object { bandwidth_quality_limitation_fraction, cpu_quality_limitation_fraction, no_video_fraction, 2 more }

bandwidth_quality_limitation_fraction: optional number

cpu_quality_limitation_fraction: optional number

no_video_fraction: optional number

poor_resolution_fraction: optional number

quality_limitation_fraction: optional number

key_frames_encoded_fraction: optional number

packet_loss: optional object { "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": optional number

"25_or_greater_event_fraction": optional number

"5_or_greater_event_fraction": optional number

"50_or_greater_event_fraction": optional number

avg: optional number

quality_mos: optional object { avg, p50, p75, p90 }

Distribution summary with average and percentiles.

avg: optional number

p50: optional number

p75: optional number

p90: optional number

rtt: optional object { "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": optional number

"250ms_or_greater_event_fraction": optional number

"500ms_or_greater_event_fraction": optional number

avg: optional number

role: optional string

Name of the preset associated with the participant.

session_id: optional string

formatuuid

updated_at: optional string

timestamp when this participant’s data was last updated.

user_id: optional string

User id for this participant.

success: optional boolean