rum_events

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

Overview

Name	rum_events
Type	Resource
Id	datadog.digital_experience.rum_events

Fields

The following fields are returned by SELECT queries:

list_rumevents

Name	Datatype	Description
id	string	Unique ID of the event. (example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA)
attributes	object	JSON object containing all event attributes and their associated values.
type	string	Type of the event. (rum) (default: rum, example: rum)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_rumevents	select		filter[query], filter[from], filter[to], sort, page[cursor], page[limit]	List endpoint returns events that match a RUM search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to see your latest RUM events.<br /><br />[1]: https:​//docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination
aggregate_rumevents	exec			The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries.
search_rumevents	exec			List endpoint returns RUM events that match a RUM search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to build complex RUM events filtering and search.<br /><br />[1]: https:​//docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination

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
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.
filter[from]	string (date-time)	Minimum timestamp for requested events. (example: 2019-01-02T09:42:36.320Z)
filter[query]	string	Search query following RUM syntax. (example: @type:session @application_id:xxxx)
filter[to]	string (date-time)	Maximum timestamp for requested events. (example: 2019-01-03T09:42:36.320Z)
page[cursor]	string	List following results with a cursor provided in the previous query. (example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==)
page[limit]	integer (int32)	Maximum number of events in the response. (example: 25)
sort	string	Order of events in results.

SELECT examples

list_rumevents

List endpoint returns events that match a RUM search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to see your latest RUM events.<br /><br />[1]: https:​//docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination

SELECT
id,
attributes,
type
FROM datadog.digital_experience.rum_events
WHERE filter[query] = '{{ filter[query] }}'
AND filter[from] = '{{ filter[from] }}'
AND filter[to] = '{{ filter[to] }}'
AND sort = '{{ sort }}'
AND page[cursor] = '{{ page[cursor] }}'
AND page[limit] = '{{ page[limit] }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

aggregate_rumevents

The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries.

EXEC datadog.digital_experience.rum_events.aggregate_rumevents 
@@json=
'{
"compute": "{{ compute }}", 
"filter": "{{ filter }}", 
"group_by": "{{ group_by }}", 
"options": "{{ options }}", 
"page": "{{ page }}"
}'
;

search_rumevents

List endpoint returns RUM events that match a RUM search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to build complex RUM events filtering and search.<br /><br />[1]: https:​//docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination

EXEC datadog.digital_experience.rum_events.search_rumevents 
@@json=
'{
"filter": "{{ filter }}", 
"options": "{{ options }}", 
"page": "{{ page }}", 
"sort": "{{ sort }}"
}'
;