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

meta: optional unknown

Any meta data about session.

success: optional boolean

SessionGetSessionDetailsResponse = object { data, success }

data: optional object { session }

session: optional object { id, associated_id, created_at, 12 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

meta: optional unknown

Any meta data about session.

success: optional boolean

SessionGetSessionParticipantsResponse = object { data, success }

data: optional object { participants }

participants: optional array of object { id, created_at, custom_participant_id, 7 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.

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, 9 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_stats: optional object { config, device_info, events, 3 more }

config: optional string

device_info: optional object { browser, browser_version, cpus, 9 more }

browser: optional string

browser_version: optional string

cpus: optional number

engine: optional string

is_mobile: optional boolean

memory: optional number

os: optional string

os_version: optional string

sdk_name: optional string

sdk_version: optional string

user_agent: optional string

webgl_support: optional string

events: optional array of object { timestamp, type }

timestamp: optional string

type: optional string

ip_information: optional object { city, country, ip_location, 5 more }

city: optional string

country: optional string

ip_location: optional string

ipv4: optional string

org: optional string

portal: optional string

region: optional string

timezone: optional string

precall_network_information: optional object { backend_rtt, effective_networktype, fractional_loss, 6 more }

backend_rtt: optional number

effective_networktype: optional string

fractional_loss: optional number

jitter: optional number

reflexive_connectivity: optional boolean

relay_connectivity: optional boolean

rtt: optional number

throughtput: optional number

turn_connectivity: optional boolean

status: optional string

preset_name: optional string

Name of the preset associated with the participant.

quality_stats: optional array of object { audio_bandwidth, audio_packet_loss, audio_stats, 7 more }

audio_bandwidth: optional number

audio_packet_loss: optional number

audio_stats: optional array of object { concealment_events, jitter, packets_lost, 2 more }

concealment_events: optional number

jitter: optional number

packets_lost: optional number

quality: optional number

timestamp: optional string

average_quality: optional number

end: optional string

peer_id: optional string

start: optional string

video_bandwidth: optional number

video_packet_loss: optional number

video_stats: optional array of object { frame_height, frame_width, frames_dropped, 5 more }

frame_height: optional number

frame_width: optional number

frames_dropped: optional number

frames_per_second: optional number

jitter: optional number

packets_lost: optional number

quality: optional number

timestamp: optional string

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

SessionGetParticipantDataFromPeerIDResponse = object { data, success }

data: optional object { participant }

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

id: optional string

created_at: optional string

custom_participant_id: optional string

display_name: optional string

duration: optional number

joined_at: optional string

left_at: optional string

peer_report: optional object { metadata, quality }

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

audio_devices_updates: optional array of unknown

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 string

candidate_pairs: optional object { consuming_transport, producing_transport }

consuming_transport: optional array of unknown

producing_transport: optional array of object { available_outgoing_bitrate, bytes_discarded_on_send, bytes_received, 22 more }

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

last_packet_sent_timestamp: optional number

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

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

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 { name, timestamp }

name: optional string

timestamp: optional string

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

asn: optional object { asn }

asn: optional string

city: optional string

country: optional string

ipv4: optional string

region: optional string

timezone: optional string

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

effective_network_type: optional string

reflexive_connectivity: optional boolean

relay_connectivity: optional boolean

timestamp: optional string

turn_connectivity: optional boolean

room_view_type: optional string

sdk_name: optional string

sdk_version: optional string

selected_device_updates: optional array of unknown

speaker_devices_updates: optional array of unknown

video_devices_updates: optional array of unknown

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

audio_consumer: optional array of unknown

audio_consumer_cumulative: optional unknown

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 }

packet_loss: optional object { "10_or_greater_event_fraction", "25_or_greater_event_fraction", "5_or_greater_event_fraction", 2 more }

"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 }

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 }

"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 unknown

screenshare_audio_consumer_cumulative: optional unknown

screenshare_audio_producer: optional array of unknown

screenshare_audio_producer_cumulative: optional unknown

screenshare_video_consumer: optional array of unknown

screenshare_video_consumer_cumulative: optional unknown

screenshare_video_producer: optional array of unknown

screenshare_video_producer_cumulative: optional unknown

video_consumer: optional array of unknown

video_consumer_cumulative: optional unknown

video_producer: optional array of unknown

video_producer_cumulative: optional unknown

peer_stats: optional object { device_info, events, ip_information, precall_network_information }

device_info: optional object { browser, browser_version, cpus, 8 more }

browser: optional string

browser_version: optional string

cpus: optional number

engine: optional string

is_mobile: optional boolean

os: optional string

os_version: optional string

sdk_name: optional string

sdk_version: optional string

user_agent: optional string

webgl_support: optional string

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

metadata: optional object { connection_info }

connection_info: optional object { backend_r_t_t, connectivity, effective_network_type, 7 more }

backend_r_t_t: optional number

connectivity: optional object { host, reflexive, relay }

host: optional boolean

reflexive: optional boolean

relay: optional boolean

effective_network_type: optional string

fractional_loss: optional number

ip_details: optional object { asn, city, country, 5 more }

asn: optional object { asn }

asn: optional string

city: optional string

country: optional string

ip: optional string

loc: optional string

postal: optional string

region: optional string

timezone: optional string

jitter: optional number

location: optional object { coords }

coords: optional object { latitude, longitude }

latitude: optional number

longitude: optional number

r_t_t: optional number

throughput: optional number

turn_connectivity: optional boolean

timestamp: optional string

type: optional string

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

asn: optional object { asn }

asn: optional string

city: optional string

country: optional string

ip_location: optional string

ipv4: optional string

org: optional string

region: optional string

timezone: optional string

precall_network_information: optional object { backend_rtt, effective_networktype, fractional_loss, 6 more }

backend_rtt: optional number

effective_networktype: optional string

fractional_loss: optional number

jitter: optional number

reflexive_connectivity: optional boolean

relay_connectivity: optional boolean

rtt: optional number

throughput: optional number

turn_connectivity: optional boolean

quality_stats: optional object { audio_bandwidth, audio_stats, average_quality, 13 more }

audio_bandwidth: optional number

audio_stats: optional array of unknown

average_quality: optional number

end: optional string

first_audio_packet_received: optional string

first_video_packet_received: optional string

last_audio_packet_received: optional string

last_video_packet_received: optional string

peer_ids: optional array of string

start: optional string

total_audio_packets: optional number

total_audio_packets_lost: optional number

total_video_packets: optional number

total_video_packets_lost: optional number

video_bandwidth: optional number

video_stats: optional array of unknown

role: optional string

updated_at: optional string

user_id: optional string

success: optional boolean