replay_heatmap_snapshots

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

Overview

Name	replay_heatmap_snapshots
Type	Resource
Id	datadog.digital_experience.replay_heatmap_snapshots

Fields

The following fields are returned by SELECT queries:

list_replay_heatmap_snapshots

Name	Datatype	Description
id	string	Unique identifier of the heatmap snapshot.
attributes	object	Attributes of a heatmap snapshot, including view context, device information, and audit metadata.
type	string	Snapshots resource type. (snapshots) (default: snapshots, example: snapshots)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_replay_heatmap_snapshots	select	filter[view_name]	filter[device_type], page[limit], filter[application_id]	List heatmap snapshots.
create_replay_heatmap_snapshot	insert	data		Create a heatmap snapshot.
update_replay_heatmap_snapshot	update	snapshot_id, data		Update a heatmap snapshot.
delete_replay_heatmap_snapshot	delete	snapshot_id		Delete a heatmap snapshot.

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
filter[view_name]	string	View name to filter snapshots.
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.
snapshot_id	string	Unique identifier of the heatmap snapshot.
filter[application_id]	string	Filter by application ID.
filter[device_type]	string	Device type to filter snapshots.
page[limit]	integer (int64)	Maximum number of snapshots to return.

SELECT examples

list_replay_heatmap_snapshots

List heatmap snapshots.

SELECT
id,
attributes,
type
FROM datadog.digital_experience.replay_heatmap_snapshots
WHERE filter[view_name] = '{{ filter[view_name] }}' -- required
AND filter[device_type] = '{{ filter[device_type] }}'
AND page[limit] = '{{ page[limit] }}'
AND filter[application_id] = '{{ filter[application_id] }}'
;

INSERT examples

create_replay_heatmap_snapshot

Create a heatmap snapshot.

INSERT INTO datadog.digital_experience.replay_heatmap_snapshots (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: replay_heatmap_snapshots
props:
  - name: data
    description: |
      Data object for a heatmap snapshot creation request, containing the resource type and attributes.
    value:
      attributes:
        application_id: "{{ application_id }}"
        device_type: "{{ device_type }}"
        event_id: "{{ event_id }}"
        is_device_type_selected_by_user: {{ is_device_type_selected_by_user }}
        session_id: "{{ session_id }}"
        snapshot_name: "{{ snapshot_name }}"
        start: {{ start }}
        view_id: "{{ view_id }}"
        view_name: "{{ view_name }}"
      type: "{{ type }}"

UPDATE examples

update_replay_heatmap_snapshot

Update a heatmap snapshot.

UPDATE datadog.digital_experience.replay_heatmap_snapshots
SET 
data = '{{ data }}'
WHERE 
snapshot_id = '{{ snapshot_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_replay_heatmap_snapshot

Delete a heatmap snapshot.

DELETE FROM datadog.digital_experience.replay_heatmap_snapshots
WHERE snapshot_id = '{{ snapshot_id }}' --required
;