--- title: Search RUM events description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > RUM --- # Search RUM events{% #search-rum-events %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/rum/events/search | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/rum/events/search | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/rum/events/search | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/rum/events/search | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/rum/events/search | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/rum/events/search | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/rum/events/search | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/rum/events/search | ### Overview List endpoint returns RUM events that match a RUM search query. [Results are paginated](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination.md). Use this endpoint to build complex RUM events filtering and search. This endpoint requires the `rum_apps_read` permission. ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | filter | object | The search and filter query settings. | | filter | from | string | The minimum time for the requested events; supports date (in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date, hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds). | | filter | query | string | The search query following the RUM search syntax. | | filter | to | string | The maximum time for the requested events; supports date (in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date, hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds). | | | options | object | Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails. | | options | time_offset | int64 | The time offset (in seconds) to apply to the query. | | options | timezone | string | The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). | | | page | object | Paging attributes for listing events. | | page | cursor | string | List following results with a cursor provided in the previous query. | | page | limit | int32 | Maximum number of events in the response. | | | sort | enum | Sort parameters when querying events. Allowed enum values: `timestamp,-timestamp` | {% /tab %} {% tab title="Example" %} ##### ```json { "filter": { "from": "now-15m", "query": "@type:session AND @session.type:user", "to": "now" }, "options": { "time_offset": 0, "timezone": "GMT" }, "page": { "limit": 25 }, "sort": "timestamp" } ``` ##### ```json { "filter": { "from": "now-15m", "query": "@type:session AND @session.type:user", "to": "now" }, "options": { "time_offset": 0, "timezone": "GMT" }, "page": { "limit": 2 }, "sort": "timestamp" } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response object with all events matching the request and pagination information. | Parent field | Field | Type | Description | | ------------ | ---------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | Array of events matching the request. | | data | attributes | object | JSON object containing all event attributes and their associated values. | | attributes | attributes | object | JSON object of attributes from RUM events. | | attributes | service | string | The name of the application or service generating RUM events. It is used to switch from RUM to APM, so make sure you define the same value when you use both products. | | attributes | tags | [string] | Array of tags associated with your event. | | attributes | timestamp | date-time | Timestamp of your event. | | data | id | string | Unique ID of the event. | | data | type | enum | Type of the event. Allowed enum values: `rum` | | | links | object | Links attributes. | | links | next | string | Link for the next set of results. Note that the request can also be made using the POST endpoint. | | | meta | object | The metadata associated with a request. | | meta | elapsed | int64 | The time elapsed in milliseconds. | | meta | page | object | Paging attributes. | | page | after | string | The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`. | | meta | request_id | string | The identifier of the request. | | meta | status | enum | The status of the response. Allowed enum values: `done,timeout` | | meta | warnings | [object] | A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response. | | warnings | code | string | A unique code for this type of warning. | | warnings | detail | string | A detailed explanation of this specific warning. | | warnings | title | string | A short human-readable summary of the warning. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "attributes": { "customAttribute": 123, "duration": 2345 }, "service": "web-app", "tags": [ "team:A" ], "timestamp": "2019-01-02T09:42:36.320Z" }, "id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "rum" } ], "links": { "next": "https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo\u0026page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "meta": { "elapsed": 132, "page": { "after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "request_id": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", "status": "done", "warnings": [ { "code": "unknown_index", "detail": "indexes: foo, bar", "title": "One or several indexes are missing or invalid, results hold data from the other indexes" } ] } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Not Authorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/rum/events/search" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "filter": { "from": "now-15m", "query": "@type:session AND @session.type:user", "to": "now" }, "options": { "timezone": "GMT" }, "page": { "cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25 }, "sort": "timestamp" } EOF ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/rum/events/search" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "filter": { "from": "now-15m", "query": "@type:session AND @session.type:user", "to": "now" }, "options": { "timezone": "GMT" }, "page": { "cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25 }, "sort": "timestamp" } EOF ##### ```go // Search RUM events returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { body := datadogV2.RUMSearchEventsRequest{ Filter: &datadogV2.RUMQueryFilter{ From: datadog.PtrString("now-15m"), Query: datadog.PtrString("@type:session AND @session.type:user"), To: datadog.PtrString("now"), }, Options: &datadogV2.RUMQueryOptions{ TimeOffset: datadog.PtrInt64(0), Timezone: datadog.PtrString("GMT"), }, Page: &datadogV2.RUMQueryPageOptions{ Limit: datadog.PtrInt32(25), }, Sort: datadogV2.RUMSORT_TIMESTAMP_ASCENDING.Ptr(), } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRUMApi(apiClient) resp, r, err := api.SearchRUMEvents(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.SearchRUMEvents`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RUMApi.SearchRUMEvents`:\n%s\n", responseContent) } ``` ##### ```go // Search RUM events returns "OK" response with pagination package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { body := datadogV2.RUMSearchEventsRequest{ Filter: &datadogV2.RUMQueryFilter{ From: datadog.PtrString("now-15m"), Query: datadog.PtrString("@type:session AND @session.type:user"), To: datadog.PtrString("now"), }, Options: &datadogV2.RUMQueryOptions{ TimeOffset: datadog.PtrInt64(0), Timezone: datadog.PtrString("GMT"), }, Page: &datadogV2.RUMQueryPageOptions{ Limit: datadog.PtrInt32(2), }, Sort: datadogV2.RUMSORT_TIMESTAMP_ASCENDING.Ptr(), } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRUMApi(apiClient) resp, _ := api.SearchRUMEventsWithPagination(ctx, body) for paginationResult := range resp { if paginationResult.Error != nil { fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.SearchRUMEvents`: %v\n", paginationResult.Error) } responseContent, _ := json.MarshalIndent(paginationResult.Item, "", " ") fmt.Fprintf(os.Stdout, "%s\n", responseContent) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Search RUM events returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumApi; import com.datadog.api.client.v2.model.RUMEventsResponse; import com.datadog.api.client.v2.model.RUMQueryFilter; import com.datadog.api.client.v2.model.RUMQueryOptions; import com.datadog.api.client.v2.model.RUMQueryPageOptions; import com.datadog.api.client.v2.model.RUMSearchEventsRequest; import com.datadog.api.client.v2.model.RUMSort; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); RumApi apiInstance = new RumApi(defaultClient); RUMSearchEventsRequest body = new RUMSearchEventsRequest() .filter( new RUMQueryFilter() .from("now-15m") .query("@type:session AND @session.type:user") .to("now")) .options(new RUMQueryOptions().timeOffset(0L).timezone("GMT")) .page(new RUMQueryPageOptions().limit(25)) .sort(RUMSort.TIMESTAMP_ASCENDING); try { RUMEventsResponse result = apiInstance.searchRUMEvents(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumApi#searchRUMEvents"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Search RUM events returns "OK" response with pagination import com.datadog.api.client.ApiClient; import com.datadog.api.client.PaginationIterable; import com.datadog.api.client.v2.api.RumApi; import com.datadog.api.client.v2.model.RUMEvent; import com.datadog.api.client.v2.model.RUMQueryFilter; import com.datadog.api.client.v2.model.RUMQueryOptions; import com.datadog.api.client.v2.model.RUMQueryPageOptions; import com.datadog.api.client.v2.model.RUMSearchEventsRequest; import com.datadog.api.client.v2.model.RUMSort; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); RumApi apiInstance = new RumApi(defaultClient); RUMSearchEventsRequest body = new RUMSearchEventsRequest() .filter( new RUMQueryFilter() .from("now-15m") .query("@type:session AND @session.type:user") .to("now")) .options(new RUMQueryOptions().timeOffset(0L).timezone("GMT")) .page(new RUMQueryPageOptions().limit(2)) .sort(RUMSort.TIMESTAMP_ASCENDING); try { PaginationIterable iterable = apiInstance.searchRUMEventsWithPagination(body); for (RUMEvent item : iterable) { System.out.println(item); } } catch (RuntimeException e) { System.err.println("Exception when calling RumApi#searchRUMEventsWithPagination"); System.err.println("Reason: " + e.getMessage()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Search RUM events returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_api import RUMApi from datadog_api_client.v2.model.rum_query_filter import RUMQueryFilter from datadog_api_client.v2.model.rum_query_options import RUMQueryOptions from datadog_api_client.v2.model.rum_query_page_options import RUMQueryPageOptions from datadog_api_client.v2.model.rum_search_events_request import RUMSearchEventsRequest from datadog_api_client.v2.model.rum_sort import RUMSort body = RUMSearchEventsRequest( filter=RUMQueryFilter( _from="now-15m", query="@type:session AND @session.type:user", to="now", ), options=RUMQueryOptions( time_offset=0, timezone="GMT", ), page=RUMQueryPageOptions( limit=25, ), sort=RUMSort.TIMESTAMP_ASCENDING, ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = RUMApi(api_client) response = api_instance.search_rum_events(body=body) print(response) ``` ##### ```python """ Search RUM events returns "OK" response with pagination """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_api import RUMApi from datadog_api_client.v2.model.rum_query_filter import RUMQueryFilter from datadog_api_client.v2.model.rum_query_options import RUMQueryOptions from datadog_api_client.v2.model.rum_query_page_options import RUMQueryPageOptions from datadog_api_client.v2.model.rum_search_events_request import RUMSearchEventsRequest from datadog_api_client.v2.model.rum_sort import RUMSort body = RUMSearchEventsRequest( filter=RUMQueryFilter( _from="now-15m", query="@type:session AND @session.type:user", to="now", ), options=RUMQueryOptions( time_offset=0, timezone="GMT", ), page=RUMQueryPageOptions( limit=2, ), sort=RUMSort.TIMESTAMP_ASCENDING, ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = RUMApi(api_client) items = api_instance.search_rum_events_with_pagination(body=body) for item in items: print(item) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Search RUM events returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::RUMAPI.new body = DatadogAPIClient::V2::RUMSearchEventsRequest.new({ filter: DatadogAPIClient::V2::RUMQueryFilter.new({ from: "now-15m", query: "@type:session AND @session.type:user", to: "now", }), options: DatadogAPIClient::V2::RUMQueryOptions.new({ time_offset: 0, timezone: "GMT", }), page: DatadogAPIClient::V2::RUMQueryPageOptions.new({ limit: 25, }), sort: DatadogAPIClient::V2::RUMSort::TIMESTAMP_ASCENDING, }) p api_instance.search_rum_events(body) ``` ##### ```ruby # Search RUM events returns "OK" response with pagination require "datadog_api_client" api_instance = DatadogAPIClient::V2::RUMAPI.new body = DatadogAPIClient::V2::RUMSearchEventsRequest.new({ filter: DatadogAPIClient::V2::RUMQueryFilter.new({ from: "now-15m", query: "@type:session AND @session.type:user", to: "now", }), options: DatadogAPIClient::V2::RUMQueryOptions.new({ time_offset: 0, timezone: "GMT", }), page: DatadogAPIClient::V2::RUMQueryPageOptions.new({ limit: 2, }), sort: DatadogAPIClient::V2::RUMSort::TIMESTAMP_ASCENDING, }) api_instance.search_rum_events_with_pagination(body) { |item| puts item } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Search RUM events returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum::RUMAPI; use datadog_api_client::datadogV2::model::RUMQueryFilter; use datadog_api_client::datadogV2::model::RUMQueryOptions; use datadog_api_client::datadogV2::model::RUMQueryPageOptions; use datadog_api_client::datadogV2::model::RUMSearchEventsRequest; use datadog_api_client::datadogV2::model::RUMSort; #[tokio::main] async fn main() { let body = RUMSearchEventsRequest::new() .filter( RUMQueryFilter::new() .from("now-15m".to_string()) .query("@type:session AND @session.type:user".to_string()) .to("now".to_string()), ) .options( RUMQueryOptions::new() .time_offset(0) .timezone("GMT".to_string()), ) .page(RUMQueryPageOptions::new().limit(25)) .sort(RUMSort::TIMESTAMP_ASCENDING); let configuration = datadog::Configuration::new(); let api = RUMAPI::with_config(configuration); let resp = api.search_rum_events(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Search RUM events returns "OK" response with pagination use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum::RUMAPI; use datadog_api_client::datadogV2::model::RUMQueryFilter; use datadog_api_client::datadogV2::model::RUMQueryOptions; use datadog_api_client::datadogV2::model::RUMQueryPageOptions; use datadog_api_client::datadogV2::model::RUMSearchEventsRequest; use datadog_api_client::datadogV2::model::RUMSort; use futures_util::pin_mut; use futures_util::stream::StreamExt; #[tokio::main] async fn main() { let body = RUMSearchEventsRequest::new() .filter( RUMQueryFilter::new() .from("now-15m".to_string()) .query("@type:session AND @session.type:user".to_string()) .to("now".to_string()), ) .options( RUMQueryOptions::new() .time_offset(0) .timezone("GMT".to_string()), ) .page(RUMQueryPageOptions::new().limit(2)) .sort(RUMSort::TIMESTAMP_ASCENDING); let configuration = datadog::Configuration::new(); let api = RUMAPI::with_config(configuration); let response = api.search_rum_events_with_pagination(body); pin_mut!(response); while let Some(resp) = response.next().await { if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Search RUM events returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.RUMApi(configuration); const params: v2.RUMApiSearchRUMEventsRequest = { body: { filter: { from: "now-15m", query: "@type:session AND @session.type:user", to: "now", }, options: { timeOffset: 0, timezone: "GMT", }, page: { limit: 25, }, sort: "timestamp", }, }; apiInstance .searchRUMEvents(params) .then((data: v2.RUMEventsResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Search RUM events returns "OK" response with pagination */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.RUMApi(configuration); const params: v2.RUMApiSearchRUMEventsRequest = { body: { filter: { from: "now-15m", query: "@type:session AND @session.type:user", to: "now", }, options: { timeOffset: 0, timezone: "GMT", }, page: { limit: 2, }, sort: "timestamp", }, }; (async () => { try { for await (const item of apiInstance.searchRUMEventsWithPagination( params )) { console.log(item); } } catch (error) { console.error(error); } })(); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}