Method: reports.batchGet

Returns the Analytics data.

HTTP request

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

(This URI uses URI Template syntax.)

Request body

The request body contains data with the following structure:

JSON representation
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
}
Field name Type Description
reportRequests[] object(ReportRequest) Requests, each request will have a separate response. There can be a maximum of 5 requests. All requests should have the same dateRanges, viewId, segments, samplingLevel, and cohortGroup.

Response body

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

The main response class which holds the reports from the Reporting API batchGet call.

JSON representation
{
  "reports": [
    {
      object(Report)
    }
  ],
}
Field name Type Description
reports[] object(Report) Responses corresponding to each of the request.

Authorization

Requires one of the following OAuth scopes:

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

ReportRequest

The main request class which specifies the Reporting API request.

JSON representation
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean,
}
Field name Type Description
viewId string The Analytics view ID from which to retrieve data. Every ReportRequest within a batchGet method must contain the same viewId.
dateRanges[] object(DateRange) Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The reportRequest.dateRanges field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every ReportRequest within a batchGet method must contain the same dateRanges definition.
samplingLevel enum(Sampling) The desired report sample size. If the the samplingLevel field is unspecified the DEFAULT sampling level is used. Every ReportRequest within a batchGet method must contain the same samplingLevel definition. See developer guide for details.
dimensions[] object(Dimension) The dimensions requested. Requests can have a total of 7 dimensions.
dimensionFilterClauses[] object(DimensionFilterClause) The dimension filter clauses for filtering Dimension Values. They are logically combined with the AND operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions.
metrics[] object(Metric) The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.
metricFilterClauses[] object(MetricFilterClause) The metric filter clauses. They are logically combined with the AND operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.
filtersExpression string Dimension or metric filters that restrict the data returned for your request. To use the filtersExpression, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects ga:browser dimension which starts with Firefox; ga:browser=~^Firefox. For more information on dimensions and metric filters, see Filters reference.
orderBys[] object(OrderBy) Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.
segments[] object(Segment) Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every ReportRequest within a batchGet method must contain the same segments definition. Requests with segments must have the ga:segment dimension.
pivots[] object(Pivot) The pivot definitions. Requests can have a maximum of 2 pivots.
cohortGroup object(CohortGroup) Cohort group associated with this request. If there is a cohort group in the request the ga:cohort dimension must be present. Every ReportRequest within a batchGet method must contain the same cohortGroup definition.
pageToken string A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the reports.batchGet request.
pageSize number Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 10,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for ga:country, so when segmenting only by country, you can't get more than 300 rows, even if you set pageSize to a higher value.
includeEmptyRows boolean If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.
hideTotals boolean If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
hideValueRanges boolean If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.

DateRange

A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in ISO8601 date format YYYY-MM-DD.

JSON representation
{
  "startDate": string,
  "endDate": string,
}
Field name Type Description
startDate string The start date for the query in the format YYYY-MM-DD.
endDate string The end date for the query in the format YYYY-MM-DD.

Sampling

Values for the sampling level.

Enum value Description
SAMPLING_UNSPECIFIED If the samplingLevel field is unspecified the DEFAULT sampling level is used.
DEFAULT Returns response with a sample size that balances speed and accuracy.
SMALL It returns a fast response with a smaller sampling size.
LARGE Returns a more accurate response using a large sampling size. But this may result in response being slower.

Dimension

Dimensions are attributes of your data. For example, the dimension ga:city indicates the city, for example, "Paris" or "New York", from which a session originates.

JSON representation
{
  "name": string,
  "histogramBuckets": [
    string
  ],
}
Field name Type Description
name string Name of the dimension to fetch, for example ga:browser.
histogramBuckets[] string
(int64 format)

If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The "first" bucket includes all values less than the first boundary, the "last" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of "0, 1, 3, 4, 7", then we return the following buckets:

  • bucket #1: values < 0, dimension value "<0"
  • bucket #2: values in [0,1), dimension value "0"
  • bucket #3: values in [1,3), dimension value "1-2"
  • bucket #4: values in [3,4), dimension value "3"
  • bucket #5: values in [4,7), dimension value "4-6"
  • bucket #6: values >= 7, dimension value "7+"

NOTE: If you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type HISTOGRAM_BUCKET for that purpose. Without that the dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is:

"<50", "1001+", "121-1000", "50-120"

And the ascending HISTOGRAM_BUCKET order is:

"<50", "50-120", "121-1000", "1001+"

The client has to explicitly request "orderType": "HISTOGRAM_BUCKET" for a histogram-mutated dimension.

