Sessions

Fetch all sessions of an App

realtime_kit.sessions.get_sessions(, ) -> SessionGetSessionsResponse

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

Fetch details of a session

realtime_kit.sessions.get_session_details(, ) -> SessionGetSessionDetailsResponse

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

Fetch participants list of a session

realtime_kit.sessions.get_session_participants(, ) -> 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(, ) -> 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(, ) -> 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(, ) -> 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(, ) -> 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(, )

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(, ) -> 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.

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.

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 SessionGetParticipantDataFromPeerIDResponse: …

data: Optional[Data]

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[Dict[str, object]]]

peer_report: Optional[DataPeerReport]

Peer call statistics report.

metadata: Optional[Dict[str, object]]

quality: Optional[Dict[str, object]]

preset_name: 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]