Fetch livestream session details using a session ID

realtime_kit.livestreams.get_livestream_sessions_for_session(, ) -> LivestreamGetLivestreamSessionsForSessionResponse

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

ParametersExpand Collapse

account_id: str

The account identifier tag.

maxLength32

app_id: str

The app identifier tag.

session_id: str

formatuuid

page_no: Optional[float]

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

per_page: Optional[float]

Number of results per page.

ReturnsExpand Collapse

class LivestreamGetLivestreamSessionsForSessionResponse: …

data: Data

data: List[DataData]

id: str

ID of the livestream session.

formatuuid

created_at: datetime

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

formatdate-time

err_message: Optional[str]

Error message, if the livestream session failed.

ingest_seconds: float

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

invoked_time: Optional[datetime]

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

formatdate-time

livestream_id: str

ID of the livestream.

formatuuid

started_time: Optional[datetime]

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: Optional[datetime]

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: datetime

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

formatdate-time

viewer_seconds: float

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

paging: DataPaging

end_offset: float

start_offset: float

total_count: float

minimum0

success: bool

Fetch livestream session details using a session ID

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.realtime_kit.livestreams.get_livestream_sessions_for_session(
    session_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    app_id="14a396e7-ca44-4937-bf1f-050a69118543",
)
print(response.data)

{
  "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
}