Fetch livestream session details using a session ID

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

Returns livestream session details for the given session ID. Retreive the session ID using the Fetch all sessions of an App API.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Realtime AdminRealtime

Path ParametersExpand Collapse

account_id: string

The account identifier tag.

maxLength32

app_id: string

The app identifier tag.

session_id: string

formatuuid

Query ParametersExpand Collapse

page_no: optional number

The page number from which you want your page search results to be displayed.

per_page: optional number

Number of results per page.

ReturnsExpand Collapse

data: object { data, paging }

data: array of object { 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

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

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

formatdate-time

livestream_id: string

ID of the livestream.

formatuuid

started_time: string

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: string

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: object { end_offset, start_offset, total_count }

end_offset: number

start_offset: number

total_count: number

minimum0

success: boolean

Fetch livestream session details using a session ID

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/sessions/$SESSION_ID/livestream-sessions \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "data": {
    "data": [
      {
        "created_at": "2023-07-15T07:08:40.742Z",
        "err_message": null,
        "id": "cf55a850-c3fd-46b5-b5d2-25b3b9aa1686",
        "ingest_seconds": 600,
        "invoked_time": "2023-07-15T07:08:26.634Z",
        "livestream_id": "b60ef3da-fbbb-441b-9168-8235b0035248",
        "started_time": "2023-07-15T07:08:39Z",
        "stopped_time": "2023-07-15T07:18:39Z",
        "updated_at": "2023-07-15T07:18:40.742Z",
        "viewer_seconds": 1200
      }
    ],
    "paging": {
      "end_offset": 1,
      "start_offset": 1,
      "total_count": 1
    }
  },
  "success": true
}

Returns Examples

{
  "data": {
    "data": [
      {
        "created_at": "2023-07-15T07:08:40.742Z",
        "err_message": null,
        "id": "cf55a850-c3fd-46b5-b5d2-25b3b9aa1686",
        "ingest_seconds": 600,
        "invoked_time": "2023-07-15T07:08:26.634Z",
        "livestream_id": "b60ef3da-fbbb-441b-9168-8235b0035248",
        "started_time": "2023-07-15T07:08:39Z",
        "stopped_time": "2023-07-15T07:18:39Z",
        "updated_at": "2023-07-15T07:18:40.742Z",
        "viewer_seconds": 1200
      }
    ],
    "paging": {
      "end_offset": 1,
      "start_offset": 1,
      "total_count": 1
    }
  },
  "success": true
}