rum_operations

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

Overview

Name	rum_operations
Type	Resource
Id	datadog.digital_experience.rum_operations

Fields

The following fields are returned by SELECT queries:

get_rumoperation

Name	Datatype	Description
id	string	The unique identifier of the RUM operation. (example: abc12345-1234-5678-abcd-ef1234567890)
attributes	object	Attributes of a RUM operation response.
type	string	The JSON:API type for RUM operation resources. (operations) (example: operations)

list_rumoperations

Name	Datatype	Description
id	string	The unique identifier of the RUM operation. (example: abc12345-1234-5678-abcd-ef1234567890)
attributes	object	Attributes of a RUM operation response.
type	string	The JSON:API type for RUM operation resources. (operations) (example: operations)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_rumoperation	select	rum_operation_id		Retrieve a specific RUM operation by its unique identifier.
list_rumoperations	select		query, page[offset], page[limit], creator, team, feature_id, application_id	Search RUM operations for your organization. Supports filtering by query, creator, team, feature, and application.
create_rumoperation	insert	data		Create a new RUM operation, defining the journey used to detect it from RUM events.
update_rumoperation	replace	rum_operation_id, data		Update an existing RUM operation. Fields omitted from the request body keep their existing value,<br />with the exception of journey_rum, which is required and fully replaced on every update.
delete_rumoperation	delete	rum_operation_id		Delete a RUM operation.

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
rum_operation_id	string	The unique identifier of the RUM operation to delete.
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.
application_id	string (uuid)	Filter operations by RUM application ID.
creator	string	Filter operations by the email of their creator.
feature_id	string	Filter operations by feature ID. Accepts a comma-separated list of feature IDs.
page[limit]	integer (int64)	Number of items per page. Maximum of 100.
page[offset]	integer (int64)	Offset for pagination.
query	string	A search query to filter operations by name.
team	string	Filter operations by team. Accepts a comma-separated list of teams.

SELECT examples

get_rumoperation

Retrieve a specific RUM operation by its unique identifier.

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

list_rumoperations

Search RUM operations for your organization. Supports filtering by query, creator, team, feature, and application.

SELECT
id,
attributes,
type
FROM datadog.digital_experience.rum_operations
WHERE query = '{{ query }}'
AND page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
AND creator = '{{ creator }}'
AND team = '{{ team }}'
AND feature_id = '{{ feature_id }}'
AND application_id = '{{ application_id }}'
;

INSERT examples

create_rumoperation

Create a new RUM operation, defining the journey used to detect it from RUM events.

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

Manifest

# Description fields are for documentation purposes
- name: rum_operations
props:
  - name: data
    description: |
      The data object for creating a RUM operation.
    value:
      attributes:
        application_id: "{{ application_id }}"
        category: "{{ category }}"
        description: "{{ description }}"
        display_name: "{{ display_name }}"
        feature_ids:
          - "{{ feature_ids }}"
        journey_rum:
          rum_steps:
            - composite:
                composite_rule_id: "{{ composite_rule_id }}"
                config_version: "{{ config_version }}"
                kind: "{{ kind }}"
                max_window_ms: {{ max_window_ms }}
                predicates: "{{ predicates }}"
              nodes: "{{ nodes }}"
              type: "{{ type }}"
        name: "{{ name }}"
        tags:
          - "{{ tags }}"
      type: "{{ type }}"

REPLACE examples

update_rumoperation

Update an existing RUM operation. Fields omitted from the request body keep their existing value,<br />with the exception of journey_rum, which is required and fully replaced on every update.

REPLACE datadog.digital_experience.rum_operations
SET 
data = '{{ data }}'
WHERE 
rum_operation_id = '{{ rum_operation_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_rumoperation

Delete a RUM operation.

DELETE FROM datadog.digital_experience.rum_operations
WHERE rum_operation_id = '{{ rum_operation_id }}' --required
;