1{
2 "basePath": "",
3 "baseUrl": "https://chromeuxreport.googleapis.com/",
4 "batchPath": "batch",
5 "canonicalName": "Chrome UX Report",
6 "description": "The Chrome UX Report API lets you view real user experience data for millions of websites. ",
7 "discoveryVersion": "v1",
8 "documentationLink": "https://developers.google.com/web/tools/chrome-user-experience-report/api/reference",
9 "fullyEncodeReservedExpansion": true,
10 "icons": {
11 "x16": "http://www.google.com/images/icons/product/search-16.gif",
12 "x32": "http://www.google.com/images/icons/product/search-32.gif"
13 },
14 "id": "chromeuxreport:v1",
15 "kind": "discovery#restDescription",
16 "mtlsRootUrl": "https://chromeuxreport.mtls.googleapis.com/",
17 "name": "chromeuxreport",
18 "ownerDomain": "google.com",
19 "ownerName": "Google",
20 "parameters": {
21 "$.xgafv": {
22 "description": "V1 error format.",
23 "enum": [
24 "1",
25 "2"
26 ],
27 "enumDescriptions": [
28 "v1 error format",
29 "v2 error format"
30 ],
31 "location": "query",
32 "type": "string"
33 },
34 "access_token": {
35 "description": "OAuth access token.",
36 "location": "query",
37 "type": "string"
38 },
39 "alt": {
40 "default": "json",
41 "description": "Data format for response.",
42 "enum": [
43 "json",
44 "media",
45 "proto"
46 ],
47 "enumDescriptions": [
48 "Responses with Content-Type of application/json",
49 "Media download with context-dependent Content-Type",
50 "Responses with Content-Type of application/x-protobuf"
51 ],
52 "location": "query",
53 "type": "string"
54 },
55 "callback": {
56 "description": "JSONP",
57 "location": "query",
58 "type": "string"
59 },
60 "fields": {
61 "description": "Selector specifying which fields to include in a partial response.",
62 "location": "query",
63 "type": "string"
64 },
65 "key": {
66 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
67 "location": "query",
68 "type": "string"
69 },
70 "oauth_token": {
71 "description": "OAuth 2.0 token for the current user.",
72 "location": "query",
73 "type": "string"
74 },
75 "prettyPrint": {
76 "default": "true",
77 "description": "Returns response with indentations and line breaks.",
78 "location": "query",
79 "type": "boolean"
80 },
81 "quotaUser": {
82 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
83 "location": "query",
84 "type": "string"
85 },
86 "uploadType": {
87 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
88 "location": "query",
89 "type": "string"
90 },
91 "upload_protocol": {
92 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
93 "location": "query",
94 "type": "string"
95 }
96 },
97 "protocol": "rest",
98 "resources": {
99 "records": {
100 "methods": {
101 "queryHistoryRecord": {
102 "description": "Queries the Chrome User Experience Report for a timeseries `history record` for a given site. Returns a `history record` that contains one or more `metric timeseries` corresponding to performance data about the requested site.",
103 "flatPath": "v1/records:queryHistoryRecord",
104 "httpMethod": "POST",
105 "id": "chromeuxreport.records.queryHistoryRecord",
106 "parameterOrder": [],
107 "parameters": {},
108 "path": "v1/records:queryHistoryRecord",
109 "request": {
110 "$ref": "QueryHistoryRequest"
111 },
112 "response": {
113 "$ref": "QueryHistoryResponse"
114 }
115 },
116 "queryRecord": {
117 "description": "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.",
118 "flatPath": "v1/records:queryRecord",
119 "httpMethod": "POST",
120 "id": "chromeuxreport.records.queryRecord",
121 "parameterOrder": [],
122 "parameters": {},
123 "path": "v1/records:queryRecord",
124 "request": {
125 "$ref": "QueryRequest"
126 },
127 "response": {
128 "$ref": "QueryResponse"
129 }
130 }
131 }
132 }
133 },
134 "revision": "20240102",
135 "rootUrl": "https://chromeuxreport.googleapis.com/",
136 "schemas": {
137 "Bin": {
138 "description": "A bin is a discrete portion of data spanning from start to end, or if no end is given, then from start to +inf. A bin's start and end values are given in the value type of the metric it represents. For example, \"first contentful paint\" is measured in milliseconds and exposed as ints, therefore its metric bins will use int32s for its start and end types. However, \"cumulative layout shift\" is measured in unitless decimals and is exposed as a decimal encoded as a string, therefore its metric bins will use strings for its value type.",
139 "id": "Bin",
140 "properties": {
141 "density": {
142 "description": "The proportion of users that experienced this bin's value for the given metric.",
143 "format": "double",
144 "type": "number"
145 },
146 "end": {
147 "description": "End is the end of the data bin. If end is not populated, then the bin has no end and is valid from start to +inf.",
148 "type": "any"
149 },
150 "start": {
151 "description": "Start is the beginning of the data bin.",
152 "type": "any"
153 }
154 },
155 "type": "object"
156 },
157 "CollectionPeriod": {
158 "description": "The collection period is a date range which includes the `first` and `last` day.",
159 "id": "CollectionPeriod",
160 "properties": {
161 "firstDate": {
162 "$ref": "Date",
163 "description": "The first day in the collection period, inclusive."
164 },
165 "lastDate": {
166 "$ref": "Date",
167 "description": "The last day in the collection period, inclusive."
168 }
169 },
170 "type": "object"
171 },
172 "Date": {
173 "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
174 "id": "Date",
175 "properties": {
176 "day": {
177 "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
178 "format": "int32",
179 "type": "integer"
180 },
181 "month": {
182 "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
183 "format": "int32",
184 "type": "integer"
185 },
186 "year": {
187 "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
188 "format": "int32",
189 "type": "integer"
190 }
191 },
192 "type": "object"
193 },
194 "FractionTimeseries": {
195 "description": "For enum metrics, provides fraction timeseries which add up to approximately 1.0 per entry (k-th element into the repeated fractions field for any k \u003c= len) across fraction_timeseries.",
196 "id": "FractionTimeseries",
197 "properties": {
198 "fractions": {
199 "description": "Values between 0.0 and 1.0 (inclusive) and NaN.",
200 "items": {
201 "format": "double",
202 "type": "number"
203 },
204 "type": "array"
205 }
206 },
207 "type": "object"
208 },
209 "HistoryKey": {
210 "description": "Key defines all the dimensions that identify this record as unique.",
211 "id": "HistoryKey",
212 "properties": {
213 "formFactor": {
214 "description": "The form factor is the device class that all users used to access the site for this record. If the form factor is unspecified, then aggregated data over all form factors will be returned.",
215 "enum": [
216 "ALL_FORM_FACTORS",
217 "PHONE",
218 "DESKTOP",
219 "TABLET"
220 ],
221 "enumDescriptions": [
222 "The default value, representing all device classes.",
223 "The device class representing a \"mobile\"/\"phone\" sized client.",
224 "The device class representing a \"desktop\"/\"laptop\" type full size client.",
225 "The device class representing a \"tablet\" type client."
226 ],
227 "type": "string"
228 },
229 "origin": {
230 "description": "Origin specifies the origin that this record is for. Note: When specifying an origin, data for loads under this origin over all pages are aggregated into origin level user experience data.",
231 "type": "string"
232 },
233 "url": {
234 "description": "Url specifies a specific url that this record is for. This url should be normalized, following the normalization actions taken in the request to increase the chances of successful lookup. Note: When specifying a \"url\" only data for that specific url will be aggregated.",
235 "type": "string"
236 }
237 },
238 "type": "object"
239 },
240 "HistoryRecord": {
241 "description": "HistoryRecord is a timeseries of Chrome UX Report data. It contains user experience statistics for a single url pattern and a set of dimensions.",
242 "id": "HistoryRecord",
243 "properties": {
244 "collectionPeriods": {
245 "description": "The collection periods indicate when each of the data points reflected in the time series data in metrics was collected. Note that all the time series share the same collection periods, and it is enforced in the CrUX pipeline that every time series has the same number of data points.",
246 "items": {
247 "$ref": "CollectionPeriod"
248 },
249 "type": "array"
250 },
251 "key": {
252 "$ref": "HistoryKey",
253 "description": "Key defines all of the unique querying parameters needed to look up a user experience history record."
254 },
255 "metrics": {
256 "additionalProperties": {
257 "$ref": "MetricTimeseries"
258 },
259 "description": "Metrics is the map of user experience time series data available for the record defined in the key field. Metrics are keyed on the metric name. Allowed key values: [\"first_contentful_paint\", \"first_input_delay\", \"largest_contentful_paint\", \"cumulative_layout_shift\", \"experimental_time_to_first_byte\", \"experimental_interaction_to_next_paint\"]",
260 "type": "object"
261 }
262 },
263 "type": "object"
264 },
265 "Key": {
266 "description": "Key defines all the dimensions that identify this record as unique.",
267 "id": "Key",
268 "properties": {
269 "effectiveConnectionType": {
270 "description": "The effective connection type is the general connection class that all users experienced for this record. This field uses the values [\"offline\", \"slow-2G\", \"2G\", \"3G\", \"4G\"] as specified in: https://wicg.github.io/netinfo/#effective-connection-types If the effective connection type is unspecified, then aggregated data over all effective connection types will be returned.",
271 "type": "string"
272 },
273 "formFactor": {
274 "description": "The form factor is the device class that all users used to access the site for this record. If the form factor is unspecified, then aggregated data over all form factors will be returned.",
275 "enum": [
276 "ALL_FORM_FACTORS",
277 "PHONE",
278 "DESKTOP",
279 "TABLET"
280 ],
281 "enumDescriptions": [
282 "The default value, representing all device classes.",
283 "The device class representing a \"mobile\"/\"phone\" sized client.",
284 "The device class representing a \"desktop\"/\"laptop\" type full size client.",
285 "The device class representing a \"tablet\" type client."
286 ],
287 "type": "string"
288 },
289 "origin": {
290 "description": "Origin specifies the origin that this record is for. Note: When specifying an origin, data for loads under this origin over all pages are aggregated into origin level user experience data.",
291 "type": "string"
292 },
293 "url": {
294 "description": "Url specifies a specific url that this record is for. Note: When specifying a \"url\" only data for that specific url will be aggregated.",
295 "type": "string"
296 }
297 },
298 "type": "object"
299 },
300 "Metric": {
301 "description": "A `metric` is a set of user experience data for a single web performance metric, like \"first contentful paint\". It contains a summary histogram of real world Chrome usage as a series of `bins`.",
302 "id": "Metric",
303 "properties": {
304 "fractions": {
305 "additionalProperties": {
306 "format": "double",
307 "type": "number"
308 },
309 "description": "For enum metrics, provides fractions which add up to approximately 1.0.",
310 "type": "object"
311 },
312 "histogram": {
313 "description": "The histogram of user experiences for a metric. The histogram will have at least one bin and the densities of all bins will add up to ~1.",
314 "items": {
315 "$ref": "Bin"
316 },
317 "type": "array"
318 },
319 "percentiles": {
320 "$ref": "Percentiles",
321 "description": "Commonly useful percentiles of the Metric. The value type for the percentiles will be the same as the value types given for the Histogram bins."
322 }
323 },
324 "type": "object"
325 },
326 "MetricTimeseries": {
327 "description": "A `metric timeseries` is a set of user experience data for a single web performance metric, like \"first contentful paint\". It contains a summary histogram of real world Chrome usage as a series of `bins`, where each bin has density values for a particular time period.",
328 "id": "MetricTimeseries",
329 "properties": {
330 "fractionTimeseries": {
331 "additionalProperties": {
332 "$ref": "FractionTimeseries"
333 },
334 "description": "Mapping from labels to timeseries of fractions attributed to this label.",
335 "type": "object"
336 },
337 "histogramTimeseries": {
338 "description": "The histogram of user experiences for a metric. The histogram will have at least one bin and the densities of all bins will add up to ~1, for each timeseries entry.",
339 "items": {
340 "$ref": "TimeseriesBin"
341 },
342 "type": "array"
343 },
344 "percentilesTimeseries": {
345 "$ref": "TimeseriesPercentiles",
346 "description": "Commonly useful percentiles of the Metric. The value type for the percentiles will be the same as the value types given for the Histogram bins."
347 }
348 },
349 "type": "object"
350 },
351 "Percentiles": {
352 "description": "Percentiles contains synthetic values of a metric at a given statistical percentile. These are used for estimating a metric's value as experienced by a percentage of users out of the total number of users.",
353 "id": "Percentiles",
354 "properties": {
355 "p75": {
356 "description": "75% of users experienced the given metric at or below this value.",
357 "type": "any"
358 }
359 },
360 "type": "object"
361 },
362 "QueryHistoryRequest": {
363 "description": "Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience history record.",
364 "id": "QueryHistoryRequest",
365 "properties": {
366 "formFactor": {
367 "description": "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.",
368 "enum": [
369 "ALL_FORM_FACTORS",
370 "PHONE",
371 "DESKTOP",
372 "TABLET"
373 ],
374 "enumDescriptions": [
375 "The default value, representing all device classes.",
376 "The device class representing a \"mobile\"/\"phone\" sized client.",
377 "The device class representing a \"desktop\"/\"laptop\" type full size client.",
378 "The device class representing a \"tablet\" type client."
379 ],
380 "type": "string"
381 },
382 "metrics": {
383 "description": "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\"]",
384 "items": {
385 "type": "string"
386 },
387 "type": "array"
388 },
389 "origin": {
390 "description": "The url pattern \"origin\" refers to a url pattern that is the origin of a website. Examples: \"https://example.com\", \"https://cloud.google.com\"",
391 "type": "string"
392 },
393 "url": {
394 "description": "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/\"",
395 "type": "string"
396 }
397 },
398 "type": "object"
399 },
400 "QueryHistoryResponse": {
401 "description": "Response payload sent back to a physical web client. This response contains the record found based on the identiers present in a `QueryHistoryRequest`. The returned response will have a history record, and sometimes details on normalization actions taken on the request that were necessary to make the request successful.",
402 "id": "QueryHistoryResponse",
403 "properties": {
404 "record": {
405 "$ref": "HistoryRecord",
406 "description": "The record that was found."
407 },
408 "urlNormalizationDetails": {
409 "$ref": "UrlNormalization",
410 "description": "These are details about automated normalization actions that were taken in order to make the requested `url_pattern` valid."
411 }
412 },
413 "type": "object"
414 },
415 "QueryRequest": {
416 "description": "Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience record.",
417 "id": "QueryRequest",
418 "properties": {
419 "effectiveConnectionType": {
420 "description": "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.",
421 "type": "string"
422 },
423 "formFactor": {
424 "description": "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.",
425 "enum": [
426 "ALL_FORM_FACTORS",
427 "PHONE",
428 "DESKTOP",
429 "TABLET"
430 ],
431 "enumDescriptions": [
432 "The default value, representing all device classes.",
433 "The device class representing a \"mobile\"/\"phone\" sized client.",
434 "The device class representing a \"desktop\"/\"laptop\" type full size client.",
435 "The device class representing a \"tablet\" type client."
436 ],
437 "type": "string"
438 },
439 "metrics": {
440 "description": "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\"]",
441 "items": {
442 "type": "string"
443 },
444 "type": "array"
445 },
446 "origin": {
447 "description": "The url pattern \"origin\" refers to a url pattern that is the origin of a website. Examples: \"https://example.com\", \"https://cloud.google.com\"",
448 "type": "string"
449 },
450 "url": {
451 "description": "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/\"",
452 "type": "string"
453 }
454 },
455 "type": "object"
456 },
457 "QueryResponse": {
458 "description": "Response payload sent back to a physical web client. This response contains the record found based on the identiers present in a `QueryRequest`. The returned response will have a record, and sometimes details on normalization actions taken on the request that were necessary to make the request successful.",
459 "id": "QueryResponse",
460 "properties": {
461 "record": {
462 "$ref": "Record",
463 "description": "The record that was found."
464 },
465 "urlNormalizationDetails": {
466 "$ref": "UrlNormalization",
467 "description": "These are details about automated normalization actions that were taken in order to make the requested `url_pattern` valid."
468 }
469 },
470 "type": "object"
471 },
472 "Record": {
473 "description": "Record is a single Chrome UX report data record. It contains use experience statistics for a single url pattern and set of dimensions.",
474 "id": "Record",
475 "properties": {
476 "collectionPeriod": {
477 "$ref": "CollectionPeriod",
478 "description": "The collection period indicates when the data reflected in this record was collected."
479 },
480 "key": {
481 "$ref": "Key",
482 "description": "Key defines all of the unique querying parameters needed to look up a user experience record."
483 },
484 "metrics": {
485 "additionalProperties": {
486 "$ref": "Metric"
487 },
488 "description": "Metrics is the map of user experience data available for the record defined in the key field. Metrics are keyed on the metric name. Allowed key values: [\"first_contentful_paint\", \"first_input_delay\", \"largest_contentful_paint\", \"cumulative_layout_shift\", \"experimental_time_to_first_byte\", \"experimental_interaction_to_next_paint\"]",
489 "type": "object"
490 }
491 },
492 "type": "object"
493 },
494 "TimeseriesBin": {
495 "description": "A bin is a discrete portion of data spanning from start to end, or if no end is given, then from start to +inf. A bin's start and end values are given in the value type of the metric it represents. For example, \"first contentful paint\" is measured in milliseconds and exposed as ints, therefore its metric bins will use int32s for its start and end types. However, \"cumulative layout shift\" is measured in unitless decimals and is exposed as a decimal encoded as a string, therefore its metric bins will use strings for its value type.",
496 "id": "TimeseriesBin",
497 "properties": {
498 "densities": {
499 "description": "The proportion of users that experienced this bin's value for the given metric in a given collection period; the index for each of these entries corresponds to an entry in the CollectionPeriods field in the HistoryRecord message, which describes when the density was observed in the field. Thus, the length of this list of densities is equal to the length of the CollectionPeriods field in the HistoryRecord message.",
500 "items": {
501 "format": "double",
502 "type": "number"
503 },
504 "type": "array"
505 },
506 "end": {
507 "description": "End is the end of the data bin. If end is not populated, then the bin has no end and is valid from start to +inf.",
508 "type": "any"
509 },
510 "start": {
511 "description": "Start is the beginning of the data bin.",
512 "type": "any"
513 }
514 },
515 "type": "object"
516 },
517 "TimeseriesPercentiles": {
518 "description": "Percentiles contains synthetic values of a metric at a given statistical percentile. These are used for estimating a metric's value as experienced by a percentage of users out of the total number of users.",
519 "id": "TimeseriesPercentiles",
520 "properties": {
521 "p75s": {
522 "description": "75% of users experienced the given metric at or below this value. The length of this list of densities is equal to the length of the CollectionPeriods field in the HistoryRecord message, which describes when the density was observed in the field.",
523 "items": {
524 "type": "any"
525 },
526 "type": "array"
527 }
528 },
529 "type": "object"
530 },
531 "UrlNormalization": {
532 "description": "Object representing the normalization actions taken to normalize a url to achieve a higher chance of successful lookup. These are simple automated changes that are taken when looking up the provided `url_patten` would be known to fail. Complex actions like following redirects are not handled.",
533 "id": "UrlNormalization",
534 "properties": {
535 "normalizedUrl": {
536 "description": "The URL after any normalization actions. This is a valid user experience URL that could reasonably be looked up.",
537 "type": "string"
538 },
539 "originalUrl": {
540 "description": "The original requested URL prior to any normalization actions.",
541 "type": "string"
542 }
543 },
544 "type": "object"
545 }
546 },
547 "servicePath": "",
548 "title": "Chrome UX Report API",
549 "version": "v1",
550 "version_module": true
551}View as plain text