Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

Query aggregated long tasks

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/rum/query/insight/aggregated_long_taskshttps://api.ap2.datadoghq.com/api/v2/rum/query/insight/aggregated_long_taskshttps://api.datadoghq.eu/api/v2/rum/query/insight/aggregated_long_taskshttps://api.ddog-gov.com/api/v2/rum/query/insight/aggregated_long_taskshttps://api.us2.ddog-gov.com/api/v2/rum/query/insight/aggregated_long_taskshttps://api.datadoghq.com/api/v2/rum/query/insight/aggregated_long_taskshttps://api.us3.datadoghq.com/api/v2/rum/query/insight/aggregated_long_taskshttps://api.us5.datadoghq.com/api/v2/rum/query/insight/aggregated_long_tasks

Overview

Get aggregated long task data for a RUM view, grouped by invoker type and sampled across multiple view instances. This endpoint requires the rum_apps_read permission.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data envelope for an aggregated long tasks request.

attributes [required]

object

Attributes for an aggregated long tasks query.

application_id [required]

string

The RUM application ID to analyze.

criteria

object

Performance criteria to filter view instances by a metric threshold.

max

double

Maximum threshold in seconds (inclusive).

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

min

double

Minimum threshold in seconds (inclusive).

filter

string

RUM query string to filter events (for example, @session.type:user @geo.country:US).

from [required]

int64

Start of the time range as a Unix timestamp in seconds.

sample_size [required]

int32

Number of view instances to sample, between 1 and 500.

to [required]

int64

End of the time range as a Unix timestamp in seconds.

view_name [required]

string

The RUM view name to analyze (for example, /account/login).

type [required]

enum

The JSON:API type for aggregated long tasks requests. Allowed enum values: aggregated_long_tasks

{
  "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,
      "sample_size": 20,
      "to": 1762523964,
      "view_name": "/account/login(/:type)"
    },
    "type": "aggregated_long_tasks"
  }
}

Response

Successful response

Response body for the aggregated long tasks endpoint.

Expand All

Field

Type

Description

data [required]

object

Data envelope for an aggregated long tasks response.

attributes [required]

object

Attributes of an aggregated long tasks response.

application_id [required]

string

The RUM application ID that was analyzed.

criteria

object

Performance criteria to filter view instances by a metric threshold.

max

double

Maximum threshold in seconds (inclusive).

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

min

double

Minimum threshold in seconds (inclusive).

from [required]

int64

Start of the analyzed time range as a Unix timestamp in seconds.

long_tasks_by_invoker_type [required]

[object]

Long task statistics grouped by invoker type, sorted by impact score descending.

criteria_view_occurrences

int32

Number of sampled views where this invoker type had long tasks contributing to the criteria metric.

impact_score

double

Rank-product impact score combining view frequency and blocking time severity.

invoker_type [required]

string

Category of the long task invoker (for example, resolve-promise, user-callback).

stats_per_view [required]

object

Statistical distributions of long task metrics computed per view across sampled views.

fcp_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

fcp_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

inp_overlap_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

inp_overlap_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

lcp_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

lcp_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

loading_time_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

loading_time_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

total_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

total_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

top_invokers [required]

[object]

Top invokers within this invoker type, sorted by impact score descending.

criteria_view_occurrences

int32

Number of sampled views where this invoker had long tasks contributing to the criteria metric.

file [required]

string

Cleaned source file path for the invoker script.

impact_score

double

Rank-product impact score combining view frequency and blocking time severity.

invoker [required]

string

Name of the invoker function or script.

stats_per_view [required]

object

Statistical distributions of long task metrics computed per view across sampled views.

fcp_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

fcp_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

inp_overlap_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

inp_overlap_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

lcp_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

lcp_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

loading_time_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

loading_time_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

total_blocking_time_ms

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

total_count

object

Statistical distribution (average, min, max) of a long task metric across sampled views.

average [required]

double

Average value across sampled views.

max [required]

double

Maximum value across sampled views.

min [required]

double

Minimum value across sampled views.

view_occurrences [required]

int32

Number of sampled views where this invoker had any long tasks.

view_occurrences [required]

int32

Number of sampled views where this invoker type had any long tasks.

sampled_view_ids [required]

[string]

List of RUM view IDs sampled for this aggregation, capped at 50.

to [required]

int64

End of the analyzed time range as a Unix timestamp in seconds.

view_count [required]

int32

Number of view instances included in the analysis.

view_name [required]

string

The RUM view name that was analyzed.

id [required]

string

Hash-based unique identifier for this aggregation.

type [required]

enum

The JSON:API type for aggregated long tasks requests. Allowed enum values: aggregated_long_tasks

{
  "data": {
    "attributes": {
      "application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b",
      "criteria": {
        "max": 5,
        "metric": "largest_contentful_paint",
        "min": 2.5
      },
      "from": 1762437564,
      "long_tasks_by_invoker_type": [
        {
          "criteria_view_occurrences": 40,
          "impact_score": 0.4,
          "invoker_type": "resolve-promise",
          "stats_per_view": {
            "fcp_blocking_time_ms": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "fcp_count": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "inp_overlap_blocking_time_ms": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "inp_overlap_count": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "lcp_blocking_time_ms": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "lcp_count": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "loading_time_blocking_time_ms": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "loading_time_count": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "total_blocking_time_ms": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            },
            "total_count": {
              "average": 3504.1,
              "max": 3517.8,
              "min": 3500.1
            }
          },
          "top_invokers": [
            {
              "criteria_view_occurrences": 40,
              "file": "src/pages/Gallery.tsx",
              "impact_score": 0.67,
              "invoker": "Response.json.then",
              "stats_per_view": {
                "fcp_blocking_time_ms": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "fcp_count": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "inp_overlap_blocking_time_ms": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "inp_overlap_count": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "lcp_blocking_time_ms": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "lcp_count": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "loading_time_blocking_time_ms": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "loading_time_count": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "total_blocking_time_ms": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                },
                "total_count": {
                  "average": 3504.1,
                  "max": 3517.8,
                  "min": 3500.1
                }
              },
              "view_occurrences": 68
            }
          ],
          "view_occurrences": 68
        }
      ],
      "sampled_view_ids": [
        "6fbf69b6-9455-436a-b894-a6bf64126d40"
      ],
      "to": 1762523964,
      "view_count": 50,
      "view_name": "/account/login(/:type)"
    },
    "id": "2f0b3455",
    "type": "aggregated_long_tasks"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/rum/query/insight/aggregated_long_tasks" \
-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",
      "from": 1762437564,
      "sample_size": 20,
      "to": 1762523964,
      "view_name": "/account/login(/:type)"
    },
    "type": "aggregated_long_tasks"
  }
}
EOF