DimensionFilterClause

A group of dimension filters. Set the operator value to specify how the filters are logically combined.

JSON representation
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ],
}
Field name Type Description
operator enum(FilterLogicalOperator) The operator for combining multiple dimension filters. If unspecified, it is treated as an OR.
filters[] object(DimensionFilter) The repeated set of filters. They are logically combined based on the operator specified.

FilterLogicalOperator

How the filters are logically combined.

Enum value Description
OPERATOR_UNSPECIFIED Unspecified operator. It is treated as an OR.
OR The logical OR operator.
AND The logical AND operator.

DimensionFilter

Dimension filter specifies the filtering options on a dimension.

JSON representation
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean,
}
Field name Type Description
dimensionName string The dimension to filter on. A DimensionFilter must contain a dimension.
not boolean Logical NOT operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false.
operator enum(Operator) How to match the dimension to the expression. The default is REGEXP.
expressions[] string Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is IN_LIST. If IN_LIST operator, then the entire list is used to filter the dimensions as explained in the description of the IN_LIST operator.
caseSensitive boolean Should the match be case sensitive? Default is false.

Operator

Different match types supported.

Enum value Description
OPERATOR_UNSPECIFIED If the match type is unspecified, it is treated as a REGEXP.
REGEXP The match expression is treated as a regular expression. All match types are not treated as regular expressions.
BEGINS_WITH Matches the value which begin with the match expression provided.
ENDS_WITH Matches the values which end with the match expression provided.
PARTIAL Substring match.
EXACT The value should match the match expression entirely.
NUMERIC_EQUAL

Integer comparison filters. case sensitivity is ignored for these and the expression is assumed to be a string representing an integer. Failure conditions:

  • If expression is not a valid int64, the client should expect an error.
  • Input dimensions that are not valid int64 values will never match the filter.
NUMERIC_GREATER_THAN Checks if the dimension is numerically greater than the match expression. Read the description for NUMERIC_EQUALS for restrictions.
NUMERIC_LESS_THAN Checks if the dimension is numerically less than the match expression. Read the description for NUMERIC_EQUALS for restrictions.
IN_LIST

This option is used to specify a dimension filter whose expression can take any value from a selected list of values. This helps avoiding evaluating multiple exact match dimension filters which are OR'ed for every single response row. For example:

expressions: ["A", "B", "C"]

Any response row whose dimension has it is value as A, B or C, matches this DimensionFilter.

Metric

Metrics are the quantitative measurements. For example, the metric ga:users indicates the total number of users for the requested time period.

JSON representation
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType),
}
Field name Type Description
expression string A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example ga:totalRefunds/ga:users, in most cases the metric expression is just a single metric name like ga:users. Adding mixed MetricType (E.g., CURRENCY + PERCENTAGE) metrics will result in unexpected results.
alias string An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header.
formattingType enum(MetricType) Specifies how the metric expression should be formatted, for example INTEGER.

MetricType

The types of metrics.

Enum value Description
METRIC_TYPE_UNSPECIFIED Metric type is unspecified.
INTEGER Integer metric.
FLOAT Float metric.
CURRENCY Currency metric.
PERCENT Percentage metric.
TIME Time metric in HH:MM:SS format.

MetricFilterClause

Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.

JSON representation
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ],
}
Field name Type Description
operator enum(FilterLogicalOperator) The operator for combining multiple metric filters. If unspecified, it is treated as an OR.
filters[] object(MetricFilter) The repeated set of filters. They are logically combined based on the operator specified.

MetricFilter

MetricFilter specifies the filter on a metric.

JSON representation
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string,
}
Field name Type Description
metricName string The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression.
not boolean Logical NOT operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false.
operator enum(Operator) Is the metric EQUAL, LESS_THAN or GREATER_THAN the comparisonValue, the default is EQUAL. If the operator is IS_MISSING, checks if the metric is missing and would ignore the comparisonValue.
comparisonValue string The value to compare against.

Operator

Different comparison type options.

Enum value Description
OPERATOR_UNSPECIFIED If the operator is not specified, it is treated as EQUAL.
EQUAL Should the value of the metric be exactly equal to the comparison value.
LESS_THAN Should the value of the metric be less than to the comparison value.
GREATER_THAN Should the value of the metric be greater than to the comparison value.
IS_MISSING Validates if the metric is missing. Doesn't take comparisonValue into account.

OrderBy

Specifies the sorting options.

