QueryRequest

import type { QueryRequest } from "https://googleapis.deno.dev/v1/chromeuxreport:v1.ts";

Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience record.

interface QueryRequest {

effectiveConnectionType?: string;

formFactor?:

| "ALL_FORM_FACTORS"

| "PHONE"

| "DESKTOP"

| "TABLET";

metrics?: string[];

origin?: string;

url?: string;

}

§Properties

effectiveConnectionType?: string

[src]

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"

[src]

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.

metrics?: string[]

[src]

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"]

origin?: string

[src]

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

url?: string

[src]

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/"