GoogleApi.AnalyticsData.V1alpha.Model.RunPivotReportResponse (google_api_analytics_data v0.10.1) View Source

The response pivot report table corresponding to a pivot request.


  • aggregates (type: list(GoogleApi.AnalyticsData.V1alpha.Model.Row.t), default: nil) - Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metricaggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED".
  • dimensionHeaders (type: list(GoogleApi.AnalyticsData.V1alpha.Model.DimensionHeader.t), default: nil) - Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.
  • metadata (type: GoogleApi.AnalyticsData.V1alpha.Model.ResponseMetaData.t, default: nil) - Metadata for the report.
  • metricHeaders (type: list(GoogleApi.AnalyticsData.V1alpha.Model.MetricHeader.t), default: nil) - Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
  • pivotHeaders (type: list(GoogleApi.AnalyticsData.V1alpha.Model.PivotHeader.t), default: nil) - Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following pivotHeaders in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]
  • propertyQuota (type: GoogleApi.AnalyticsData.V1alpha.Model.PropertyQuota.t, default: nil) - This Analytics Property's quota state including this request.
  • rows (type: list(GoogleApi.AnalyticsData.V1alpha.Model.Row.t), default: nil) - Rows of dimension value combinations and metric values in the report.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.AnalyticsData.V1alpha.Model.RunPivotReportResponse{
  aggregates: [GoogleApi.AnalyticsData.V1alpha.Model.Row.t()] | nil,
    [GoogleApi.AnalyticsData.V1alpha.Model.DimensionHeader.t()] | nil,
  kind: String.t() | nil,
  metadata: GoogleApi.AnalyticsData.V1alpha.Model.ResponseMetaData.t() | nil,
  metricHeaders: [GoogleApi.AnalyticsData.V1alpha.Model.MetricHeader.t()] | nil,
  pivotHeaders: [GoogleApi.AnalyticsData.V1alpha.Model.PivotHeader.t()] | nil,
  propertyQuota: GoogleApi.AnalyticsData.V1alpha.Model.PropertyQuota.t() | nil,
  rows: [GoogleApi.AnalyticsData.V1alpha.Model.Row.t()] | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.