--- title: Query aggregated waterfall description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > RUM Insights --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Query aggregated waterfall{% #query-aggregated-waterfall %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/rum/query/insight/aggregated_waterfall | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/rum/query/insight/aggregated_waterfall | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/rum/query/insight/aggregated_waterfall | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/rum/query/insight/aggregated_waterfall | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/rum/query/insight/aggregated_waterfall | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/rum/query/insight/aggregated_waterfall | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/rum/query/insight/aggregated_waterfall | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/rum/query/insight/aggregated_waterfall | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/rum/query/insight/aggregated_waterfall | ### Overview Get aggregated network resource waterfall data for a RUM view, sampled across multiple view instances. This endpoint requires the `rum_apps_read` permission. ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | -------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data envelope for an aggregated waterfall request. | | data | attributes [*required*] | object | Attributes for an aggregated waterfall query. | | attributes | application_id [*required*] | string | The RUM application ID to analyze. | | attributes | criteria | object | Performance criteria to filter view instances by a metric threshold. | | criteria | max | double | Maximum threshold in seconds (inclusive). | | criteria | metric [*required*] | enum | Performance metric used to filter view instances by threshold. Allowed enum values: `loading_time,largest_contentful_paint,first_contentful_paint,interaction_to_next_paint` | | criteria | min | double | Minimum threshold in seconds (inclusive). | | attributes | filter | string | RUM query string to filter events (for example, @session.type:user @geo.country:US). | | attributes | from [*required*] | int64 | Start of the time range as a Unix timestamp in seconds. | | attributes | include_global_appearance | boolean | When true, enriches each resource with cross-view appearance statistics. | | attributes | sample_size [*required*] | int32 | Number of view instances to sample, between 1 and 500. | | attributes | to [*required*] | int64 | End of the time range as a Unix timestamp in seconds. | | attributes | view_name [*required*] | string | The RUM view name to analyze (for example, /account/login). | | data | type [*required*] | enum | The JSON:API type for aggregated waterfall requests. Allowed enum values: `aggregated_waterfall` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": { "max": 5, "metric": "largest_contentful_paint", "min": 2.5 }, "filter": "@session.type:user", "from": 1762437564, "include_global_appearance": false, "sample_size": 20, "to": 1762523964, "view_name": "/account/login(/:type)" }, "type": "aggregated_waterfall" } } ``` {% /tab %} ### Response {% tab title="201" %} Successful response {% tab title="Model" %} Response body for the aggregated waterfall endpoint. | Parent field | Field | Type | Description | | ---------------- | ------------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data envelope for an aggregated waterfall response. | | data | attributes [*required*] | object | Attributes of an aggregated waterfall response. | | attributes | application_id [*required*] | string | The RUM application ID that was analyzed. | | attributes | criteria | object | Performance criteria to filter view instances by a metric threshold. | | criteria | max | double | Maximum threshold in seconds (inclusive). | | criteria | metric [*required*] | enum | Performance metric used to filter view instances by threshold. Allowed enum values: `loading_time,largest_contentful_paint,first_contentful_paint,interaction_to_next_paint` | | criteria | min | double | Minimum threshold in seconds (inclusive). | | attributes | from [*required*] | int64 | Start of the analyzed time range as a Unix timestamp in seconds. | | attributes | resources [*required*] | [object] | Network resources in chronological waterfall order. | | resources | avg_duration_ms [*required*] | double | Average total duration in milliseconds. | | resources | avg_start_time_ms [*required*] | double | Average start time relative to view start in milliseconds. | | resources | cache_hit_rate_pct [*required*] | double | Cache hit rate as a percentage. | | resources | cached_count [*required*] | int32 | Number of requests served from cache. | | resources | downloaded_count [*required*] | int32 | Number of requests downloaded from the network. | | resources | global_p75_duration_ms | double | 75th percentile duration across all view names in the application, present when include_global_appearance is true. | | resources | global_view_name_count | int32 | Number of distinct view names in the application that load this resource, present when include_global_appearance is true. | | resources | global_view_name_pct | double | Percentage of distinct view names in the application that load this resource, present when include_global_appearance is true. | | resources | http_method [*required*] | string | HTTP method for the resource request. | | resources | load_frequency_pct [*required*] | double | Percentage of sampled view instances that loaded this resource. | | resources | max_duration_ms [*required*] | double | Maximum duration in milliseconds. | | resources | median_duration_ms [*required*] | double | Median duration in milliseconds. | | resources | min_duration_ms [*required*] | double | Minimum duration in milliseconds. | | resources | p75_duration_ms [*required*] | double | 75th percentile duration in milliseconds. | | resources | p95_duration_ms [*required*] | double | 95th percentile duration in milliseconds. | | resources | resource_type [*required*] | string | Resource type (JS, CSS, image, fetch, XHR, document, and so on). | | resources | resource_url_path_group [*required*] | string | URL path group used to aggregate similar resources. | | resources | timing_breakdown [*required*] | object | Average timing breakdown per network phase for a resource. | | timing_breakdown | avg_connect_ms [*required*] | double | Average TCP connect duration in milliseconds. | | timing_breakdown | avg_dns_ms [*required*] | double | Average DNS resolution duration in milliseconds. | | timing_breakdown | avg_download_ms [*required*] | double | Average download phase duration in milliseconds. | | timing_breakdown | avg_first_byte_ms [*required*] | double | Average time to first byte in milliseconds. | | timing_breakdown | avg_redirect_ms [*required*] | double | Average redirect phase duration in milliseconds. | | timing_breakdown | avg_ssl_ms [*required*] | double | Average SSL handshake duration in milliseconds. | | resources | total_requests [*required*] | int32 | Total number of requests for this resource across all sampled views. | | resources | views_with_resource [*required*] | int32 | Number of sampled view instances that loaded this resource. | | attributes | sampled_view_ids [*required*] | [string] | List of RUM view IDs sampled for this aggregation, capped at 50. | | attributes | to [*required*] | int64 | End of the analyzed time range as a Unix timestamp in seconds. | | attributes | total_cache_hit_rate_pct [*required*] | double | Overall cache hit rate across all sampled views. | | attributes | view_count [*required*] | int32 | Number of view instances included in the analysis. | | attributes | view_name [*required*] | string | The RUM view name that was analyzed. | | data | id [*required*] | string | Hash-based unique identifier for this aggregation. | | data | type [*required*] | enum | The JSON:API type for aggregated waterfall requests. Allowed enum values: `aggregated_waterfall` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": { "max": 5, "metric": "largest_contentful_paint", "min": 2.5 }, "from": 1762437564, "resources": [ { "avg_duration_ms": 839.1, "avg_start_time_ms": 1486.3, "cache_hit_rate_pct": 100, "cached_count": 27, "downloaded_count": 0, "global_p75_duration_ms": 500, "global_view_name_count": 3, "global_view_name_pct": 30, "http_method": "GET", "load_frequency_pct": 54, "max_duration_ms": 945.6, "median_duration_ms": 836.2, "min_duration_ms": 812.7, "p75_duration_ms": 844.1, "p95_duration_ms": 861.8, "resource_type": "fetch", "resource_url_path_group": "/api/gallery", "timing_breakdown": { "avg_connect_ms": 20, "avg_dns_ms": 10, "avg_download_ms": 135, "avg_first_byte_ms": 30, "avg_redirect_ms": 0, "avg_ssl_ms": 5 }, "total_requests": 27, "views_with_resource": 27 } ], "sampled_view_ids": [ "6fbf69b6-9455-436a-b894-a6bf64126d40", "dfe318df-4ae5-44b8-9fe2-4107885e1a46" ], "to": 1762523964, "total_cache_hit_rate_pct": 0.677, "view_count": 50, "view_name": "/account/login(/:type)" }, "id": "2f0b3455", "type": "aggregated_waterfall" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "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/query/insight/aggregated_waterfall" \ -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 { "data": { "attributes": { "application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": { "metric": "largest_contentful_paint", "min": 0.3 }, "from": 1762437564, "sample_size": 20, "to": 1762523964, "view_name": "/account/login(/:type)" }, "type": "aggregated_waterfall" } } EOF ##### ```python """ Query aggregated waterfall returns "Successful response" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_insights_api import RUMInsightsApi from datadog_api_client.v2.model.aggregated_waterfall_performance_criteria import AggregatedWaterfallPerformanceCriteria from datadog_api_client.v2.model.aggregated_waterfall_performance_criteria_metric import ( AggregatedWaterfallPerformanceCriteriaMetric, ) from datadog_api_client.v2.model.aggregated_waterfall_request import AggregatedWaterfallRequest from datadog_api_client.v2.model.aggregated_waterfall_request_attributes import AggregatedWaterfallRequestAttributes from datadog_api_client.v2.model.aggregated_waterfall_request_data import AggregatedWaterfallRequestData from datadog_api_client.v2.model.aggregated_waterfall_request_type import AggregatedWaterfallRequestType body = AggregatedWaterfallRequest( data=AggregatedWaterfallRequestData( attributes=AggregatedWaterfallRequestAttributes( application_id="ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", criteria=AggregatedWaterfallPerformanceCriteria( max=5.0, metric=AggregatedWaterfallPerformanceCriteriaMetric.LARGEST_CONTENTFUL_PAINT, min=2.5, ), filter="@session.type:user", _from=1762437564, include_global_appearance=False, sample_size=20, to=1762523964, view_name="/account/login(/:type)", ), type=AggregatedWaterfallRequestType.AGGREGATED_WATERFALL, ), ) configuration = Configuration() configuration.unstable_operations["query_aggregated_waterfall"] = True with ApiClient(configuration) as api_client: api_instance = RUMInsightsApi(api_client) response = api_instance.query_aggregated_waterfall(body=body) 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 # Query aggregated waterfall returns "Successful response" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.query_aggregated_waterfall".to_sym] = true end api_instance = DatadogAPIClient::V2::RUMInsightsAPI.new body = DatadogAPIClient::V2::AggregatedWaterfallRequest.new({ data: DatadogAPIClient::V2::AggregatedWaterfallRequestData.new({ attributes: DatadogAPIClient::V2::AggregatedWaterfallRequestAttributes.new({ application_id: "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", criteria: DatadogAPIClient::V2::AggregatedWaterfallPerformanceCriteria.new({ max: 5.0, metric: DatadogAPIClient::V2::AggregatedWaterfallPerformanceCriteriaMetric::LARGEST_CONTENTFUL_PAINT, min: 2.5, }), filter: "@session.type:user", from: 1762437564, include_global_appearance: false, sample_size: 20, to: 1762523964, view_name: "/account/login(/:type)", }), type: DatadogAPIClient::V2::AggregatedWaterfallRequestType::AGGREGATED_WATERFALL, }), }) p api_instance.query_aggregated_waterfall(body) ``` #### 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 // Query aggregated waterfall returns "Successful response" 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.AggregatedWaterfallRequest{ Data: datadogV2.AggregatedWaterfallRequestData{ Attributes: datadogV2.AggregatedWaterfallRequestAttributes{ ApplicationId: "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", Criteria: &datadogV2.AggregatedWaterfallPerformanceCriteria{ Max: datadog.PtrFloat64(5.0), Metric: datadogV2.AGGREGATEDWATERFALLPERFORMANCECRITERIAMETRIC_LARGEST_CONTENTFUL_PAINT, Min: datadog.PtrFloat64(2.5), }, Filter: datadog.PtrString("@session.type:user"), From: 1762437564, IncludeGlobalAppearance: datadog.PtrBool(false), SampleSize: 20, To: 1762523964, ViewName: "/account/login(/:type)", }, Type: datadogV2.AGGREGATEDWATERFALLREQUESTTYPE_AGGREGATED_WATERFALL, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.QueryAggregatedWaterfall", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRUMInsightsApi(apiClient) resp, r, err := api.QueryAggregatedWaterfall(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RUMInsightsApi.QueryAggregatedWaterfall`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RUMInsightsApi.QueryAggregatedWaterfall`:\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 // Query aggregated waterfall returns "Successful response" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumInsightsApi; import com.datadog.api.client.v2.model.AggregatedWaterfallPerformanceCriteria; import com.datadog.api.client.v2.model.AggregatedWaterfallPerformanceCriteriaMetric; import com.datadog.api.client.v2.model.AggregatedWaterfallRequest; import com.datadog.api.client.v2.model.AggregatedWaterfallRequestAttributes; import com.datadog.api.client.v2.model.AggregatedWaterfallRequestData; import com.datadog.api.client.v2.model.AggregatedWaterfallRequestType; import com.datadog.api.client.v2.model.AggregatedWaterfallResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.queryAggregatedWaterfall", true); RumInsightsApi apiInstance = new RumInsightsApi(defaultClient); AggregatedWaterfallRequest body = new AggregatedWaterfallRequest() .data( new AggregatedWaterfallRequestData() .attributes( new AggregatedWaterfallRequestAttributes() .applicationId("ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b") .criteria( new AggregatedWaterfallPerformanceCriteria() .max(5.0) .metric( AggregatedWaterfallPerformanceCriteriaMetric .LARGEST_CONTENTFUL_PAINT) .min(2.5)) .filter("@session.type:user") .from(1762437564L) .includeGlobalAppearance(false) .sampleSize(20) .to(1762523964L) .viewName("/account/login(/:type)")) .type(AggregatedWaterfallRequestType.AGGREGATED_WATERFALL)); try { AggregatedWaterfallResponse result = apiInstance.queryAggregatedWaterfall(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumInsightsApi#queryAggregatedWaterfall"); 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 // Query aggregated waterfall returns "Successful response" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_insights::RUMInsightsAPI; use datadog_api_client::datadogV2::model::AggregatedWaterfallPerformanceCriteria; use datadog_api_client::datadogV2::model::AggregatedWaterfallPerformanceCriteriaMetric; use datadog_api_client::datadogV2::model::AggregatedWaterfallRequest; use datadog_api_client::datadogV2::model::AggregatedWaterfallRequestAttributes; use datadog_api_client::datadogV2::model::AggregatedWaterfallRequestData; use datadog_api_client::datadogV2::model::AggregatedWaterfallRequestType; #[tokio::main] async fn main() { let body = AggregatedWaterfallRequest::new(AggregatedWaterfallRequestData::new( AggregatedWaterfallRequestAttributes::new( "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b".to_string(), 1762437564, 20, 1762523964, "/account/login(/:type)".to_string(), ) .criteria( AggregatedWaterfallPerformanceCriteria::new( AggregatedWaterfallPerformanceCriteriaMetric::LARGEST_CONTENTFUL_PAINT, ) .max(5.0 as f64) .min(2.5 as f64), ) .filter("@session.type:user".to_string()) .include_global_appearance(false), AggregatedWaterfallRequestType::AGGREGATED_WATERFALL, )); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.QueryAggregatedWaterfall", true); let api = RUMInsightsAPI::with_config(configuration); let resp = api.query_aggregated_waterfall(body).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 /** * Query aggregated waterfall returns "Successful response" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.queryAggregatedWaterfall"] = true; const apiInstance = new v2.RUMInsightsApi(configuration); const params: v2.RUMInsightsApiQueryAggregatedWaterfallRequest = { body: { data: { attributes: { applicationId: "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", criteria: { max: 5.0, metric: "largest_contentful_paint", min: 2.5, }, filter: "@session.type:user", from: 1762437564, includeGlobalAppearance: false, sampleSize: 20, to: 1762523964, viewName: "/account/login(/:type)", }, type: "aggregated_waterfall", }, }, }; apiInstance .queryAggregatedWaterfall(params) .then((data: v2.AggregatedWaterfallResponse) => { 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 %}