Cloudflare API | Realtime Kit

Returns day-wise session and recording analytics data of an App for the specified time range start_date to end_date. If start_date and end_date are not provided, the default time range is set from 30 days ago to the current date.

Realtime Kit

Apps

RealtimeKit.Apps

Methods

client.realtimeKit.apps.get(, ):

AppGetResponse

get/accounts/{account_id}/realtime/kit/apps

Fetch all apps for your account

client.realtimeKit.apps.post(, ):

AppPostResponse

post/accounts/{account_id}/realtime/kit/apps

Create new app for your account

Realtime Kit

Livestreams

RealtimeKit.Livestreams

Methods

client.realtimeKit.livestreams.createIndependentLivestream(, , ):

LivestreamCreateIndependentLivestreamResponse

post/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Creates a livestream for the given App ID and returns ingest server, stream key, and playback URL. You can pass custom input to the ingest server and stream key, and freely distribute the content using the playback URL on any player that supports HLS/LHLS.

client.realtimeKit.livestreams.getAllLivestreams(, , ):

LivestreamGetAllLivestreamsResponse

get/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the exclude_meetings query parameter.

client.realtimeKit.livestreams.stopLivestreamingAMeeting(, , , ):

LivestreamStopLivestreamingAMeetingResponse

post/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop

Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

client.realtimeKit.livestreams.startLivestreamingAMeeting(, , , ):

LivestreamStartLivestreamingAMeetingResponse

post/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams

Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

client.realtimeKit.livestreams.getLivestreamAnalyticsComplete(, , ):

LivestreamGetLivestreamAnalyticsCompleteResponse

get/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall

Returns livestream analytics for the specified time range.

client.realtimeKit.livestreams.getOrgAnalytics(, , ):

LivestreamGetOrgAnalyticsResponse

get/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise

client.realtimeKit.livestreams.getMeetingActiveLivestreams(, , , ):

LivestreamGetMeetingActiveLivestreamsResponse

get/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream

Returns details of all active livestreams for the given meeting ID.

client.realtimeKit.livestreams.getLivestreamSessionDetailsForSessionId(, , , ):

LivestreamGetLivestreamSessionDetailsForSessionIDResponse

get/accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id}

Returns livestream session details for the given livestream session ID. Retrieve the livestream_session_idusing the Fetch livestream session details using a session ID API.

client.realtimeKit.livestreams.getActiveLivestreamsForLivestreamId(, , , ):

LivestreamGetActiveLivestreamsForLivestreamIDResponse

get/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session

Returns details of all active livestreams for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.

client.realtimeKit.livestreams.getLivestreamSessionForLivestreamId(, , , ):

LivestreamGetLivestreamSessionForLivestreamIDResponse

get/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}

Returns details of a livestream with sessions for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.

Realtime Kit

Meetings

RealtimeKit.Meetings

Methods

client.realtimeKit.meetings.get(, , ):

MeetingGetResponse

get/accounts/{account_id}/realtime/kit/{app_id}/meetings

Returns all meetings for the given App ID.

client.realtimeKit.meetings.create(, , ):

MeetingCreateResponse

post/accounts/{account_id}/realtime/kit/{app_id}/meetings

Create a meeting for the given App ID.

client.realtimeKit.meetings.getMeetingById(, , , ):

MeetingGetMeetingByIDResponse

get/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Returns a meeting details in an App for the given meeting ID.

client.realtimeKit.meetings.updateMeetingById(, , , ):

MeetingUpdateMeetingByIDResponse

patch/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Updates a meeting in an App for the given meeting ID.

client.realtimeKit.meetings.replaceMeetingById(, , , ):

MeetingReplaceMeetingByIDResponse

put/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Replaces all the details for the given meeting ID.

client.realtimeKit.meetings.getMeetingParticipants(, , , ):

MeetingGetMeetingParticipantsResponse

get/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants

Returns all participants detail for the given meeting ID.

client.realtimeKit.meetings.addParticipant(, , , ):

MeetingAddParticipantResponse

post/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants

Adds a participant to the given meeting ID.

client.realtimeKit.meetings.getMeetingParticipant(, , , , ):

MeetingGetMeetingParticipantResponse

get/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Returns a participant details for the given meeting and participant ID.

client.realtimeKit.meetings.editParticipant(, , , , ):

MeetingEditParticipantResponse

patch/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Updates a participant's details for the given meeting and participant ID.

client.realtimeKit.meetings.deleteMeetingParticipant(, , , , ):

MeetingDeleteMeetingParticipantResponse

delete/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Deletes a participant for the given meeting and participant ID.

client.realtimeKit.meetings.refreshParticipantToken(, , , , ):

MeetingRefreshParticipantTokenResponse

post/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}/token

Regenerates participant's authentication token for the given meeting and participant ID.

Realtime Kit

Presets

RealtimeKit.Presets

