Returns multiple reports in a batch. All reports must be for the same Entity.
HTTP request
POST https://analyticsdata.googleapis.com/v1alpha:batchRunReports
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{ "entity": { object ( |
Fields | |
---|---|
entity |
A property whose events are tracked. This entity must be specified for the batch. The entity within RunReportRequest may either be unspecified or consistent with this entity. |
requests[] |
Individual requests. Each request has a separate 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 reports.
JSON representation | |
---|---|
{
"reports": [
{
object ( |
Fields | |
---|---|
reports[] |
Individual responses. Each response has a separate report request. |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
RunReportRequest
The request to generate a report.
JSON representation | |
---|---|
{ "entity": { object ( |
Fields | |
---|---|
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[] |
The dimensions requested and displayed. |
metrics[] |
The metrics requested and displayed. |
dateRanges[] |
Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this |
offset |
The row count of the start row. The first row is counted as row 0. |
limit |
The number of rows to return. If the |
metricAggregations[] |
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimensionValues are set to "RESERVED_(MetricAggregation)". |
dimensionFilter |
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter. |
metricFilter |
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. |
orderBys[] |
Specifies how rows are ordered in the response. |
currencyCode |
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 |
Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. |
keepEmptyRows |
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 |
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota. |