Skip to main content

kit_sessions

Creates, updates, deletes, gets or lists a kit_sessions resource.

Overview

Namekit_sessions
TypeResource
Idcloudflare.realtime_kit.kit_sessions

Fields

The following fields are returned by SELECT queries:

Get details about a particular session

NameDatatypeDescription
dataobject
successboolean

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_by_accountselectaccount_id, app_id, session_idinclude_breakout_roomsReturns data of the given session ID including recording details.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.
app_idstringThe Access application ID.
session_idstringThe session ID.
include_breakout_roomsbooleanList all breakout rooms

SELECT examples

Returns data of the given session ID including recording details.

SELECT
data,
success
FROM cloudflare.realtime_kit.kit_sessions
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND session_id = '{{ session_id }}' -- required
AND include_breakout_rooms = '{{ include_breakout_rooms }}'
;