Skip to content

Commit

Permalink
feat(chromeuxreport): update the api
Browse files Browse the repository at this point in the history
#### chromeuxreport:v1

The following keys were added:
- schemas.FractionTimeseries (Total Keys: 5)
- schemas.MetricTimeseries.properties.fractionTimeseries (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Jan 4, 2024
1 parent f348e6d commit 02ba731
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/dyn/chromeuxreport_v1.records.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,13 @@ <h3>Method Details</h3>
},
&quot;metrics&quot;: { # 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: [&quot;first_contentful_paint&quot;, &quot;first_input_delay&quot;, &quot;largest_contentful_paint&quot;, &quot;cumulative_layout_shift&quot;, &quot;experimental_time_to_first_byte&quot;, &quot;experimental_interaction_to_next_paint&quot;]
&quot;a_key&quot;: { # A `metric timeseries` is a set of user experience data for a single web performance metric, like &quot;first contentful paint&quot;. 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.
&quot;fractionTimeseries&quot;: { # Mapping from labels to timeseries of fractions attributed to this label.
&quot;a_key&quot;: { # 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 &lt;= len) across fraction_timeseries.
&quot;fractions&quot;: [ # Values between 0.0 and 1.0 (inclusive) and NaN.
3.14,
],
},
},
&quot;histogramTimeseries&quot;: [ # 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.
{ # 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&#x27;s start and end values are given in the value type of the metric it represents. For example, &quot;first contentful paint&quot; is measured in milliseconds and exposed as ints, therefore its metric bins will use int32s for its start and end types. However, &quot;cumulative layout shift&quot; 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.
&quot;densities&quot;: [ # The proportion of users that experienced this bin&#x27;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.
Expand Down
24 changes: 23 additions & 1 deletion googleapiclient/discovery_cache/documents/chromeuxreport.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
}
}
},
"revision": "20231204",
"revision": "20240102",
"rootUrl": "https://chromeuxreport.googleapis.com/",
"schemas": {
"Bin": {
Expand Down Expand Up @@ -191,6 +191,21 @@
},
"type": "object"
},
"FractionTimeseries": {
"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 <= len) across fraction_timeseries.",
"id": "FractionTimeseries",
"properties": {
"fractions": {
"description": "Values between 0.0 and 1.0 (inclusive) and NaN.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"HistoryKey": {
"description": "Key defines all the dimensions that identify this record as unique.",
"id": "HistoryKey",
Expand Down Expand Up @@ -312,6 +327,13 @@
"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.",
"id": "MetricTimeseries",
"properties": {
"fractionTimeseries": {
"additionalProperties": {
"$ref": "FractionTimeseries"
},
"description": "Mapping from labels to timeseries of fractions attributed to this label.",
"type": "object"
},
"histogramTimeseries": {
"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.",
"items": {
Expand Down

0 comments on commit 02ba731

Please sign in to comment.