Take our developer survey. We want your feedback so we can learn how to improve Google Analytics, and make it an even better tool for you.

Method: batchRunPivotReports

Returns multiple pivot reports in a batch. All reports must be for the same Entity.

HTTP request

POST https://analyticsdata.googleapis.com/v1alpha:batchRunPivotReports

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "entity": {
    object (Entity)
  },
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
Fields
entity

object (Entity)

A property whose events are tracked. This entity must be specified for the batch. The entity within RunPivotReportRequest may either be unspecified or consistent with this entity.

requests[]

object (RunPivotReportRequest)

Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests.

Response body

If successful, the response body contains data with the following structure:

The batch response containing multiple pivot reports.

JSON representation
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ]
}
Fields
pivotReports[]

object (RunPivotReportResponse)

Individual responses. Each response has a separate pivot report request.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

RunPivotReportRequest

The request to generate a pivot report.

JSON representation
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Fields
entity

object (Entity)

A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

dimensions[]

object (Dimension)

The dimensions requested. All defined dimensions must be used by one of the following: dimensionExpression, dimensionFilter, pivots, orderBys.

metrics[]

object (Metric)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metricFilter, orderBys.

dimensionFilter

object (FilterExpression)

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

metricFilter

object (FilterExpression)

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

pivots[]

object (Pivot)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

dateRanges[]

object (DateRange)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

currencyCode

string

A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity's default currency.

cohortSpec

object (CohortSpec)

Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

keepEmptyRows

boolean

If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

returnPropertyQuota

boolean

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.