Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit

Livestreams

Fetch all livestreams
client.realtimeKit.livestreams.getAllLivestreams(stringappID, LivestreamGetAllLivestreamsParams { account_id, end_time, exclude_meetings, 5 more } params, RequestOptionsoptions?): LivestreamGetAllLivestreamsResponse { data, paging, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams
Fetch livestream session details for a meeting
client.realtimeKit.livestreams.getLivestreamSessionDetailsForMeeting(stringmeetingID, LivestreamGetLivestreamSessionDetailsForMeetingParams { account_id, app_id, page_no, per_page } params, RequestOptionsoptions?): LivestreamGetLivestreamSessionDetailsForMeetingResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestream
Fetch livestream session details using a session ID
client.realtimeKit.livestreams.getLivestreamSessionsForSession(stringsessionID, LivestreamGetLivestreamSessionsForSessionParams { account_id, app_id, page_no, per_page } params, RequestOptionsoptions?): LivestreamGetLivestreamSessionsForSessionResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/livestream-sessions
Stop livestreaming a meeting
client.realtimeKit.livestreams.stopLivestreamingAMeeting(stringmeetingID, LivestreamStopLivestreamingAMeetingParams { account_id, app_id } params, RequestOptionsoptions?): LivestreamStopLivestreamingAMeetingResponse { data, success }
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop
Start livestreaming a meeting
client.realtimeKit.livestreams.startLivestreamingAMeeting(stringmeetingID, LivestreamStartLivestreamingAMeetingParams { account_id, app_id, name, video_config } params, RequestOptionsoptions?): LivestreamStartLivestreamingAMeetingResponse { data, success }
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams
Fetch complete analytics data for your livestreams
client.realtimeKit.livestreams.getLivestreamAnalyticsComplete(stringappID, LivestreamGetLivestreamAnalyticsCompleteParams { account_id, end_time, filters, start_time } params, RequestOptionsoptions?): LivestreamGetLivestreamAnalyticsCompleteResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall
Fetch day-wise analytics data for your livestreams
client.realtimeKit.livestreams.getLivestreamAnalyticsDaywise(stringappID, LivestreamGetLivestreamAnalyticsDaywiseParams { account_id, end_time, filters, start_time } params, RequestOptionsoptions?): LivestreamGetLivestreamAnalyticsDaywiseResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/daywise
Fetch day-wise session and recording analytics data for an App
client.realtimeKit.livestreams.getOrgAnalytics(stringappID, LivestreamGetOrgAnalyticsParams { account_id, end_date, start_date } params, RequestOptionsoptions?): LivestreamGetOrgAnalyticsResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise
Fetch active livestreams for a meeting
client.realtimeKit.livestreams.getMeetingActiveLivestreams(stringmeetingID, LivestreamGetMeetingActiveLivestreamsParams { account_id, app_id } params, RequestOptionsoptions?): LivestreamGetMeetingActiveLivestreamsResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream
Fetch livestream session details using livestream session ID
client.realtimeKit.livestreams.getLivestreamSessionDetailsForSessionID(stringlivestreamSessionID, LivestreamGetLivestreamSessionDetailsForSessionIDParams { account_id, app_id } params, RequestOptionsoptions?): LivestreamGetLivestreamSessionDetailsForSessionIDResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id}
Fetch active livestream session details
client.realtimeKit.livestreams.getActiveLivestreamsForLivestreamID(stringlivestreamID, LivestreamGetActiveLivestreamsForLivestreamIDParams { account_id, app_id } params, RequestOptionsoptions?): LivestreamGetActiveLivestreamsForLivestreamIDResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session
Fetch livestream details using livestream ID
client.realtimeKit.livestreams.getLivestreamSessionForLivestreamID(stringlivestreamID, LivestreamGetLivestreamSessionForLivestreamIDParams { account_id, app_id, page_no, per_page } params, RequestOptionsoptions?): LivestreamGetLivestreamSessionForLivestreamIDResponse { data, paging, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}
ModelsExpand Collapse
LivestreamGetAllLivestreamsResponse { data, paging, success }
data: Array<Data>
id: string

ID of the livestream.

formatuuid
created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time
disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

The server URL to which the RTMP encoder sends the video and audio data.

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string | null

ID of the meeting being livestreamed, if any.

name: string | null

Name of the livestream.

playback_url: string

