rum_application_retention_filter_exclusions

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

Overview

Name	rum_application_retention_filter_exclusions
Type	Resource
Id	datadog.digital_experience.rum_application_retention_filter_exclusions

Fields

The following fields are returned by SELECT queries:

get_exclusion_filter

Name	Datatype	Description
id	string	The ID of the exclusion filter. (example: 051601eb-54a0-abc0-03f9-cc02efa18892)
attributes	object	The attributes of an exclusion filter.
meta	object	Metadata about the exclusion filter.
type	string	The resource type. The value must be exclusion_filters. (exclusion_filters) (default: exclusion_filters, example: exclusion_filters)

list_exclusion_filters

Name	Datatype	Description
id	string	The ID of the exclusion filter. (example: 051601eb-54a0-abc0-03f9-cc02efa18892)
attributes	object	The attributes of an exclusion filter.
meta	object	Metadata about the exclusion filter.
type	string	The resource type. The value must be exclusion_filters. (exclusion_filters) (default: exclusion_filters, example: exclusion_filters)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_exclusion_filter	select	app_id, ef_id		Get a single exclusion filter for a RUM application.
list_exclusion_filters	select	app_id		Get the list of exclusion filters for a RUM application.<br />The built-in Error Tracking exclusion filter (error_tracking_exclusion_filter) is always returned first.
create_exclusion_filter	insert	app_id, data		Create an exclusion filter for a RUM application.<br />Returns the created exclusion filter when the request is successful.
update_exclusion_filter	update	app_id, ef_id, data		Update an exclusion filter for a RUM application.<br />For the built-in Error Tracking exclusion filter (error_tracking_exclusion_filter), only enabled can be<br />updated; name, event_type, and query must be omitted.<br />Returns the updated exclusion filter when the request is successful.
delete_exclusion_filter	delete	app_id, ef_id		Delete an exclusion filter for a RUM application.<br />The built-in Error Tracking exclusion filter (error_tracking_exclusion_filter) cannot be deleted;<br />attempting to do so returns a 405 Method Not Allowed response.

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.
ef_id	string	Exclusion 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_exclusion_filter

Get a single exclusion filter for a RUM application.

SELECT
id,
attributes,
meta,
type
FROM datadog.digital_experience.rum_application_retention_filter_exclusions
WHERE app_id = '{{ app_id }}' -- required
AND ef_id = '{{ ef_id }}' -- required
;

list_exclusion_filters

Get the list of exclusion filters for a RUM application.<br />The built-in Error Tracking exclusion filter (error_tracking_exclusion_filter) is always returned first.

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

INSERT examples

create_exclusion_filter

Create an exclusion filter for a RUM application.<br />Returns the created exclusion filter when the request is successful.

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

Manifest

# Description fields are for documentation purposes
- name: rum_application_retention_filter_exclusions
props:
  - name: app_id
    value: "{{ app_id }}"
    description: Required parameter for the rum_application_retention_filter_exclusions resource.
  - name: data
    description: |
      The new exclusion filter properties to create.
    value:
      attributes:
        enabled: {{ enabled }}
        event_type: "{{ event_type }}"
        name: "{{ name }}"
        query: "{{ query }}"
      type: "{{ type }}"

UPDATE examples

update_exclusion_filter

Update an exclusion filter for a RUM application.<br />For the built-in Error Tracking exclusion filter (error_tracking_exclusion_filter), only enabled can be<br />updated; name, event_type, and query must be omitted.<br />Returns the updated exclusion filter when the request is successful.

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

DELETE examples

delete_exclusion_filter

Delete an exclusion filter for a RUM application.<br />The built-in Error Tracking exclusion filter (error_tracking_exclusion_filter) cannot be deleted;<br />attempting to do so returns a 405 Method Not Allowed response.

DELETE FROM datadog.digital_experience.rum_application_retention_filter_exclusions
WHERE app_id = '{{ app_id }}' --required
AND ef_id = '{{ ef_id }}' --required
;