JSON representation
{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder),
}
Field name Type Description
fieldName string The field which to sort by. The default sort order is ascending. Example: ga:browser. Note, that you can only specify one field for sort here. For example, ga:browser, ga:city is not valid.
orderType enum(OrderType) The order type. The default orderType is VALUE.
sortOrder enum(SortOrder) The sorting order for the field.

OrderType

OrderType controls how the sort order is being determined.

Enum value Description
ORDER_TYPE_UNSPECIFIED Unspecified order type will be treated as sort based on value.
VALUE The sort order is based on the value of the chosen column; looks only at the first date range.
DELTA The sort order is based on the difference of the values of the chosen column between the first two date ranges. Usable only if there are exactly two date ranges.
SMART The sort order is based on weighted value of the chosen column. If column has n/d format, then weighted value of this ratio will be (n + totals.n)/(d + totals.d) Usable only for metrics that represent ratios.
HISTOGRAM_BUCKET Histogram order type is applicable only to dimension columns with non-empty histogram-buckets.
DIMENSION_AS_INTEGER If the dimensions are fixed length numbers, ordinary sort would just work fine. DIMENSION_AS_INTEGER can be used if the dimensions are variable length numbers.

SortOrder

The Sorting order of the sort.

Enum value Description
SORT_ORDER_UNSPECIFIED If the sort order is unspecified, the default is ascending.
ASCENDING Ascending sort. The field will be sorted in an ascending manner.
DESCENDING Descending sort. The field will be sorted in a descending manner.

Segment

The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city.

JSON representation
{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string,
  // End of list of possible types for union field dynamicOrById.
}
Field name Type Description
Union field dynamicOrById. The segment can be defined dynamically using DynamicSegment or by using an ID of a built-in or custom segment. dynamicOrById can be only one of the following:
dynamicSegment object(DynamicSegment) A dynamic segment definition in the request.
segmentId string The segment ID of a built-in or custom segment, for example gaid::-3.

DynamicSegment

Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.

JSON representation
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  },
}
Field name Type Description
name string The name of the dynamic segment.
userSegment object(SegmentDefinition) User Segment to select users to include in the segment.
sessionSegment object(SegmentDefinition) Session Segment to select sessions to include in the segment.

SegmentDefinition

SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical AND operation.

JSON representation
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ],
}
Field name Type Description
segmentFilters[] object(SegmentFilter) A segment is defined by a set of segment filters which are combined together with a logical AND operation.

SegmentFilter

SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.

JSON representation
{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  },
  // End of list of possible types for union field simpleOrSequence.
}
Field name Type Description
not boolean

If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },
Union field simpleOrSequence. Is it a simple segment or a sequence segment definition. simpleOrSequence can be only one of the following:
simpleSegment object(SimpleSegment) A Simple segment conditions consist of one or more dimension/metric conditions that can be combined
sequenceSegment object(SequenceSegment) Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.

SimpleSegment

A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.

JSON representation
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
}
Field name Type Description
orFiltersForSegment[] object(OrFiltersForSegment) A list of segment filters groups which are combined with logical AND operator.

OrFiltersForSegment

A list of segment filters in the OR group are combined with the logical OR operator.

JSON representation
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ],
}
Field name Type Description
segmentFilterClauses[] object(SegmentFilterClause) List of segment filters to be combined with a OR operator.

SegmentFilterClause

Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter.

JSON representation
{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  },
  // End of list of possible types for union field dimensionOrMetricFilter.
}
Field name Type Description
not boolean Matches the complement (!) of the filter.
Union field dimensionOrMetricFilter. Dimension or a metric filter. dimensionOrMetricFilter can be only one of the following:
dimensionFilter object(SegmentDimensionFilter) Dimension Filter for the segment definition.
metricFilter object(SegmentMetricFilter) Metric Filter for the segment definition.

SegmentDimensionFilter

Dimension filter specifies the filtering options on a dimension.

JSON representation
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string,
}
Field name Type Description
dimensionName string Name of the dimension for which the filter is being applied.
operator enum(Operator) The operator to use to match the dimension with the expressions.
caseSensitive boolean Should the match be case sensitive, ignored for IN_LIST operator.
expressions[] string The list of expressions, only the first element is used for all operators
minComparisonValue string Minimum comparison values for BETWEEN match type.
maxComparisonValue string Maximum comparison values for BETWEEN match type.

Operator

Different match types supported.

Enum value Description
OPERATOR_UNSPECIFIED If the match type is unspecified, it is treated as a REGEXP.
REGEXP The match expression is treated as a regular expression. All other match types are not treated as regular expressions.
BEGINS_WITH Matches the values which begin with the match expression provided.
ENDS_WITH Matches the values which end with the match expression provided.
PARTIAL Substring match.
EXACT The value should match the match expression entirely.
IN_LIST