The web address that viewers can use to watch the livestream.

status: "LIVE" | "IDLE" | "ERRORED" | 2 more

Status of the livestream.

One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
"METRICS_READY"
stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time
paging: Paging { end_offset, start_offset, total_count }
end_offset: number
start_offset: number
total_count: number
minimum0
success: boolean
LivestreamGetLivestreamSessionDetailsForMeetingResponse { data, success }
data: Data { data, paging }
data: Data { livestream, sessions }
livestream: Livestream { id, created_at, disabled, 9 more }
id: string

ID of the livestream.

formatuuid
created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time
disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

The server URL to which the RTMP encoder sends the video and audio data.

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string | null

ID of the meeting being livestreamed, if any.

name: string | null

Name of the livestream.

playback_url: string

The web address that viewers can use to watch the livestream.

status: "LIVE" | "IDLE" | "ERRORED" | 2 more

Status of the livestream.

One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
"METRICS_READY"
stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time
sessions: Array<Session>
id: string

ID of the livestream session.

formatuuid
created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time
err_message: string | null

Error message, if the livestream session failed.

ingest_seconds: number

The time duration for which the input was given or the meeting was streamed.

invoked_time: string | null

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time
livestream_id: string

ID of the livestream.

formatuuid
started_time: string | null

Timestamp the livestream session started at, in ISO format.

formatdate-time
stopped_time: string | null

Timestamp the livestream session stopped at, in ISO format.

formatdate-time
updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time
viewer_seconds: number

The total view time for which the viewers watched the stream.

paging: Paging { end_offset, start_offset, total_count }
end_offset: number
start_offset: number
total_count: number
minimum0
success: boolean
LivestreamGetLivestreamSessionsForSessionResponse { data, success }
data: Data { data, paging }
data: Array<Data>
id: string

ID of the livestream session.

formatuuid
created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time
err_message: string | null

Error message, if the livestream session failed.

ingest_seconds: number

The time duration for which the input was given or the meeting was streamed.

invoked_time: string | null

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time
livestream_id: string

ID of the livestream.

formatuuid
started_time: string | null

Timestamp the livestream session started at, in ISO format.

formatdate-time
stopped_time: string | null

Timestamp the livestream session stopped at, in ISO format.

formatdate-time
updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time
viewer_seconds: number

The total view time for which the viewers watched the stream.

paging: Paging { end_offset, start_offset, total_count }
end_offset: number
start_offset: number
total_count: number
minimum0
success: boolean
LivestreamStopLivestreamingAMeetingResponse { data, success }
data?: Data { message }
message?: string
success?: boolean
LivestreamStartLivestreamingAMeetingResponse { data, success }
data: Data { id, ingest_server, meeting_id, 4 more }
id: string

ID of the livestream.

formatuuid
ingest_server: string

The server URL to which the RTMP encoder sends the video and audio data.

meeting_id: string | null

ID of the meeting being livestreamed, if any.

name: string | null

Name of the livestream.

playback_url: string

The web address that viewers can use to watch the livestream.

status: "LIVE" | "IDLE" | "ERRORED" | 2 more

Status of the livestream.

One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
"METRICS_READY"
stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

success: boolean
LivestreamGetLivestreamAnalyticsCompleteResponse { data, success }
data?: Data { count, total_ingest_seconds, total_viewer_seconds }
count?: number

Count of total livestreams.

total_ingest_seconds?: number

Total time duration for which the input was given or the meeting was streamed.

total_viewer_seconds?: number

Total view time for which the viewers watched the stream.

success?: boolean
LivestreamGetLivestreamAnalyticsDaywiseResponse { data, success }
data?: Array<Data>
count?: number

Count of total livestream sessions.

date?: string | null

Analytics date.

total_ingest_seconds?: number

Total time duration for which the input was given or the meeting was streamed.

total_viewer_seconds?: number

Total view time for which the viewers watched the stream.

success?: boolean
LivestreamGetOrgAnalyticsResponse { data, success }
data?: Data { recording_stats, session_stats }
recording_stats?: RecordingStats { day_stats, recording_count, recording_minutes_consumed }

Recording statistics of an App during the range specified

day_stats?: Array<DayStat>

Day wise recording stats

day?: string
total_recording_minutes?: number

Total recording minutes for a specific day

total_recordings?: number

Total number of recordings for a specific day

recording_count?: number

