Language

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

Datadog Site

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

Query aggregated signals and problems

copy Copy pageCopied

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_signals_problemshttps://api.ap2.datadoghq.com/api/v2/rum/query/insight/aggregated_signals_problemshttps://api.datadoghq.eu/api/v2/rum/query/insight/aggregated_signals_problemshttps://api.ddog-gov.com/api/v2/rum/query/insight/aggregated_signals_problemshttps://api.us2.ddog-gov.com/api/v2/rum/query/insight/aggregated_signals_problemshttps://api.datadoghq.com/api/v2/rum/query/insight/aggregated_signals_problemshttps://api.us3.datadoghq.com/api/v2/rum/query/insight/aggregated_signals_problemshttps://api.us5.datadoghq.com/api/v2/rum/query/insight/aggregated_signals_problems

Overview

Get aggregated performance signals and problem detections for a RUM view, 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 signals and problems request.

attributes [required]

object

Attributes for an aggregated signals and problems 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).

detection_types

[string]

List of detection types to include in the response. When omitted, all types are returned.

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 50.

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 signals and problems requests. Allowed enum values: aggregated_signals_problems

{
  "data": {
    "attributes": {
      "application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b",
      "criteria": {
        "max": 5,
        "metric": "largest_contentful_paint",
        "min": 2.5
      },
      "detection_types": [
        "high_script_evaluations",
        "uncompressed_resources"
      ],
      "filter": "@session.type:user",
      "from": 1762437564,
      "sample_size": 30,
      "to": 1762523964,
      "view_name": "/account/login(/:type)"
    },
    "type": "aggregated_signals_problems"
  }
}

Response

Successful response

Response body for the aggregated signals and problems endpoint.

Expand All

Field

Type

Description

data [required]

object

Data envelope for an aggregated signals and problems response.

attributes [required]

object

Attributes of an aggregated signals and problems 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.

problem_detections [required]

object

Grouped detection results by detection type.

high_frozen_frame_rates

[object]

Detected high frozen frame rate issues.

avg_frozen_frame_rate [required]

double

Average frozen frame rate as a fraction of total frames.

avg_segment_duration [required]

int64

Average segment duration in nanoseconds.

avg_total_frozen_duration [required]

int64

Average total frozen duration in nanoseconds.

fingerprint [required]

string

Unique fingerprint identifying this detection group.

impact_score [required]

double

Impact score for this detection.

view_occurrences [required]

int32

Number of sampled views where this detection occurred.

high_script_evaluations

[object]

Detected high script evaluation issues.

avg_duration [required]

int64

Average script evaluation duration in nanoseconds.

avg_forced_style_layout [required]

int64

Average forced style/layout duration in nanoseconds.

fingerprint [required]

string

Unique fingerprint identifying this detection group.

impact_score [required]

double

Impact score combining view frequency and duration severity.

instance_count [required]

int32

Total number of detection instances across sampled views.

invoker_type [required]

string

Type of invoker that triggered the script evaluation.

source_category [required]

string

Category of the script source.

source_function_name [required]

string

Name of the function that triggered the high script evaluation.

source_url [required]

string

URL of the script that triggered the high script evaluation.

view_occurrences [required]

int32

Number of sampled views where this detection occurred.

low_cache_hit_rates

[object]

Detected low cache hit rate issues.

avg_cache_hit_rate [required]

double

Average cache hit rate across affected views.

avg_resource_download_size_bytes [required]

int64

Average total download size of uncached resources in bytes.

fingerprint [required]

string

Unique fingerprint identifying this detection group.

impact_score [required]

double

Impact score for this detection.

view_occurrences [required]

int32

Number of sampled views where this detection occurred.

mobile_scroll_frictions

[object]

Detected mobile scroll friction issues.

avg_scroll_frozen_frame_count [required]

int32

Average number of frozen frames during scroll interactions.

fingerprint [required]

string

Unique fingerprint identifying this detection group.

impact_score [required]

double

Impact score for this detection.

view_occurrences [required]

int32

Number of sampled views where this detection occurred.

slow_fcp_high_bytes

[object]

Detected slow first contentful paint with high byte count issues.

avg_bytes_before_fcp_bytes [required]

int64

Average total bytes loaded before first contentful paint.

avg_first_contentful_paint_ms [required]

int64

Average first contentful paint time in milliseconds.

avg_resource_count_before_fcp [required]

int64

Average number of resources loaded before first contentful paint.

fingerprint [required]

string

Unique fingerprint identifying this detection group.

impact_score [required]

double

Impact score for this detection.

platform [required]

string

Platform identifier for the affected views.

view_occurrences [required]

int32

Number of sampled views where this detection occurred.

slow_interaction_long_tasks

[object]

Detected slow interaction with long task issues.

action_type [required]

string

Type of user interaction that triggered the slow response.

avg_blocking_duration [required]

int64

Average long task blocking duration in nanoseconds.

avg_duration [required]

int64

Average total interaction duration in nanoseconds.

fingerprint [required]