This option is used to specify a dimension filter whose expression can take any value from a selected list of values. This helps avoiding evaluating multiple exact match dimension filters which are OR'ed for every single response row. For example:

expressions: ["A", "B", "C"]

Any response row whose dimension has it is value as A, B or C, matches this DimensionFilter.

NUMERIC_LESS_THAN

Integer comparison filters. case sensitivity is ignored for these and the expression is assumed to be a string representing an integer. Failure conditions:

  • if expression is not a valid int64, the client should expect an error.
  • input dimensions that are not valid int64 values will never match the filter.

Checks if the dimension is numerically less than the match expression.

NUMERIC_GREATER_THAN Checks if the dimension is numerically greater than the match expression.
NUMERIC_BETWEEN Checks if the dimension is numerically between the minimum and maximum of the match expression, boundaries excluded.

SegmentMetricFilter

Metric filter to be used in a segment filter clause.

JSON representation
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string,
}
Field name Type Description
scope enum(Scope) Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions.
metricName string The metric that will be filtered on. A metricFilter must contain a metric name.
operator enum(Operator) Specifies is the operation to perform to compare the metric. The default is EQUAL.
comparisonValue string The value to compare against. If the operator is BETWEEN, this value is treated as minimum comparison value.
maxComparisonValue string Max comparison value is only used for BETWEEN operator.

Scope

A scope for a metric defines the level at which that metric is defined - PRODUCT, HIT, SESSION, or USER. Metric values can also be reported at scopes greater than its primary scope. E.g., ga:pageviews and ga:transactions can be reported at SESSION and USER level by just adding them up for each hit that occurs in those sessions or for those users.

Enum value Description
UNSPECIFIED_SCOPE If the scope is unspecified, it defaults to the condition scope, USER or SESSION depending on if the segment is trying to choose users or sessions.
PRODUCT Product scope.
HIT Hit scope.
SESSION Session scope.
USER User scope.

Operator

Different comparison type options.

Enum value Description
UNSPECIFIED_OPERATOR Unspecified operator is treated as LESS_THAN operator.
LESS_THAN Checks if the metric value is less than comparison value.
GREATER_THAN Checks if the metric value is greater than comparison value.
EQUAL Equals operator.
BETWEEN For between operator, both the minimum and maximum are exclusive. We will use LT and GT for comparison.

SequenceSegment

Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.

JSON representation
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean,
}
Field name Type Description
segmentSequenceSteps[] object(SegmentSequenceStep) The list of steps in the sequence.
firstStepShouldMatchFirstHit boolean If set, first step condition must match the first hit of the visitor (in the date range).

SegmentSequenceStep

A segment sequence definition.

JSON representation
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType),
}
Field name Type Description
orFiltersForSegment[] object(OrFiltersForSegment) A sequence is specified with a list of Or grouped filters which are combined with AND operator.
matchType enum(MatchType) Specifies if the step immediately precedes or can be any time before the next step.

MatchType

The match type for the sequence.

Enum value Description
UNSPECIFIED_MATCH_TYPE Unspecified match type is treated as precedes.
PRECEDES Operator indicates that the previous step precedes the next step.
IMMEDIATELY_PRECEDES Operator indicates that the previous step immediately precedes the next step.

Pivot

The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension.

JSON representation
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number,
}
Field name Type Description
dimensions[] object(Dimension) A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request.
dimensionFilterClauses[] object(DimensionFilterClause) DimensionFilterClauses are logically combined with an AND operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have ga:browser as the requested dimension in the pivot region, and you specify key filters to restrict ga:browser to only "IE" or "Firefox", then only those two browsers would show up as columns.
metrics[] object(Metric) The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.
startGroup number

If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension ga:browser then you'd get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE.

The following let you choose which of the groups of k columns are included in the response.

maxGroupCount number Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000.

CohortGroup

Defines a cohort group. For example:

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
JSON representation
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean,
}
Field name Type Description
cohorts[] object(Cohort) The definition for the cohort.
lifetimeValue boolean

Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: Cohort Analysis and Lifetime Value If the value of lifetimeValue is false:

  • The metric values are similar to the values in the web interface cohort report.
  • The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting ga:cohortNthWeek the startDate in the cohort definition should be a Sunday and the endDate should be the following Saturday, and for ga:cohortNthMonth, the startDate should be the 1st of the month and endDate should be the last day of the month.

