rum_replay_playlist_sessions

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

Overview

Name	rum_replay_playlist_sessions
Type	Resource
Id	datadog.digital_experience.rum_replay_playlist_sessions

Fields

The following fields are returned by SELECT queries:

list_rum_replay_playlist_sessions

Name	Datatype	Description
id	string	Unique identifier of the RUM replay session.
attributes	object	Attributes of a session within a playlist, including the session event data and its replay track.
type	string	Rum replay session resource type. (rum_replay_session) (default: rum_replay_session, example: rum_replay_session)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_rum_replay_playlist_sessions	select	playlist_id	page[number], page[size]	List sessions in a playlist.
add_rum_replay_session_to_playlist	replace	ts, playlist_id, session_id	data_source	Add a session to a playlist.
remove_rum_replay_session_from_playlist	delete	playlist_id, session_id		Remove a session from a playlist.
bulk_remove_rum_replay_playlist_sessions	delete	playlist_id		Remove sessions from a playlist.

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.

Name	Datatype	Description
playlist_id	integer (int64)	Unique identifier of the playlist.
session_id	string	Unique identifier of the session.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
ts	integer (int64)	Server-side timestamp in milliseconds.
data_source	string	Data source type. Valid values: 'rum' or 'product_analytics'. Defaults to 'rum'.
page[number]	integer (int64)	Page number for pagination (0-indexed).
page[size]	integer (int64)	Number of items per page.

SELECT examples

list_rum_replay_playlist_sessions

List sessions in a playlist.

SELECT
id,
attributes,
type
FROM datadog.digital_experience.rum_replay_playlist_sessions
WHERE playlist_id = '{{ playlist_id }}' -- required
AND page[number] = '{{ page[number] }}'
AND page[size] = '{{ page[size] }}'
;

REPLACE examples

add_rum_replay_session_to_playlist

Add a session to a playlist.

REPLACE datadog.digital_experience.rum_replay_playlist_sessions
SET 
-- No updatable properties
WHERE 
ts = '{{ ts }}' --required
AND playlist_id = '{{ playlist_id }}' --required
AND session_id = '{{ session_id }}' --required
AND data_source = '{{ data_source}}'
RETURNING
data;

DELETE examples

remove_rum_replay_session_from_playlist

Remove a session from a playlist.

DELETE FROM datadog.digital_experience.rum_replay_playlist_sessions
WHERE playlist_id = '{{ playlist_id }}' --required
AND session_id = '{{ session_id }}' --required
;

bulk_remove_rum_replay_playlist_sessions

Remove sessions from a playlist.

DELETE FROM datadog.digital_experience.rum_replay_playlist_sessions
WHERE playlist_id = '{{ playlist_id }}' --required
;