--- title: Get all RUM retention filters description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Rum Retention Filters --- # Get all RUM retention filters{% #get-all-rum-retention-filters %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------------ | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/rum/applications/{app_id}/retention_filters | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/rum/applications/{app_id}/retention_filters | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/rum/applications/{app_id}/retention_filters | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters | ### Overview Get the list of RUM retention filters for a RUM application. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------ | ------ | ------------------- | | app_id [*required*] | string | RUM application ID. | ### Response {% tab title="200" %} OK {% tab title="Model" %} All RUM retention filters for a RUM application. | Parent field | Field | Type | Description | | ---------------------- | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- | | | data | [object] | A list of RUM retention filters. | | data | attributes | object | The object describing attributes of a RUM retention filter. | | attributes | cross_product_sampling | object | The configuration for cross-product retention filters. | | cross_product_sampling | trace_enabled | boolean | Whether the cross-product retention filter for APM traces is enabled. | | cross_product_sampling | trace_sample_rate | double | The sample rate for the APM cross-product retention filter, between 0 and 100. | | attributes | enabled | boolean | Whether the retention filter is enabled. | | attributes | event_type | enum | The type of RUM events to filter on. Allowed enum values: `session,view,action,error,resource,long_task,vital` | | attributes | name | string | The name of a RUM retention filter. | | attributes | query | string | The query string for a RUM retention filter. | | attributes | sample_rate | double | The sample rate for a RUM retention filter, between 0.1 and 100. | | data | id | string | ID of retention filter in UUID. | | data | type | enum | The type of the resource. The value should always be retention_filters. Allowed enum values: `retention_filters` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "cross_product_sampling": { "trace_enabled": true, "trace_sample_rate": 25 }, "enabled": true, "event_type": "session", "name": "Retention filter for session", "query": "@session.has_replay:true", "sample_rate": 50.5 }, "id": "051601eb-54a0-abc0-03f9-cc02efa18892", "type": "retention_filters" } ] } ``` {% /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 ##### \# Path parameters export app_id="CHANGE_ME" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/rum/applications/${app_id}/retention_filters" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get all RUM retention filters returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_retention_filters_api import RumRetentionFiltersApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = RumRetentionFiltersApi(api_client) response = api_instance.list_retention_filters( app_id="1d4b9c34-7ac4-423a-91cf-9902d926e9b3", ) print(response) ``` #### 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 # Get all RUM retention filters returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::RumRetentionFiltersAPI.new p api_instance.list_retention_filters("1d4b9c34-7ac4-423a-91cf-9902d926e9b3") ``` #### 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" ##### ```go // Get all RUM retention filters 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() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumRetentionFiltersApi(apiClient) resp, r, err := api.ListRetentionFilters(ctx, "1d4b9c34-7ac4-423a-91cf-9902d926e9b3") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumRetentionFiltersApi.ListRetentionFilters`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumRetentionFiltersApi.ListRetentionFilters`:\n%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 // Get all RUM retention filters returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumRetentionFiltersApi; import com.datadog.api.client.v2.model.RumRetentionFiltersResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); RumRetentionFiltersApi apiInstance = new RumRetentionFiltersApi(defaultClient); try { RumRetentionFiltersResponse result = apiInstance.listRetentionFilters("1d4b9c34-7ac4-423a-91cf-9902d926e9b3"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumRetentionFiltersApi#listRetentionFilters"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); 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" ##### ```rust // Get all RUM retention filters returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_retention_filters::RumRetentionFiltersAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = RumRetentionFiltersAPI::with_config(configuration); let resp = api .list_retention_filters("1d4b9c34-7ac4-423a-91cf-9902d926e9b3".to_string()) .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 /** * Get all RUM retention filters returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.RumRetentionFiltersApi(configuration); const params: v2.RumRetentionFiltersApiListRetentionFiltersRequest = { appId: "1d4b9c34-7ac4-423a-91cf-9902d926e9b3", }; apiInstance .listRetentionFilters(params) .then((data: v2.RumRetentionFiltersResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => 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 %}