Methods

client.realtimeKit.presets.get(, , ):

PresetGetResponse

get/accounts/{account_id}/realtime/kit/{app_id}/presets

Fetches all the presets belonging to an App.

client.realtimeKit.presets.create(, , ):

PresetCreateResponse

post/accounts/{account_id}/realtime/kit/{app_id}/presets

Creates a preset belonging to the current App

client.realtimeKit.presets.getPresetById(, , , ):

PresetGetPresetByIDResponse

get/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Fetches details of a preset using the provided preset ID

client.realtimeKit.presets.delete(, , , ):

PresetDeleteResponse

delete/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Deletes a preset using the provided preset ID

client.realtimeKit.presets.update(, , , ):

PresetUpdateResponse

patch/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Update a preset by the provided preset ID

Realtime Kit

Recordings

RealtimeKit.Recordings

Methods

client.realtimeKit.recordings.getRecordings(, , ):

RecordingGetRecordingsResponse

get/accounts/{account_id}/realtime/kit/{app_id}/recordings

Returns all recordings for an App. If the meeting_id parameter is passed, returns all recordings for the given meeting ID.

client.realtimeKit.recordings.startRecordings(, , ):

RecordingStartRecordingsResponse

post/accounts/{account_id}/realtime/kit/{app_id}/recordings

Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

client.realtimeKit.recordings.getActiveRecordings(, , , ):

RecordingGetActiveRecordingsResponse

get/accounts/{account_id}/realtime/kit/{app_id}/recordings/active-recording/{meeting_id}

Returns the active recording details for the given meeting ID.

client.realtimeKit.recordings.getOneRecording(, , , ):

RecordingGetOneRecordingResponse

get/accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id}

Returns details of a recording for the given recording ID.

client.realtimeKit.recordings.pauseResumeStopRecording(, , , ):

RecordingPauseResumeStopRecordingResponse

put/accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id}

Pause/Resume/Stop a given recording ID.

client.realtimeKit.recordings.startTrackRecording(, , ): void

post/accounts/{account_id}/realtime/kit/{app_id}/recordings/track

Starts a track recording in a meeting. Track recordings consist of "layers". Layers are used to map audio/video tracks in a meeting to output destinations. More information about track recordings is available in the Track Recordings Guide Page.

Realtime Kit

Sessions

RealtimeKit.Sessions

Methods

client.realtimeKit.sessions.getSessions(, , ):

SessionGetSessionsResponse

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

Returns details of all sessions of an App.

client.realtimeKit.sessions.getSessionDetails(, , , ):

SessionGetSessionDetailsResponse

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

Returns data of the given session ID including recording details.

client.realtimeKit.sessions.getSessionParticipants(, , , ):

SessionGetSessionParticipantsResponse

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

Returns a list of participants for the given session ID.

client.realtimeKit.sessions.getSessionParticipantDetails(, , , , ):

SessionGetSessionParticipantDetailsResponse

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

Returns details of the given participant ID along with call statistics for the given session ID.

client.realtimeKit.sessions.getSessionChat(, , , ):

SessionGetSessionChatResponse

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

Returns a URL to download all chat messages of the session ID in CSV format.

client.realtimeKit.sessions.getSessionTranscripts(, , , ):

SessionGetSessionTranscriptsResponse

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

Returns a URL to download the transcript for the session ID in CSV format.

client.realtimeKit.sessions.getSessionSummary(, , , ):

SessionGetSessionSummaryResponse

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

Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text.

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

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

Trigger Summary generation of Transcripts for the session ID.

client.realtimeKit.sessions.getParticipantDataFromPeerId(, , , ):

SessionGetParticipantDataFromPeerIDResponse

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

Returns details of the given peer ID along with call statistics for the given session ID.

Realtime Kit

Webhooks

RealtimeKit.Webhooks

Methods

client.realtimeKit.webhooks.getWebhooks(, , ):

WebhookGetWebhooksResponse

get/accounts/{account_id}/realtime/kit/{app_id}/webhooks

Returns details of all webhooks for an App.

client.realtimeKit.webhooks.createWebhook(, , ):

WebhookCreateWebhookResponse

post/accounts/{account_id}/realtime/kit/{app_id}/webhooks

Adds a new webhook to an App.

client.realtimeKit.webhooks.getWebhookById(, , , ):

WebhookGetWebhookByIDResponse

get/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Returns webhook details for the given webhook ID.

client.realtimeKit.webhooks.replaceWebhook(, , , ):

WebhookReplaceWebhookResponse

put/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Replace all details for the given webhook ID.

client.realtimeKit.webhooks.editWebhook(, , , ):

WebhookEditWebhookResponse

patch/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Edits the webhook details for the given webhook ID.

client.realtimeKit.webhooks.deleteWebhook(, , , ):

WebhookDeleteWebhookResponse

delete/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Removes a webhook for the given webhook ID.