rum_retention_filters

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

Overview

Name	rum_retention_filters
Type	Resource
Id	datadog.digital_experience.rum_retention_filters

Fields

The following fields are returned by SELECT queries:

get_retention_filter

Name	Datatype	Description
id	string	ID of retention filter in UUID. (example: 051601eb-54a0-abc0-03f9-cc02efa18892)
attributes	object	The object describing attributes of a RUM retention filter.
type	string	The type of the resource. The value should always be retention_filters. (retention_filters) (default: retention_filters, example: retention_filters)

list_retention_filters

Name	Datatype	Description
id	string	ID of retention filter in UUID. (example: 051601eb-54a0-abc0-03f9-cc02efa18892)
attributes	object	The object describing attributes of a RUM retention filter.
type	string	The type of the resource. The value should always be retention_filters. (retention_filters) (default: retention_filters, example: retention_filters)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_retention_filter	select	app_id, rf_id		Get a RUM retention filter for a RUM application.
list_retention_filters	select	app_id		Get the list of RUM retention filters for a RUM application.
create_retention_filter	insert	app_id, data		Create a RUM retention filter for a RUM application.<br />Returns RUM retention filter objects from the request body when the request is successful.
update_retention_filter	update	app_id, rf_id, data		Update a RUM retention filter for a RUM application.<br />Returns RUM retention filter objects from the request body when the request is successful.
delete_retention_filter	delete	app_id, rf_id		Delete a RUM retention filter for a RUM application.
order_retention_filters	exec	app_id		Order RUM retention filters for a RUM application.<br />Returns RUM retention filter objects without attributes from the request body when the request is successful.

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
app_id	string	RUM application ID.
rf_id	string	Retention filter ID.
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.

SELECT examples

get_retention_filter

Get a RUM retention filter for a RUM application.

SELECT
id,
attributes,
type
FROM datadog.digital_experience.rum_retention_filters
WHERE app_id = '{{ app_id }}' -- required
AND rf_id = '{{ rf_id }}' -- required
;

list_retention_filters

Get the list of RUM retention filters for a RUM application.

SELECT
id,
attributes,
type
FROM datadog.digital_experience.rum_retention_filters
WHERE app_id = '{{ app_id }}' -- required
;

INSERT examples

create_retention_filter

Create a RUM retention filter for a RUM application.<br />Returns RUM retention filter objects from the request body when the request is successful.

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

Manifest

# Description fields are for documentation purposes
- name: rum_retention_filters
props:
  - name: app_id
    value: "{{ app_id }}"
    description: Required parameter for the rum_retention_filters resource.
  - name: data
    description: |
      The new RUM retention filter properties to create.
    value:
      attributes:
        cross_product_sampling:
          trace_enabled: {{ trace_enabled }}
          trace_sample_rate: {{ trace_sample_rate }}
        enabled: {{ enabled }}
        event_type: "{{ event_type }}"
        name: "{{ name }}"
        query: "{{ query }}"
        sample_rate: {{ sample_rate }}
      type: "{{ type }}"

UPDATE examples

update_retention_filter

Update a RUM retention filter for a RUM application.<br />Returns RUM retention filter objects from the request body when the request is successful.

UPDATE datadog.digital_experience.rum_retention_filters
SET 
data = '{{ data }}'
WHERE 
app_id = '{{ app_id }}' --required
AND rf_id = '{{ rf_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_retention_filter

Delete a RUM retention filter for a RUM application.

DELETE FROM datadog.digital_experience.rum_retention_filters
WHERE app_id = '{{ app_id }}' --required
AND rf_id = '{{ rf_id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

order_retention_filters

Order RUM retention filters for a RUM application.<br />Returns RUM retention filter objects without attributes from the request body when the request is successful.

EXEC datadog.digital_experience.rum_retention_filters.order_retention_filters 
@app_id='{{ app_id }}' --required, 
@@json=
'{
"data": "{{ data }}"
}'
;