GoogleApi.ChromeUXReport.V1.Model.HistoryRecord (google_api_chrome_ux_report v0.6.0)

View Source

HistoryRecord is a timeseries of Chrome UX Report data. It contains user experience statistics for a single url pattern and a set of dimensions.

Attributes

  • collectionPeriods (type: list(GoogleApi.ChromeUXReport.V1.Model.CollectionPeriod.t), default: nil) - 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.
  • key (type: GoogleApi.ChromeUXReport.V1.Model.HistoryKey.t, default: nil) - Key defines all of the unique querying parameters needed to look up a user experience history record.
  • metrics (type: %{optional(String.t) => GoogleApi.ChromeUXReport.V1.Model.MetricTimeseries.t}, default: nil) - 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"]

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ChromeUXReport.V1.Model.HistoryRecord{
  collectionPeriods:
    [GoogleApi.ChromeUXReport.V1.Model.CollectionPeriod.t()] | nil,
  key: GoogleApi.ChromeUXReport.V1.Model.HistoryKey.t() | nil,
  metrics:
    %{
      optional(String.t()) =>
        GoogleApi.ChromeUXReport.V1.Model.MetricTimeseries.t()
    }
    | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.