Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1321819.7 KB
records

Queries the Chrome User Experience for a single record for a given site. Returns a record that contains one or more metrics corresponding to performance data about the requested site.

post/v1/records:queryRecord

Request body

originstring

The url pattern "origin" refers to a url pattern that is the origin of a website. Examples: "https://example.com", "https://cloud.google.com"

metricsstring[]

The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: ["first_contentful_paint", "first_input_delay", "largest_contentful_paint", "cumulative_layout_shift", "experimental_time_to_first_byte", "experimental_interaction_to_next_paint"]

urlstring

The url pattern "url" refers to a url pattern that is any arbitrary url. Examples: "https://example.com/", "https://cloud.google.com/why-google-cloud/"

effectiveConnectionTypestring

The effective connection type is a query dimension that specifies the effective network class that the record's data should belong to. This field uses the values ["offline", "slow-2G", "2G", "3G", "4G"] as specified in: https://wicg.github.io/netinfo/#effective-connection-types Note: If no effective connection type is specified, then a special record with aggregated data over all effective connection types will be returned.

formFactor'ALL_FORM_FACTORS' | 'PHONE' | 'DESKTOP' | 'TABLET'

The form factor is a query dimension that specifies the device class that the record's data should belong to. Note: If no form factor is specified, then a special record with aggregated data over all form factors will be returned.

Response

Successful response

All 2 operations