Pivot

  • JSON representation describes the structure for defining the layout and data of a report, including visible dimensions and rows.

  • It allows specifying dimension names, ordering, data range, row limits, and metric aggregations for the report output.

  • orderBys field determines the ordering of dimensions within the report, impacting both row and pivot dimension headers.

  • offset and limit fields control the range of rows returned, with limit being a required parameter subject to specific constraints.

  • metricAggregations enables the aggregation of metrics based on dimensions, providing summarized insights within the report.

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

JSON representation 
{
  "fieldNames": [
    string
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ]
}
Fields
fieldNames[]

string

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.
orderBys[]

object (OrderBy)

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.
offset

string (int64 format)

The row count of the start row. The first row is counted as row 0.
limit

string (int64 format)

The number of unique combinations of dimension values 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 250,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1,000,000.
metricAggregations[]

enum (MetricAggregation)

Aggregate the metrics by dimensions in this pivot using the specified metricAggregations.