string

Unique fingerprint identifying this detection group.

impact_score [required]

double

Impact score combining view frequency and blocking severity.

instance_count [required]

int32

Total number of detection instances across sampled views.

selector [required]

string

CSS selector of the element that was interacted with.

selector_normalized [required]

string

Normalized CSS selector with dynamic parts replaced.

view_occurrences [required]

int32

Number of sampled views where this detection occurred.

uncompressed_resources

[object]

Detected uncompressed resource issues.

avg_body_size [required]

int64

Average uncompressed body size in bytes.

avg_duration [required]

int64

Average resource loading duration in nanoseconds.

fingerprint [required]

string

Unique fingerprint identifying this detection group.

impact_score [required]

double

Impact score combining view frequency and resource size.

instance_count [required]

int32

Total number of detection instances across sampled views.

provider_type [required]

string

CDN or hosting provider type for the resource.

render_blocking [required]

string

Whether the resource is render-blocking.

resource_type [required]

string

Type of the resource (JS, CSS, image, fetch, and so on).

url_path_group [required]

string

Normalized URL path pattern for the uncompressed resource.

view_occurrences [required]

int32

Number of sampled views where this detection occurred.

sample_metadata [required]

object

Metadata about the sampling quality for a signals and problems query.

failed [required]

int32

Number of view instances that failed to process.

requested [required]

int32

Number of view instances requested for sampling.

sampled_view_ids [required]

[string]

List of RUM view IDs that were sampled.

succeeded [required]

int32

Number of view instances successfully processed.

success_rate [required]

double

Ratio of successfully processed views to requested views.

to [required]

int64

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

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 signals and problems requests. Allowed enum values: aggregated_signals_problems

{
  "data": {
    "attributes": {
      "application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b",
      "criteria": {
        "max": 5,
        "metric": "largest_contentful_paint",
        "min": 2.5
      },
      "from": 1710000000,
      "problem_detections": {
        "high_frozen_frame_rates": [
          {
            "avg_frozen_frame_rate": 0.15,
            "avg_segment_duration": 3000000000,
            "avg_total_frozen_duration": 500000000,
            "fingerprint": "v1$mno345",
            "impact_score": 14,
            "view_occurrences": 5
          }
        ],
        "high_script_evaluations": [
          {
            "avg_duration": 300000000,
            "avg_forced_style_layout": 0,
            "fingerprint": "v1$7766a8c2180aa153f5526ba8868999f8",
            "impact_score": 30,
            "instance_count": 3,
            "invoker_type": "user-callback",
            "source_category": "third-party",
            "source_function_name": "handleClick",
            "source_url": "https://cdn.example.com/app.js",
            "view_occurrences": 3
          }
        ],
        "low_cache_hit_rates": [
          {
            "avg_cache_hit_rate": 0.15,
            "avg_resource_download_size_bytes": 1048576,
            "fingerprint": "v1$abc123",
            "impact_score": 20,
            "view_occurrences": 5
          }
        ],
        "mobile_scroll_frictions": [
          {
            "avg_scroll_frozen_frame_count": 3,
            "fingerprint": "v1$ghi789",
            "impact_score": 12,
            "view_occurrences": 6
          }
        ],
        "slow_fcp_high_bytes": [
          {
            "avg_bytes_before_fcp_bytes": 2097152,
            "avg_first_contentful_paint_ms": 3500,
            "avg_resource_count_before_fcp": 25,
            "fingerprint": "v1$def456",
            "impact_score": 18,
            "platform": "browser",
            "view_occurrences": 4
          }
        ],
        "slow_interaction_long_tasks": [
          {
            "action_type": "click",
            "avg_blocking_duration": 250000000,
            "avg_duration": 320000000,
            "fingerprint": "v1$jkl012",
            "impact_score": 22,
            "instance_count": 9,
            "selector": "#submit-button",
            "selector_normalized": "button[data-action]",
            "view_occurrences": 7
          }
        ],
        "uncompressed_resources": [
          {
            "avg_body_size": 524288,
            "avg_duration": 0,
            "fingerprint": "v1$65e268e25cab3a1f6230405ccf011a68",
            "impact_score": 16.67,
            "instance_count": 1,
            "provider_type": "cloudfront",
            "render_blocking": "blocking",
            "resource_type": "image",
            "url_path_group": "/cdn/hero.jpg",
            "view_occurrences": 1
          }
        ]
      },
      "sample_metadata": {
        "failed": 2,
        "requested": 30,
        "sampled_view_ids": [
          "6fbf69b6-9455-436a-b894-a6bf64126d40"
        ],
        "succeeded": 28,
        "success_rate": 0.93
      },
      "to": 1710003600,
      "view_name": "/checkout"
    },
    "id": "2f0b3455",
    "type": "aggregated_signals_problems"
  }
}

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_signals_problems" \
-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": 30,
      "to": 1762523964,
      "view_name": "/account/login(/:type)"
    },
    "type": "aggregated_signals_problems"
  }
}
EOF