Sessions

Fetch all sessions of an App

client.realtimeKit.sessions.getSessions(, , ?): SessionGetSessionsResponse { data, success }

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

Fetch details of a session

client.realtimeKit.sessions.getSessionDetails(, , , ?): SessionGetSessionDetailsResponse { data, success }

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

Fetch participants list of a session

client.realtimeKit.sessions.getSessionParticipants(, , , ?): SessionGetSessionParticipantsResponse { data, success }

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

Fetch details of a participant

client.realtimeKit.sessions.getSessionParticipantDetails(, , , , ?): SessionGetSessionParticipantDetailsResponse { data, success }

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

Fetch all chat messages of a session

client.realtimeKit.sessions.getSessionChat(, , , ?): SessionGetSessionChatResponse { data, success }

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

Fetch the complete transcript for a session

client.realtimeKit.sessions.getSessionTranscripts(, , , ?): SessionGetSessionTranscriptsResponse { data, success }

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

Fetch summary of transcripts for a session

client.realtimeKit.sessions.getSessionSummary(, , , ?): SessionGetSessionSummaryResponse { data, success }

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

Generate summary of Transcripts for the session

client.realtimeKit.sessions.generateSummaryOfTranscripts(, , , ?): void

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

Fetch details of peer

client.realtimeKit.sessions.getParticipantDataFromPeerId(, , , ?): SessionGetParticipantDataFromPeerIDResponse { data, success }

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

ModelsExpand Collapse

SessionGetSessionsResponse { data, success }

data?: Data { sessions }

sessions?: Array<Session>

id: string

ID of the session

associated_id: string

ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form abcdef-ghijkl

created_at: string

timestamp when session created

live_participants: number

number of participants currently in the session

max_concurrent_participants: number

number of maximum participants that were in the session

meeting_display_name: string

Title of the meeting this session belongs to

minutes_consumed: number

number of minutes consumed since the session started

organization_id: string

App id that hosted this session

started_at: string

timestamp when session started

status: "LIVE" | "ENDED"

current status of session

One of the following:

"LIVE"

"ENDED"

type: "meeting" | "livestream" | "participant"

type of session

One of the following:

"meeting"

"livestream"

"participant"

updated_at: string

timestamp when session was last updated

breakout_rooms?: Array<unknown>

ended_at?: string

timestamp when session ended

meta?: unknown

Any meta data about session.

success?: boolean

SessionGetSessionDetailsResponse { data, success }

data?: Data { session }

