Pivot

  • A Pivot describes the visible dimension columns and rows in the report response.

  • The fieldNames parameter specifies the dimension names for visible columns, and including "dateRange" adds a date range column.

  • orderBys specifies how dimensions are ordered in the pivot, affecting Row and PivotDimensionHeader ordering.

  • offset determines the starting row count for the pivot data.

  • limit sets the number of rows to return in the pivot, with a default of 10,000 and a maximum of 100,000.

  • metricAggregations aggregates metrics by dimensions in the pivot using specified methods.

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 rows to return in this pivot. If the limit parameter is unspecified, up to 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for.
metricAggregations[]

enum (MetricAggregation)

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