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

Describes the visible dimension columns and rows in the report response.


  • fieldNames (type: list(String.t), default: nil) - Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.
  • limit (type: String.t, default: nil) - The number of rows to return in this pivot. The limit parameter is required. A limit of 10,000 is common for single pivot requests. The product of the limit for each pivot in a RunPivotReportRequest must not exceed 100,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1,000,000.
  • metricAggregations (type: list(String.t), default: nil) - Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
  • offset (type: String.t, default: nil) - The row count of the start row. The first row is counted as row 0.
  • orderBys (type: list(GoogleApi.AnalyticsData.V1alpha.Model.OrderBy.t), default: nil) - Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.AnalyticsData.V1alpha.Model.Pivot{
  fieldNames: [String.t()] | nil,
  limit: String.t() | nil,
  metricAggregations: [String.t()] | nil,
  offset: String.t() | nil,
  orderBys: [GoogleApi.AnalyticsData.V1alpha.Model.OrderBy.t()] | nil

Link to this section Functions


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

Unwrap a decoded JSON object into its complex fields.