session?: Session { 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" | "ENDED"

current status of session

One of the following:

"LIVE"

"ENDED"

type: "meeting" | "livestream" | "participant"

type of session

One of the following:

"meeting"

"livestream"

"participant"

updated_at: string

timestamp when session was last updated

breakout_rooms?: Array<unknown>

ended_at?: string

timestamp when session ended

meta?: unknown

Any meta data about session.

success?: boolean

SessionGetSessionParticipantsResponse { data, success }

data?: Data { participants }

participants?: Array<Participant>

id?: string

Participant ID. This maps to the corresponding peerId.

created_at?: string

timestamp when this participant was created.

custom_participant_id?: string

ID passed by client to create this participant.

display_name?: string

Display name of participant when joining the session.

duration?: number

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

joined_at?: string

timestamp at which participant joined the session.

left_at?: string

timestamp at which participant left the session.

preset_name?: string

Name of the preset associated with the participant.

updated_at?: string

timestamp when this participant's data was last updated.

user_id?: string

User id for this participant.

success?: boolean

SessionGetSessionParticipantDetailsResponse { data, success }

data?: Data { participant }

participant?: Participant { id, created_at, custom_participant_id, 9 more }

id?: string

Participant ID. This maps to the corresponding peerId.

created_at?: string

timestamp when this participant was created.

custom_participant_id?: string

ID passed by client to create this participant.

display_name?: string

Display name of participant when joining the session.

duration?: number

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

joined_at?: string

timestamp at which participant joined the session.

left_at?: string

timestamp at which participant left the session.

peer_stats?: PeerStats { config, device_info, events, 3 more }

config?: string

device_info?: DeviceInfo { browser, browser_version, cpus, 9 more }

browser?: string

browser_version?: string

cpus?: number

engine?: string

is_mobile?: boolean

memory?: number

os?: string

os_version?: string

sdk_name?: string

sdk_version?: string

user_agent?: string

webgl_support?: string

events?: Array<Event>

timestamp?: string

type?: string

ip_information?: IPInformation { city, country, ip_location, 5 more }

city?: string

country?: string

ip_location?: string

ipv4?: string

org?: string

portal?: string

region?: string

timezone?: string

precall_network_information?: PrecallNetworkInformation { backend_rtt, effective_networktype, fractional_loss, 6 more }

backend_rtt?: number

effective_networktype?: string

fractional_loss?: number

jitter?: number

reflexive_connectivity?: boolean

relay_connectivity?: boolean

rtt?: number

throughtput?: number

turn_connectivity?: boolean

status?: string

preset_name?: string

Name of the preset associated with the participant.

quality_stats?: Array<QualityStat>

audio_bandwidth?: number

audio_packet_loss?: number

audio_stats?: Array<AudioStat>

concealment_events?: number

jitter?: number

packets_lost?: number

quality?: number

timestamp?: string

average_quality?: number

end?: string

peer_id?: string

start?: string

video_bandwidth?: number

video_packet_loss?: number

video_stats?: Array<VideoStat>

frame_height?: number

frame_width?: number

frames_dropped?: number

frames_per_second?: number

jitter?: number

packets_lost?: number

quality?: number

timestamp?: string

updated_at?: string

timestamp when this participant's data was last updated.

user_id?: string

User id for this participant.

success?: boolean

SessionGetSessionChatResponse { data, success }

data?: Data { 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?: boolean

SessionGetSessionTranscriptsResponse { data, success }

data?: Data { 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?: boolean

SessionGetSessionSummaryResponse { data, success }

data?: Data { 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?: boolean

SessionGetParticipantDataFromPeerIDResponse { data, success }

data?: Data { participant }

participant?: Participant { id, created_at, custom_participant_id, 10 more }

id?: string

created_at?: string

custom_participant_id?: string

display_name?: string

duration?: number

joined_at?: string

left_at?: string

peer_report?: PeerReport { metadata, quality }

metadata?: Metadata { audio_devices_updates, browser_metadata, candidate_pairs, 10 more }

audio_devices_updates?: Array<unknown>

browser_metadata?: BrowserMetadata { browser, browser_version, engine, 2 more }

browser?: string

browser_version?: string

engine?: string

user_agent?: string

webgl_support?: string

candidate_pairs?: CandidatePairs { consuming_transport, producing_transport }

consuming_transport?: Array<unknown>

producing_transport?: Array<ProducingTransport>

available_outgoing_bitrate?: number

bytes_discarded_on_send?: number

bytes_received?: number

bytes_sent?: number

current_round_trip_time?: number

last_packet_received_timestamp?: number

last_packet_sent_timestamp?: number

local_candidate_address?: string

local_candidate_id?: string

local_candidate_network_type?: string

local_candidate_port?: number

local_candidate_protocol?: string

local_candidate_related_address?: string

local_candidate_related_port?: number

local_candidate_type?: string

nominated?: boolean

packets_discarded_on_send?: number

packets_received?: number

packets_sent?: number

remote_candidate_address?: string

remote_candidate_id?: string

remote_candidate_port?: number

remote_candidate_protocol?: string

remote_candidate_type?: string

total_round_trip_time?: number

device_info?: DeviceInfo { cpus, is_mobile, os, os_version }

cpus?: number

is_mobile?: boolean

os?: string

os_version?: string

events?: Array<Event>

name?: string

timestamp?: string

ip_information?: IPInformation { asn, city, country, 3 more }

asn?: ASN { asn }

asn?: string

city?: string

country?: string

ipv4?: string

region?: string

timezone?: string

pc_metadata?: Array<PcMetadata>

effective_network_type?: string

reflexive_connectivity?: boolean

relay_connectivity?: boolean

timestamp?: string

turn_connectivity?: boolean

room_view_type?: string

sdk_name?: string

sdk_version?: string

selected_device_updates?: Array<unknown>

speaker_devices_updates?: Array<unknown>

video_devices_updates?: Array<unknown>

quality?: Quality { audio_consumer, audio_consumer_cumulative, audio_producer, 13 more }

audio_consumer?: Array<unknown>

audio_consumer_cumulative?: unknown

audio_producer?: Array<AudioProducer>

bytes_sent?: number

jitter?: number

mid?: string

mos_quality?: number

packets_lost?: number

packets_sent?: number

producer_id?: string

rtt?: number

ssrc?: number

timestamp?: string

audio_producer_cumulative?: AudioProducerCumulative { packet_loss, quality_mos, rtt }

packet_loss?: PacketLoss { 10_or_greater_event_fraction, 25_or_greater_event_fraction, 5_or_greater_event_fraction, 2 more }

"10_or_greater_event_fraction"?: number

"25_or_greater_event_fraction"?: number

"5_or_greater_event_fraction"?: number

"50_or_greater_event_fraction"?: number

avg?: number

quality_mos?: QualityMos { avg, p50, p75, p90 }

avg?: number

p50?: number

p75?: number

p90?: number

rtt?: RTT { 100ms_or_greater_event_fraction, 250ms_or_greater_event_fraction, 500ms_or_greater_event_fraction, avg }

"100ms_or_greater_event_fraction"?: number

"250ms_or_greater_event_fraction"?: number

"500ms_or_greater_event_fraction"?: number

avg?: number

screenshare_audio_consumer?: Array<unknown>

screenshare_audio_consumer_cumulative?: unknown

screenshare_audio_producer?: Array<unknown>

screenshare_audio_producer_cumulative?: unknown

screenshare_video_consumer?: Array<unknown>

screenshare_video_consumer_cumulative?: unknown

screenshare_video_producer?: Array<unknown>

screenshare_video_producer_cumulative?: unknown

video_consumer?: Array<unknown>

video_consumer_cumulative?: unknown

video_producer?: Array<unknown>

video_producer_cumulative?: unknown

peer_stats?: PeerStats { device_info, events, ip_information, precall_network_information }

device_info?: DeviceInfo { browser, browser_version, cpus, 8 more }

browser?: string

browser_version?: string

cpus?: number

engine?: string

is_mobile?: boolean

os?: string

os_version?: string

sdk_name?: string

sdk_version?: string

user_agent?: string

webgl_support?: string

events?: Array<Event>

metadata?: Metadata { connection_info }

connection_info?: ConnectionInfo { backend_r_t_t, connectivity, effective_network_type, 7 more }

backend_r_t_t?: number

connectivity?: Connectivity { host, reflexive, relay }

host?: boolean

reflexive?: boolean

relay?: boolean

effective_network_type?: string

fractional_loss?: number

ip_details?: IPDetails { asn, city, country, 5 more }

asn?: ASN { asn }

asn?: string

city?: string

country?: string

ip?: string

loc?: string

postal?: string

region?: string

timezone?: string

jitter?: number

location?: Location { coords }

coords?: Coords { latitude, longitude }

latitude?: number

longitude?: number

r_t_t?: number

throughput?: number

turn_connectivity?: boolean

timestamp?: string

type?: string

ip_information?: IPInformation { asn, city, country, 5 more }

asn?: ASN { asn }

asn?: string

city?: string

country?: string

ip_location?: string

ipv4?: string

org?: string

region?: string

timezone?: string

precall_network_information?: PrecallNetworkInformation { backend_rtt, effective_networktype, fractional_loss, 6 more }

backend_rtt?: number

effective_networktype?: string

fractional_loss?: number

jitter?: number

reflexive_connectivity?: boolean

relay_connectivity?: boolean

rtt?: number

throughput?: number

turn_connectivity?: boolean

quality_stats?: QualityStats { audio_bandwidth, audio_stats, average_quality, 13 more }

audio_bandwidth?: number

audio_stats?: Array<unknown>

average_quality?: number

end?: string | null

first_audio_packet_received?: string

first_video_packet_received?: string

last_audio_packet_received?: string

last_video_packet_received?: string

peer_ids?: Array<string>

start?: string | null

total_audio_packets?: number

total_audio_packets_lost?: number

total_video_packets?: number

total_video_packets_lost?: number

video_bandwidth?: number

video_stats?: Array<unknown>

role?: string

updated_at?: string

user_id?: string

success?: boolean