--- title: Livestreams --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Realtime Kit](https://developers.cloudflare.com/api/typescript/resources/realtime_kit) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Livestreams ##### [Fetch all livestreams](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/get_all_livestreams) client.realtimeKit.livestreams.getAllLivestreams(stringappID, LivestreamGetAllLivestreamsParams {account\_id, end\_time, exclude\_meetings, 5 more } params, RequestOptionsoptions?): [LivestreamGetAllLivestreamsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/livestreams ##### [Stop livestreaming a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/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](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/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](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/get_livestream_analytics_complete) 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](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/get_livestream_analytics_daywise) 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](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/get_org_analytics) 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](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/get_meeting_active_livestreams) 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](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/get_livestream_session_details_for_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](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/get_active_livestreams_for_livestream_id) 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](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/livestreams/methods/get_livestream_session_for_livestream_id) client.realtimeKit.livestreams.getLivestreamSessionForLivestreamID(stringlivestreamID, LivestreamGetLivestreamSessionForLivestreamIDParams {account\_id, app\_id, page\_no, per\_page } params, RequestOptionsoptions?): [LivestreamGetLivestreamSessionForLivestreamIDResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/livestreams/{livestream\_id} ##### ModelsExpand Collapse
LivestreamGetAllLivestreamsResponse {data, success }
data?: Data {id, created\_at, disabled, 8 more } id?: string The ID of the livestream. formatuuid Link to this property created\_at?: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property disabled?: string Specifies if the livestream was disabled. Link to this property ingest\_server?: string The server URL to which the RTMP encoder sends the video and audio data. Link to this property meeting\_id?: string ID of the meeting. Link to this property name?: string Name of the livestream. Link to this property
paging?: Paging {end\_offset, start\_offset, total\_count } end\_offset?: number Link to this property start\_offset?: number Link to this property total\_count?: number Link to this property
Link to this property playback\_url?: string The web address that viewers can use to watch the livestream. Link to this property
status?: "LIVE"| "IDLE"| "ERRORED"| "INVOKED" One of the following: "LIVE" Link to this property "IDLE" Link to this property "ERRORED" Link to this property "INVOKED" Link to this property
Link to this property stream\_key?: string Unique key for accessing each livestream. Link to this property updated\_at?: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_get_all_livestreams_response%20%3E%20(schema)>)
LivestreamStopLivestreamingAMeetingResponse {data, success }
data?: Data {message } message?: string Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_stop_livestreaming_a_meeting_response%20%3E%20(schema)>)
LivestreamStartLivestreamingAMeetingResponse {data, success }
data?: Data {id, ingest\_server, playback\_url, 2 more } id?: string The livestream ID. Link to this property ingest\_server?: string The server URL to which the RTMP encoder sends the video and audio data. Link to this property playback\_url?: string The web address that viewers can use to watch the livestream. Link to this property
status?: "LIVE"| "IDLE"| "ERRORED"| "INVOKED" One of the following: "LIVE" Link to this property "IDLE" Link to this property "ERRORED" Link to this property "INVOKED" Link to this property
Link to this property stream\_key?: string Unique key for accessing each livestream. Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_start_livestreaming_a_meeting_response%20%3E%20(schema)>)
LivestreamGetLivestreamAnalyticsCompleteResponse {data, success }
data?: Data {count, total\_ingest\_seconds, total\_viewer\_seconds } count?: number Count of total livestreams. Link to this property total\_ingest\_seconds?: number Total time duration for which the input was given or the meeting was streamed. Link to this property total\_viewer\_seconds?: number Total view time for which the viewers watched the stream. Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_get_livestream_analytics_complete_response%20%3E%20(schema)>)
LivestreamGetLivestreamAnalyticsDaywiseResponse {data, success }
data?: Array<Data> count?: number Count of total livestream sessions. Link to this property date?: string| null Analytics date. Link to this property total\_ingest\_seconds?: number Total time duration for which the input was given or the meeting was streamed. Link to this property total\_viewer\_seconds?: number Total view time for which the viewers watched the stream. Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_get_livestream_analytics_daywise_response%20%3E%20(schema)>)
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 Link to this property total\_recording\_minutes?: number Total recording minutes for a specific day Link to this property total\_recordings?: number Total number of recordings for a specific day Link to this property
Link to this property recording\_count?: number Total number of recordings during the range specified Link to this property recording\_minutes\_consumed?: number Total recording minutes during the range specified Link to this property
Link to this property
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 Link to this property total\_session\_minutes?: number Total session minutes for a specific day Link to this property total\_sessions?: number Total number of sessions for a specific day Link to this property
Link to this property sessions\_count?: number Total number of sessions during the range specified Link to this property sessions\_minutes\_consumed?: number Total session minutes during the range specified Link to this property
Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_get_org_analytics_response%20%3E%20(schema)>)
LivestreamGetMeetingActiveLivestreamsResponse {data, success }
data?: Data {id, created\_at, disabled, 7 more } id?: string The livestream ID. Link to this property created\_at?: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property disabled?: string Specifies if the livestream was disabled. Link to this property ingest\_server?: string The server URL to which the RTMP encoder sends the video and audio data. Link to this property meeting\_id?: string Link to this property name?: string| null Name of the livestream. Link to this property playback\_url?: string The web address that viewers can use to watch the livestream. Link to this property
status?: "LIVE"| "IDLE"| "ERRORED"| "INVOKED" One of the following: "LIVE" Link to this property "IDLE" Link to this property "ERRORED" Link to this property "INVOKED" Link to this property
Link to this property stream\_key?: string Unique key for accessing each livestream. Link to this property updated\_at?: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_get_meeting_active_livestreams_response%20%3E%20(schema)>)
LivestreamGetLivestreamSessionDetailsForSessionIDResponse {data, success }
data?: Data {id, created\_at, err\_message, 6 more } id?: string The livestream ID. Link to this property created\_at?: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property err\_message?: string The server URL to which the RTMP encoder sends the video and audio data. Link to this property ingest\_seconds?: number Name of the livestream. Link to this property livestream\_id?: string Link to this property started\_time?: string Unique key for accessing each livestream. Link to this property stopped\_time?: string The web address that viewers can use to watch the livestream. Link to this property updated\_at?: string Timestamp the object was updated at. The time is returned in ISO format. Link to this property viewer\_seconds?: number Specifies if the livestream was disabled. Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_get_livestream_session_details_for_session_id_response%20%3E%20(schema)>)
LivestreamGetActiveLivestreamsForLivestreamIDResponse {data, success }
data?: Data {livestream, session }
livestream?: Livestream {id, created\_at, disabled, 7 more } id?: string Link to this property created\_at?: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property disabled?: string Specifies if the livestream was disabled. Link to this property ingest\_server?: string The server URL to which the RTMP encoder sends the video and audio data. Link to this property meeting\_id?: string ID of the meeting. Link to this property name?: string Name of the livestream. Link to this property playback\_url?: string The web address that viewers can use to watch the livestream. Link to this property
status?: "LIVE"| "IDLE"| "ERRORED"| "INVOKED" One of the following: "LIVE" Link to this property "IDLE" Link to this property "ERRORED" Link to this property "INVOKED" Link to this property
Link to this property stream\_key?: string Unique key for accessing each livestream. Link to this property updated\_at?: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
Link to this property
session?: Session {id, created\_at, err\_message, 7 more } id?: string Link to this property created\_at?: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property err\_message?: string Link to this property ingest\_seconds?: string The time duration for which the input was given or the meeting was streamed. Link to this property invoked\_time?: string Timestamp the object was invoked. The time is returned in ISO format. formatdate-time Link to this property livestream\_id?: string Link to this property started\_time?: string Timestamp the object was started. The time is returned in ISO format. formatdate-time Link to this property stopped\_time?: string Timestamp the object was stopped. The time is returned in ISO format. formatdate-time Link to this property updated\_at?: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property viewer\_seconds?: string The total view time for which the viewers watched the stream. Link to this property
Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_get_active_livestreams_for_livestream_id_response%20%3E%20(schema)>)
LivestreamGetLivestreamSessionForLivestreamIDResponse {data, success }
data?: Data {livestream, paging, session }
livestream?: Livestream {id, created\_at, disabled, 7 more } id?: string ID of the livestream. Link to this property created\_at?: string Timestamp the object was created at. The time is returned in ISO format. Link to this property disabled?: string Specifies if the livestream was disabled. Link to this property ingest\_server?: string The server URL to which the RTMP encoder sends the video and audio data. Link to this property meeting\_id?: string The ID of the meeting. Link to this property name?: string Name of the livestream. Link to this property playback\_url?: string The web address that viewers can use to watch the livestream. Link to this property
status?: "LIVE"| "IDLE"| "ERRORED"| "INVOKED" One of the following: "LIVE" Link to this property "IDLE" Link to this property "ERRORED" Link to this property "INVOKED" Link to this property
Link to this property stream\_key?: string Unique key for accessing each livestream. Link to this property updated\_at?: string Timestamp the object was updated at. The time is returned in ISO format. Link to this property
Link to this property
paging?: Paging {end\_offset, start\_offset, total\_count } end\_offset?: number Link to this property start\_offset?: number Link to this property total\_count?: number Link to this property
Link to this property
session?: Session {id, created\_at, err\_message, 7 more } id?: string ID of the session. Link to this property created\_at?: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property err\_message?: string Link to this property ingest\_seconds?: number The time duration for which the input was given or the meeting was streamed. Link to this property invoked\_time?: string Timestamp the object was invoked. The time is returned in ISO format. formatdate-time Link to this property livestream\_id?: string Link to this property started\_time?: string Timestamp the object was started. The time is returned in ISO format. formatdate-time Link to this property stopped\_time?: string Timestamp the object was stopped. The time is returned in ISO format. formatdate-time Link to this property updated\_at?: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property viewer\_seconds?: number The total view time for which the viewers watched the stream. Link to this property
Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.livestreams%20%3E%20(model)%20livestream_get_livestream_session_for_livestream_id_response%20%3E%20(schema)>)