diff --git a/hugo/content/en/api/v2/rum-insights/examples.json b/hugo/content/en/api/v2/rum-insights/examples.json index 284957030d5..e349db62888 100644 --- a/hugo/content/en/api/v2/rum-insights/examples.json +++ b/hugo/content/en/api/v2/rum-insights/examples.json @@ -451,13 +451,18 @@ "global_view_name_pct": 30, "http_method": "GET", "load_frequency_pct": 54, + "local_cache_count": 20, "max_duration_ms": 945.6, "median_duration_ms": 836.2, "min_duration_ms": 812.7, + "non_blocking_count": 23, "p75_duration_ms": 844.1, "p95_duration_ms": 861.8, + "render_blocking_count": 4, + "render_blocking_pct": 14.8, "resource_type": "fetch", "resource_url_path_group": "/api/gallery", + "server_validated_cache_count": 7, "timing_breakdown": { "avg_connect_ms": 20, "avg_dns_ms": 10, @@ -483,7 +488,7 @@ "type": "aggregated_waterfall" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data envelope for an aggregated waterfall response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an aggregated waterfall response.

\n
\n
\n
\n
\n
\n

application_id [required]

\n
\n

string

\n

The RUM application ID that was analyzed.

\n
\n \n
\n
\n
\n
\n
\n

criteria

\n
\n

object

\n

Performance criteria to filter view instances by a metric threshold.

\n
\n
\n
\n
\n
\n

max

\n
\n

double

\n

Maximum threshold in seconds (inclusive).

\n
\n \n
\n
\n
\n
\n
\n

metric [required]

\n
\n

enum

\n

Performance metric used to filter view instances by threshold. \nAllowed enum values: loading_time,largest_contentful_paint,first_contentful_paint,interaction_to_next_paint

\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

double

\n

Minimum threshold in seconds (inclusive).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

resources [required]

\n
\n

[object]

\n

Network resources in chronological waterfall order.

\n
\n
\n
\n
\n
\n

avg_duration_ms [required]

\n
\n

double

\n

Average total duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_start_time_ms [required]

\n
\n

double

\n

Average start time relative to view start in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

cache_hit_rate_pct [required]

\n
\n

double

\n

Cache hit rate as a percentage.

\n
\n \n
\n
\n
\n
\n
\n

cached_count [required]

\n
\n

int32

\n

Number of requests served from cache.

\n
\n \n
\n
\n
\n
\n
\n

downloaded_count [required]

\n
\n

int32

\n

Number of requests downloaded from the network.

\n
\n \n
\n
\n
\n
\n
\n

global_p75_duration_ms

\n
\n

double

\n

75th percentile duration across all view names in the application, present when include_global_appearance is true.

\n
\n \n
\n
\n
\n
\n
\n

global_view_name_count

\n
\n

int32

\n

Number of distinct view names in the application that load this resource, present when include_global_appearance is true.

\n
\n \n
\n
\n
\n
\n
\n

global_view_name_pct

\n
\n

double

\n

Percentage of distinct view names in the application that load this resource, present when include_global_appearance is true.

\n
\n \n
\n
\n
\n
\n
\n

http_method [required]

\n
\n

string

\n

HTTP method for the resource request.

\n
\n \n
\n
\n
\n
\n
\n

load_frequency_pct [required]

\n
\n

double

\n

Percentage of sampled view instances that loaded this resource.

\n
\n \n
\n
\n
\n
\n
\n

max_duration_ms [required]

\n
\n

double

\n

Maximum duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

median_duration_ms [required]

\n
\n

double

\n

Median duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

min_duration_ms [required]

\n
\n

double

\n

Minimum duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

p75_duration_ms [required]

\n
\n

double

\n

75th percentile duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

p95_duration_ms [required]

\n
\n

double

\n

95th percentile duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

string

\n

Resource type (JS, CSS, image, fetch, XHR, document, and so on).

\n
\n \n
\n
\n
\n
\n
\n

resource_url_path_group [required]

\n
\n

string

\n

URL path group used to aggregate similar resources.

\n
\n \n
\n
\n
\n
\n
\n

timing_breakdown [required]

\n
\n

object

\n

Average timing breakdown per network phase for a resource.

\n
\n
\n
\n
\n
\n

avg_connect_ms [required]

\n
\n

double

\n

Average TCP connect duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_dns_ms [required]

\n
\n

double

\n

Average DNS resolution duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_download_ms [required]

\n
\n

double

\n

Average download phase duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_first_byte_ms [required]

\n
\n

double

\n

Average time to first byte in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_redirect_ms [required]

\n
\n

double

\n

Average redirect phase duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_ssl_ms [required]

\n
\n

double

\n

Average SSL handshake duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

total_requests [required]

\n
\n

int32

\n

Total number of requests for this resource across all sampled views.

\n
\n \n
\n
\n
\n
\n
\n

views_with_resource [required]

\n
\n

int32

\n

Number of sampled view instances that loaded this resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sampled_view_ids [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

total_cache_hit_rate_pct [required]

\n
\n

double

\n

Overall cache hit rate across all sampled views.

\n
\n \n
\n
\n
\n
\n
\n

view_count [required]

\n
\n

int32

\n

Number of view instances included in the analysis.

\n
\n \n
\n
\n
\n
\n
\n

view_name [required]

\n
\n

string

\n

The RUM view name that was analyzed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Hash-based unique identifier for this aggregation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for aggregated waterfall requests. \nAllowed enum values: aggregated_waterfall

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data envelope for an aggregated waterfall response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an aggregated waterfall response.

\n
\n
\n
\n
\n
\n

application_id [required]

\n
\n

string

\n

The RUM application ID that was analyzed.

\n
\n \n
\n
\n
\n
\n
\n

criteria [required]

\n
\n

object

\n

Performance criteria used to filter view instances by a metric threshold, or null when no criteria was applied.

\n
\n
\n
\n
\n
\n

max

\n
\n

double

\n

Maximum threshold in seconds (inclusive).

\n
\n \n
\n
\n
\n
\n
\n

metric [required]

\n
\n

enum

\n

Performance metric used to filter view instances by threshold. \nAllowed enum values: loading_time,largest_contentful_paint,first_contentful_paint,interaction_to_next_paint

\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

double

\n

Minimum threshold in seconds (inclusive).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

resources [required]

\n
\n

[object]

\n

Network resources in chronological waterfall order.

\n
\n
\n
\n
\n
\n

avg_duration_ms [required]

\n
\n

double

\n

Average total duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_start_time_ms [required]

\n
\n

double

\n

Average start time relative to view start in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

cache_hit_rate_pct [required]

\n
\n

double

\n

Cache hit rate as a percentage.

\n
\n \n
\n
\n
\n
\n
\n

cached_count [required]

\n
\n

int32

\n

Number of requests served from cache.

\n
\n \n
\n
\n
\n
\n
\n

downloaded_count [required]

\n
\n

int32

\n

Number of requests downloaded from the network.

\n
\n \n
\n
\n
\n
\n
\n

global_p75_duration_ms

\n
\n

double

\n

75th percentile duration across all view names in the application, present when include_global_appearance is true.

\n
\n \n
\n
\n
\n
\n
\n

global_view_name_count

\n
\n

int32

\n

Number of distinct view names in the application that load this resource, present when include_global_appearance is true.

\n
\n \n
\n
\n
\n
\n
\n

global_view_name_pct

\n
\n

double

\n

Percentage of distinct view names in the application that load this resource, present when include_global_appearance is true.

\n
\n \n
\n
\n
\n
\n
\n

http_method [required]

\n
\n

string

\n

HTTP method for the resource request.

\n
\n \n
\n
\n
\n
\n
\n

load_frequency_pct [required]

\n
\n

double

\n

Percentage of sampled view instances that loaded this resource.

\n
\n \n
\n
\n
\n
\n
\n

local_cache_count [required]

\n
\n

int32

\n

Number of requests served from the local browser cache without a network round trip.

\n
\n \n
\n
\n
\n
\n
\n

max_duration_ms [required]

\n
\n

double

\n

Maximum duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

median_duration_ms [required]

\n
\n

double

\n

Median duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

min_duration_ms [required]

\n
\n

double

\n

Minimum duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

non_blocking_count [required]

\n
\n

int32

\n

Number of requests reported by the browser as non-render-blocking.

\n
\n \n
\n
\n
\n
\n
\n

p75_duration_ms [required]

\n
\n

double

\n

75th percentile duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

p95_duration_ms [required]

\n
\n

double

\n

95th percentile duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

render_blocking_count [required]

\n
\n

int32

\n

Number of requests reported by the browser as render-blocking.

\n
\n \n
\n
\n
\n
\n
\n

render_blocking_pct [required]

\n
\n

double

\n

Percentage of render-blocking requests among those reporting a render-blocking status.

\n
\n \n
\n
\n
\n
\n
\n

resource_type [required]

\n
\n

string

\n

Resource type (JS, CSS, image, fetch, XHR, document, and so on).

\n
\n \n
\n
\n
\n
\n
\n

resource_url_path_group [required]

\n
\n

string

\n

URL path group used to aggregate similar resources.

\n
\n \n
\n
\n
\n
\n
\n

server_validated_cache_count [required]

\n
\n

int32

\n

Number of cached requests revalidated by the server with a 304 response.

\n
\n \n
\n
\n
\n
\n
\n

timing_breakdown [required]

\n
\n

object

\n

Average timing breakdown per network phase for a resource.

\n
\n
\n
\n
\n
\n

avg_connect_ms [required]

\n
\n

double

\n

Average TCP connect duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_dns_ms [required]

\n
\n

double

\n

Average DNS resolution duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_download_ms [required]

\n
\n

double

\n

Average download phase duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_first_byte_ms [required]

\n
\n

double

\n

Average time to first byte in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_redirect_ms [required]

\n
\n

double

\n

Average redirect phase duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

avg_ssl_ms [required]

\n
\n

double

\n

Average SSL handshake duration in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

total_requests [required]

\n
\n

int32

\n

Total number of requests for this resource across all sampled views.

\n
\n \n
\n
\n
\n
\n
\n

views_with_resource [required]

\n
\n

int32

\n

Number of sampled view instances that loaded this resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sampled_view_ids [required]

\n
\n

[string]

\n

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

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

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

\n
\n \n
\n
\n
\n
\n
\n

total_cache_hit_rate_pct [required]

\n
\n

double

\n

Overall cache hit rate across all sampled views.

\n
\n \n
\n
\n
\n
\n
\n

view_count [required]

\n
\n

int32

\n

Number of view instances included in the analysis.

\n
\n \n
\n
\n
\n
\n
\n

view_name [required]

\n
\n

string

\n

The RUM view name that was analyzed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Hash-based unique identifier for this aggregation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API type for aggregated waterfall requests. \nAllowed enum values: aggregated_waterfall

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 86871edd333..ce9186feb5c 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -5148,6 +5148,12 @@ components: example: 54.0 format: double type: number + local_cache_count: + description: Number of requests served from the local browser cache without a network round trip. + example: 20 + format: int32 + maximum: 2147483647 + type: integer max_duration_ms: description: Maximum duration in milliseconds. example: 945.6 @@ -5163,6 +5169,12 @@ components: example: 812.7 format: double type: number + non_blocking_count: + description: Number of requests reported by the browser as non-render-blocking. + example: 23 + format: int32 + maximum: 2147483647 + type: integer p75_duration_ms: description: 75th percentile duration in milliseconds. example: 844.1 @@ -5173,6 +5185,17 @@ components: example: 861.8 format: double type: number + render_blocking_count: + description: Number of requests reported by the browser as render-blocking. + example: 4 + format: int32 + maximum: 2147483647 + type: integer + render_blocking_pct: + description: Percentage of render-blocking requests among those reporting a render-blocking status. + example: 14.8 + format: double + type: number resource_type: description: Resource type (JS, CSS, image, fetch, XHR, document, and so on). example: fetch @@ -5182,6 +5205,12 @@ components: description: URL path group used to aggregate similar resources. example: /api/gallery type: string + server_validated_cache_count: + description: Number of cached requests revalidated by the server with a 304 response. + example: 7 + format: int32 + maximum: 2147483647 + type: integer timing_breakdown: $ref: '#/components/schemas/AggregatedResourceTimingBreakdown' total_requests: @@ -5214,6 +5243,11 @@ components: - cached_count - downloaded_count - cache_hit_rate_pct + - render_blocking_count + - non_blocking_count + - render_blocking_pct + - local_cache_count + - server_validated_cache_count type: object AggregatedResourceTimingBreakdown: description: Average timing breakdown per network phase for a resource. @@ -5680,7 +5714,7 @@ components: example: ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b type: string criteria: - $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteria' + $ref: '#/components/schemas/AggregatedWaterfallResponseAttributesCriteria' from: description: Start of the analyzed time range as a Unix timestamp in seconds. example: 1762437564 @@ -5725,10 +5759,30 @@ components: - view_count - from - to + - criteria - sampled_view_ids - total_cache_hit_rate_pct - resources type: object + AggregatedWaterfallResponseAttributesCriteria: + description: Performance criteria used to filter view instances by a metric threshold, or null when no criteria was applied. + nullable: true + properties: + max: + description: Maximum threshold in seconds (inclusive). + example: 5.0 + format: double + type: number + metric: + $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteriaMetric' + min: + description: Minimum threshold in seconds (inclusive). + example: 2.5 + format: double + type: number + required: + - metric + type: object AggregatedWaterfallResponseData: description: Data envelope for an aggregated waterfall response. properties: @@ -196273,13 +196327,18 @@ paths: downloaded_count: 0 http_method: GET load_frequency_pct: 54.0 + local_cache_count: 20 max_duration_ms: 945.6 median_duration_ms: 836.2 min_duration_ms: 812.7 + non_blocking_count: 23 p75_duration_ms: 844.1 p95_duration_ms: 861.8 + render_blocking_count: 4 + render_blocking_pct: 14.8 resource_type: fetch resource_url_path_group: /api/gallery + server_validated_cache_count: 7 timing_breakdown: avg_connect_ms: 0.0 avg_dns_ms: 0.0