Total number of recordings during the range specified

recording_minutes_consumed?: number

Total recording minutes during the range specified

session_stats?: SessionStats { day_stats, sessions_count, sessions_minutes_consumed }

Session statistics of an App during the range specified

day_stats?: Array<DayStat>

Day wise session stats

day?: string
total_session_minutes?: number

Total session minutes for a specific day

total_sessions?: number

Total number of sessions for a specific day

sessions_count?: number

Total number of sessions during the range specified

sessions_minutes_consumed?: number

Total session minutes during the range specified

success?: boolean
LivestreamGetMeetingActiveLivestreamsResponse { data, success }
data: Data { id, created_at, disabled, 9 more }
id: string

ID of the livestream.

formatuuid
created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time
disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

The server URL to which the RTMP encoder sends the video and audio data.

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string | null

ID of the meeting being livestreamed, if any.

name: string | null

Name of the livestream.

playback_url: string

The web address that viewers can use to watch the livestream.

status: "LIVE" | "IDLE" | "ERRORED" | 2 more

Status of the livestream.

One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
"METRICS_READY"
stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time
success: boolean
LivestreamGetLivestreamSessionDetailsForSessionIDResponse { data, success }
data: Data { id, created_at, err_message, 7 more }
id: string

ID of the livestream session.

formatuuid
created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time
err_message: string | null

Error message, if the livestream session failed.

ingest_seconds: number

The time duration for which the input was given or the meeting was streamed.

invoked_time: string | null

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time
livestream_id: string

ID of the livestream.

formatuuid
started_time: string | null

Timestamp the livestream session started at, in ISO format.

formatdate-time
stopped_time: string | null

Timestamp the livestream session stopped at, in ISO format.

formatdate-time
updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time
viewer_seconds: number

The total view time for which the viewers watched the stream.

success: boolean
LivestreamGetActiveLivestreamsForLivestreamIDResponse { data, success }
data: Data { livestream, session }
livestream: Livestream { id, created_at, disabled, 9 more }
id: string

ID of the livestream.

formatuuid
created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time
disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

The server URL to which the RTMP encoder sends the video and audio data.

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string | null

ID of the meeting being livestreamed, if any.

name: string | null

Name of the livestream.

playback_url: string

The web address that viewers can use to watch the livestream.

status: "LIVE" | "IDLE" | "ERRORED" | 2 more

Status of the livestream.

One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
"METRICS_READY"
stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time
session: Session { id, created_at, err_message, 7 more }
id: string

ID of the livestream session.

formatuuid
created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time
err_message: string | null

Error message, if the livestream session failed.

ingest_seconds: number

The time duration for which the input was given or the meeting was streamed.

invoked_time: string | null

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time
livestream_id: string

ID of the livestream.

formatuuid
started_time: string | null

Timestamp the livestream session started at, in ISO format.

formatdate-time
stopped_time: string | null

Timestamp the livestream session stopped at, in ISO format.

formatdate-time
updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time
viewer_seconds: number

The total view time for which the viewers watched the stream.

success: boolean
LivestreamGetLivestreamSessionForLivestreamIDResponse { data, paging, success }
data: Data { livestream, sessions }
livestream: Livestream { id, created_at, disabled, 9 more }
id: string

ID of the livestream.

formatuuid
created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time
disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

The server URL to which the RTMP encoder sends the video and audio data.

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string | null

ID of the meeting being livestreamed, if any.

name: string | null

Name of the livestream.

playback_url: string

The web address that viewers can use to watch the livestream.

status: "LIVE" | "IDLE" | "ERRORED" | 2 more

Status of the livestream.

One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
"METRICS_READY"
stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time
sessions: Array<Session>
id: string

ID of the livestream session.

formatuuid
created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time
err_message: string | null

Error message, if the livestream session failed.

ingest_seconds: number

The time duration for which the input was given or the meeting was streamed.

invoked_time: string | null

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time
livestream_id: string

ID of the livestream.

formatuuid
started_time: string | null

Timestamp the livestream session started at, in ISO format.

formatdate-time
stopped_time: string | null

Timestamp the livestream session stopped at, in ISO format.

formatdate-time
updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time
viewer_seconds: number

The total view time for which the viewers watched the stream.

paging: Paging { end_offset, start_offset, total_count }
end_offset: number
start_offset: number
total_count: number
minimum0
success: boolean