When the lifetimeValue is true:

  • The metric values will correspond to the values in the web interface LifeTime value report.
  • The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired.
  • The metrics are calculated as a cumulative average per user per the time increment.
  • The cohort definition date ranges need not be aligned to the calendar week and month boundaries.
  • The viewId must be an app view ID

Cohort

Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.

JSON representation
{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  },
}
Field name Type Description
name string A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].
type enum(Type) Type of the cohort. The only supported type as of now is FIRST_VISIT_DATE. If this field is unspecified the cohort is treated as FIRST_VISIT_DATE type cohort.
dateRange object(DateRange) This is used for FIRST_VISIT_DATE cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange. The date ranges should be aligned for cohort requests. If the request contains ga:cohortNthDay it should be exactly one day long, if ga:cohortNthWeek it should be aligned to the week boundary (starting at Sunday and ending Saturday), and for ga:cohortNthMonth the date range should be aligned to the month (starting at the first and ending on the last day of the month). For LTV requests there are no such restrictions. You do not need to supply a date range for the reportsRequest.dateRanges field.

Type

The cohort type.

Enum value Description
UNSPECIFIED_COHORT_TYPE If unspecified it's treated as FIRST_VISIT_DATE.
FIRST_VISIT_DATE Cohorts that are selected based on first visit date.

Report

The data response corresponding to the request.

JSON representation
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string,
}
Field name Type Description
columnHeader object(ColumnHeader) The column headers.
data object(ReportData) Response data.
nextPageToken string Page token to retrieve the next page of results in the list.

ColumnHeader

Column headers.

JSON representation
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  },
}
Field name Type Description
dimensions[] string The dimension names in the response.
metricHeader object(MetricHeader) Metric headers for the metrics in the response.

MetricHeader

The headers for the metrics.

JSON representation
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ],
}
Field name Type Description
metricHeaderEntries[] object(MetricHeaderEntry) Headers for the metrics in the response.
pivotHeaders[] object(PivotHeader) Headers for the pivots in the response.

MetricHeaderEntry

Header for the metrics.

JSON representation
{
  "name": string,
  "type": enum(MetricType),
}
Field name Type Description
name string The name of the header.
type enum(MetricType) The type of the metric, for example INTEGER.

PivotHeader

The headers for each of the pivot sections defined in the request.

JSON representation
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number,
}
Field name Type Description
pivotHeaderEntries[] object(PivotHeaderEntry) A single pivot section header.
totalPivotGroupsCount number The total number of groups for this pivot.

PivotHeaderEntry

The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.

JSON representation
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  },
}
Field name Type Description
dimensionNames[] string The name of the dimensions in the pivot response.
dimensionValues[] string The values for the dimensions in the pivot.
metric object(MetricHeaderEntry) The metric header for the metric in the pivot.

ReportData

The data part of the report.

JSON representation
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
}
Field name Type Description
rows[] object(ReportRow) There's one ReportRow for every unique combination of dimensions.
totals[] object(DateRangeValues) For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for 3 / (ga:sessions + 2) we compute 3 / ((sum of all relevant ga:sessions) + 2). Totals are computed before pagination.
rowCount number Total number of matching rows for this query.
minimums[] object(DateRangeValues) Minimum and maximum values seen over all matching rows. These are both empty when hideValueRanges in the request is false, or when rowCount is zero.
maximums[] object(DateRangeValues) Minimum and maximum values seen over all matching rows. These are both empty when hideValueRanges in the request is false, or when rowCount is zero.
samplesReadCounts[] string
(int64 format)
If the results are sampled, this returns the total number of samples read, one entry per date range. If the results are not sampled this field will not be defined. See developer guide for details.
samplingSpaceSizes[] string
(int64 format)
If the results are sampled, this returns the total number of samples present, one entry per date range. If the results are not sampled this field will not be defined. See developer guide for details.
isDataGolden boolean Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time.

ReportRow

A row in the report.

JSON representation
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ],
}
Field name Type Description
dimensions[] string List of requested dimensions.
metrics[] object(DateRangeValues) List of metrics for each requested DateRange.

DateRangeValues

Used to return a list of metrics for a single DateRange / dimension combination

JSON representation
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ],
}
Field name Type Description
values[] string Each value corresponds to each Metric in the request.
pivotValueRegions[] object(PivotValueRegion) The values of each pivot region.

PivotValueRegion

The metric values in the pivot region.

JSON representation
{
  "values": [
    string
  ],
}
Field name Type Description
values[] string The values of the metrics in each of the pivot regions.

Try it!