Google - API Analytics Reporting

Google / Analytics Reporting

Analytics Reporting

Accesses Analytics report data.

License: Creative Commons Attribution 3.0

Resources

reports

POST

/v4/reports:batchGet

Returns the Analytics data.

Request

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`GetReportsRequest`	object	The batch request containing multiple report request.

Properties


                        useResourceQuotas

boolean

Enables resource based quotas, (defaults to False). If this field is set to True the per view (profile) quotas are governed by the computational cost of the request. Note that using cost based quotas will higher enable sampling rates. (10 Million for SMALL, 100M for LARGE. See the limits and quotas documentation for details.


                        reportRequests

array [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.


                        ReportRequest

object

The main request class which specifies the Reporting API request.

Properties


                        viewId

string

The Analytics view ID from which to retrieve data. Every ReportRequest within a batchGet method must contain the same viewId.


                        segments

array [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.


                        Segment

object

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.

Properties

`segmentId`	string	The segment ID of a built-in or custom segment, for example `gaid::-3`.
`dynamicSegment`	DynamicSegment	A dynamic segment definition in the request.


                        samplingLevel

string
Allowed values:
- SAMPLING_UNSPECIFIED
- DEFAULT
- SMALL
- LARGE

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.


                        pivots

array [Pivot]

The pivot definitions. Requests can have a maximum of 2 pivots.


                        Pivot

object

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.

Properties

`startGroup`	integer	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.
`metrics`	array [Metric]	The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.
`maxGroupCount`	integer	Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000.
`dimensions`	array [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`	array [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.


                        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 GetReports request.


                        pageSize

integer

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 100,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.


                        orderBys

array [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.


                        OrderBy

object

Specifies the sorting options.

Properties

`sortOrder`	string Allowed values: - `SORT_ORDER_UNSPECIFIED` - `ASCENDING` - `DESCENDING`	The sorting order for the field.
`orderType`	string Allowed values: - `ORDER_TYPE_UNSPECIFIED` - `VALUE` - `DELTA` - `SMART` - `HISTOGRAM_BUCKET` - `DIMENSION_AS_INTEGER`	The order type. The default orderType is `VALUE`.
`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.


                        metrics

array [Metric]

The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.


                        Metric

object

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

Properties

`formattingType`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	Specifies how the metric expression should be formatted, for example `INTEGER`.
`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.


                        metricFilterClauses

array [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.


                        MetricFilterClause

object

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

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `OR` - `AND`	The operator for combining multiple metric filters. If unspecified, it is treated as an `OR`.
`filters`	array [MetricFilter]	The repeated set of filters. They are logically combined based on the operator specified.


                        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.


                        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.


                        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.


                        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.


                        dimensions

array [Dimension]

The dimensions requested. Requests can have a total of 9 dimensions.


                        Dimension

object

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.

Properties

`name`	string	Name of the dimension to fetch, for example `ga:browser`.
`histogramBuckets`	array [string]	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.


                        dimensionFilterClauses

array [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.


                        DimensionFilterClause

object

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

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `OR` - `AND`	The operator for combining multiple dimension filters. If unspecified, it is treated as an `OR`.
`filters`	array [DimensionFilter]	The repeated set of filters. They are logically combined based on the operator specified.


                        dateRanges

array [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.


                        DateRange

object

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

Properties

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


                        cohortGroup

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.


                        CohortGroup

object

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" }
  }]
}

Properties

`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
`cohorts`	array [Cohort]	The definition for the cohort.

Responses

200Successful response

Body

Name	Data Type	Description
`GetReportsResponse`	object	The main response class which holds the reports from the Reporting API `batchGet` call.

Properties


                        resourceQuotasRemaining

ResourceQuotasRemaining

The amount of resource quota remaining for the property.


                        ResourceQuotasRemaining

object

The resource quota tokens remaining for the property after the request is completed.

Properties

`hourlyQuotaTokensRemaining`	integer	Hourly resource quota tokens remaining.
`dailyQuotaTokensRemaining`	integer	Daily resource quota remaining remaining.


                        reports

array [Report]

Responses corresponding to each of the request.


                        Report

object

The data response corresponding to the request.

Properties


                        nextPageToken

string

Page token to retrieve the next page of results in the list.


                        data

ReportData

Response data.


                        ReportData

object

The data part of the report.

Properties

`totals`	array [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.
`samplingSpaceSizes`	array [string]	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.
`samplesReadCounts`	array [string]	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.
`rows`	array [ReportRow]	There's one ReportRow for every unique combination of dimensions.
`rowCount`	integer	Total number of matching rows for this query.
`minimums`	array [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`	array [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.
`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.
`dataLastRefreshed`	string	The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report.


                        columnHeader

ColumnHeader

The column headers.


                        ColumnHeader

object

Column headers.

Properties

`metricHeader`	MetricHeader	Metric headers for the metrics in the response.
`dimensions`	array [string]	The dimension names in the response.


                        queryCost

integer

The amount of resource quota tokens deducted to execute the query. Includes all responses.

userActivity

POST

/v4/userActivity:search

Returns User Activity data.

Request

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`SearchUserActivityRequest`	object	The request to fetch User Report from Reporting API `userActivity:get` call.

Properties


                        viewId

string

Required. The Analytics view ID from which to retrieve data. Every SearchUserActivityRequest must contain the viewId.


                        user

User

Required. Unique user Id to query for. Every SearchUserActivityRequest must contain this field.


                        User

object

Contains information to identify a particular user uniquely.

Properties

`userId`	string	Unique Id of the user for which the data is being requested.
`type`	string Allowed values: - `USER_ID_TYPE_UNSPECIFIED` - `USER_ID` - `CLIENT_ID`	Type of the user in the request. The field `userId` is associated with this type.


                        pageToken

string


                        pageSize

integer

Page size is for paging and specifies the maximum number of returned rows. Page size should be > 0. If the value is 0 or if the field isn't specified, the request returns the default of 1000 rows per page.


                        dateRange

DateRange

Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day).


                        DateRange

object

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

Properties

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


                        activityTypes

array [string]
Allowed values:
- ACTIVITY_TYPE_UNSPECIFIED
- PAGEVIEW
- SCREENVIEW
- GOAL
- ECOMMERCE
- EVENT

Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned.

Responses

200Successful response

Body

Name	Data Type	Description
`SearchUserActivityResponse`	object	The response from `userActivity:get` call.

Properties


                        totalRows

integer

Total rows returned by this query (across different pages).


                        sessions

array [UserActivitySession]

Each record represents a session (device details, duration, etc).


                        UserActivitySession

object

This represents a user session performed on a specific device at a certain time over a period of time.

Properties


                        sessionId

string

Unique ID of the session.


                        sessionDate

string

Date of this session in ISO-8601 format.


                        platform

string

Platform on which the activity happened: "android", "ios" etc.


                        deviceCategory

string

The type of device used: "mobile", "tablet" etc.


                        dataSource

string

The data source of a hit. By default, hits sent from analytics.js are reported as "web" and hits sent from the mobile SDKs are reported as "app". These values can be overridden in the Measurement Protocol.


                        activities

array [Activity]

Represents a detailed view into each of the activity in this session.


                        Activity

object

An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity's. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity.

Properties

`source`	string	The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct).
`pageview`	PageviewData	This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited.
`medium`	string	The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none).
`landingPagePath`	string	The first page in users' sessions, or the landing page.
`keyword`	string	For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).
`hostname`	string	The hostname from which the tracking request was made.
`goals`	GoalSetData	This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`.
`event`	EventData	This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`.
`ecommerce`	EcommerceData	This will be set if `activity_type` equals `ECOMMERCE`.
`customDimension`	array [CustomDimension]	A list of all custom dimensions associated with this activity.
`channelGrouping`	string	The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
`campaign`	string	For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set).
`appview`	ScreenviewData	This will be set if `activity_type` equals `SCREEN_VIEW`.
`activityType`	string Allowed values: - `ACTIVITY_TYPE_UNSPECIFIED` - `PAGEVIEW` - `SCREENVIEW` - `GOAL` - `ECOMMERCE` - `EVENT`	Type of this activity.
`activityTime`	string	Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. For example, say session ID 113472 has activity within 2019-08-20, and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID 113472 is one session, and session ID 243742 is two sessions.


                        sampleRate

double

This field represents the sampling rate for the given request and is a number between 0.0 to 1.0. See developer guide for details.


                        nextPageToken

string

This token should be passed to SearchUserActivityRequest to retrieve the next page.

Models

Activity

Properties

Name Data Type Description


                        source

string

The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct).


                        pageview

PageviewData

This will be set if activity_type equals PAGEVIEW. This field contains all the details about the visitor and the page that was visited.


                        PageviewData

object

Represents details collected when the visitor views a page.

Properties

`pageTitle`	string	The title of the page that the visitor viewed.
`pagePath`	string	The URL of the page that the visitor viewed.


                        medium

string

The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none).


                        landingPagePath

string

The first page in users' sessions, or the landing page.


                        keyword

string

For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).


                        hostname

string

The hostname from which the tracking request was made.


                        goals

GoalSetData

This field contains a list of all the goals that were reached in this activity when activity_type equals GOAL.


                        GoalSetData

object

Represents a set of goals that were reached in an activity.

Properties


                        goals

array [GoalData]

All the goals that were reached in the current activity.


                        GoalData

object

Represents all the details pertaining to a goal.

Properties

`goalValue`	double	Value in this goal.
`goalPreviousStep3`	string	URL of the page three steps prior to the goal completion.
`goalPreviousStep2`	string	URL of the page two steps prior to the goal completion.
`goalPreviousStep1`	string	URL of the page one step prior to the goal completion.
`goalName`	string	Name of the goal.
`goalIndex`	integer	This identifies the goal as configured for the profile.
`goalCompletions`	string	Total number of goal completions in this activity.
`goalCompletionLocation`	string	URL of the page where this goal was completed.


                        event

EventData

This field contains all the details pertaining to an event and will be set if activity_type equals EVENT.


                        EventData

object

Represents all the details pertaining to an event.

Properties

`eventValue`	string	Numeric value associated with the event.
`eventLabel`	string	Label attached with the event.
`eventCount`	string	Number of such events in this activity.
`eventCategory`	string	The object on the page that was interacted with. Eg: 'Video'.
`eventAction`	string	Type of interaction with the object. Eg: 'play'.


                        ecommerce

EcommerceData

This will be set if activity_type equals ECOMMERCE.


                        EcommerceData

object

E-commerce details associated with the user activity.

Properties


                        transaction

TransactionData

Transaction details of this e-commerce action.


                        TransactionData

object

Represents details collected when the visitor performs a transaction on the page.

Properties

`transactionTax`	double	Total tax for the transaction.
`transactionShipping`	double	Total cost of shipping.
`transactionRevenue`	double	The total sale revenue (excluding shipping and tax) of the transaction.
`transactionId`	string	The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart.


                        products

array [ProductData]

Details of the products in this transaction.


                        ProductData

object

Details of the products in an e-commerce transaction.

Properties

`productSku`	string	Unique code that represents the product.
`productQuantity`	string	Total number of this product units in the transaction.
`productName`	string	The product name, supplied by the e-commerce tracking application, for the purchased items.
`itemRevenue`	double	The total revenue from purchased product items.


                        ecommerceType

string
Allowed values:
- ECOMMERCE_TYPE_UNSPECIFIED
- CLASSIC
- ENHANCED

The type of this e-commerce activity.


                        actionType

string
Allowed values:
- UNKNOWN
- CLICK
- DETAILS_VIEW
- ADD_TO_CART
- REMOVE_FROM_CART
- CHECKOUT
- PAYMENT
- REFUND
- CHECKOUT_OPTION

Action associated with this e-commerce action.


                        customDimension

array [CustomDimension]

A list of all custom dimensions associated with this activity.


                        CustomDimension

object

Custom dimension.

Properties

`value`	string	Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value.
`index`	integer	Slot number of custom dimension.


                        channelGrouping

string

The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).


                        campaign

string

For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set).


                        appview

ScreenviewData

This will be set if activity_type equals SCREEN_VIEW.

ScreenviewData object

Properties

`screenName`	string	The name of the screen.
`mobileDeviceModel`	string	Mobile device model. Eg: "Pixel", "iPhone" etc.
`mobileDeviceBranding`	string	Mobile manufacturer or branded name. Eg: "Google", "Apple" etc.
`appName`	string	The application name.


                        activityType

string
Allowed values:
- ACTIVITY_TYPE_UNSPECIFIED
- PAGEVIEW
- SCREENVIEW
- GOAL
- ECOMMERCE
- EVENT

Type of this activity.


                        activityTime

string

Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. For example, say session ID 113472 has activity within 2019-08-20, and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID 113472 is one session, and session ID 243742 is two sessions.

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.

Properties

Name Data Type Description


                        type

string
Allowed values:
- UNSPECIFIED_COHORT_TYPE
- FIRST_VISIT_DATE

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.


                        name

string

A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].


                        dateRange

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.


                        DateRange

object

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

Properties

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

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" }
  }]
}

Properties

Name Data Type Description


                        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


                        cohorts

array [Cohort]

The definition for the cohort.


                        Cohort

object

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.

Properties


                        type

string
Allowed values:
- UNSPECIFIED_COHORT_TYPE
- FIRST_VISIT_DATE

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.


                        name

string

A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].


                        dateRange

DateRange


                        DateRange

object

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

Properties

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

ColumnHeader

Column headers.

Properties

Name Data Type Description


                        metricHeader

MetricHeader

Metric headers for the metrics in the response.


                        MetricHeader

object

The headers for the metrics.

Properties


                        pivotHeaders

array [PivotHeader]

Headers for the pivots in the response.


                        PivotHeader

object

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

Properties


                        totalPivotGroupsCount

integer

The total number of groups for this pivot.


                        pivotHeaderEntries

array [PivotHeaderEntry]

A single pivot section header.


                        PivotHeaderEntry

object

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

Properties

`metric`	MetricHeaderEntry	The metric header for the metric in the pivot.
`dimensionValues`	array [string]	The values for the dimensions in the pivot.
`dimensionNames`	array [string]	The name of the dimensions in the pivot response.


                        metricHeaderEntries

array [MetricHeaderEntry]

Headers for the metrics in the response.


                        MetricHeaderEntry

object

Header for the metrics.

Properties

`type`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	The type of the metric, for example `INTEGER`.
`name`	string	The name of the header.


                        dimensions

array [string]

The dimension names in the response.

CustomDimension

DateRange

DateRangeValues

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.

Properties

Name	Data Type	Description
`name`	string	Name of the dimension to fetch, for example `ga:browser`.
`histogramBuckets`	array [string]	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.

DimensionFilter

Dimension filter specifies the filtering options on a dimension.

Properties

Name	Data Type	Description
`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `NUMERIC_EQUAL` - `NUMERIC_GREATER_THAN` - `NUMERIC_LESS_THAN` - `IN_LIST`	How to match the dimension to the expression. The default is REGEXP.
`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.
`expressions`	array [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.
`dimensionName`	string	The dimension to filter on. A DimensionFilter must contain a dimension.
`caseSensitive`	boolean	Should the match be case sensitive? Default is false.

DimensionFilterClause

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

Properties

Name Data Type Description


                        operator

string
Allowed values:
- OPERATOR_UNSPECIFIED
- OR
- AND

The operator for combining multiple dimension filters. If unspecified, it is treated as an OR.


                        filters

array [DimensionFilter]

The repeated set of filters. They are logically combined based on the operator specified.


                        DimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `NUMERIC_EQUAL` - `NUMERIC_GREATER_THAN` - `NUMERIC_LESS_THAN` - `IN_LIST`	How to match the dimension to the expression. The default is REGEXP.
`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.
`expressions`	array [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.
`dimensionName`	string	The dimension to filter on. A DimensionFilter must contain a dimension.
`caseSensitive`	boolean	Should the match be case sensitive? Default is false.

DynamicSegment

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

Properties

Name Data Type Description


                        userSegment

SegmentDefinition

User Segment to select users to include in the segment.


                        SegmentDefinition

object

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

Properties


                        segmentFilters

array [SegmentFilter]

A segment is defined by a set of segment filters which are combined together with a logical AND operation.


                        SegmentFilter

object

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.

Properties


                        simpleSegment

SimpleSegment

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


                        SimpleSegment

object

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

Properties


                        orFiltersForSegment

array [OrFiltersForSegment]

A list of segment filters groups which are combined with logical AND operator.


                        sequenceSegment

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.


                        SequenceSegment

object

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.

Properties

`segmentSequenceSteps`	array [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).

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"
    }]
  },


                        sessionSegment

SegmentDefinition

Session Segment to select sessions to include in the segment.


                        SegmentDefinition

object

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

Properties


                        segmentFilters

array [SegmentFilter]

A segment is defined by a set of segment filters which are combined together with a logical AND operation.


                        SegmentFilter

object

Properties


                        simpleSegment

SimpleSegment

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


                        SimpleSegment

object

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

Properties


                        orFiltersForSegment

array [OrFiltersForSegment]

A list of segment filters groups which are combined with logical AND operator.


                        sequenceSegment

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.


                        SequenceSegment

object

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.

Properties

`segmentSequenceSteps`	array [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).

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"
    }]
  },


                        name

string

The name of the dynamic segment.

EcommerceData

E-commerce details associated with the user activity.

Properties

Name Data Type Description


                        transaction

TransactionData

Transaction details of this e-commerce action.


                        TransactionData

object

Represents details collected when the visitor performs a transaction on the page.

Properties

`transactionTax`	double	Total tax for the transaction.
`transactionShipping`	double	Total cost of shipping.
`transactionRevenue`	double	The total sale revenue (excluding shipping and tax) of the transaction.
`transactionId`	string	The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart.


                        products

array [ProductData]

Details of the products in this transaction.


                        ProductData

object

Details of the products in an e-commerce transaction.

Properties

`productSku`	string	Unique code that represents the product.
`productQuantity`	string	Total number of this product units in the transaction.
`productName`	string	The product name, supplied by the e-commerce tracking application, for the purchased items.
`itemRevenue`	double	The total revenue from purchased product items.


                        ecommerceType

string
Allowed values:
- ECOMMERCE_TYPE_UNSPECIFIED
- CLASSIC
- ENHANCED

The type of this e-commerce activity.


                        actionType

string
Allowed values:
- UNKNOWN
- CLICK
- DETAILS_VIEW
- ADD_TO_CART
- REMOVE_FROM_CART
- CHECKOUT
- PAYMENT
- REFUND
- CHECKOUT_OPTION

Action associated with this e-commerce action.

EventData

GetReportsRequest

The batch request containing multiple report request.

Properties

Name Data Type Description


                        useResourceQuotas

boolean


                        reportRequests

array [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.


                        ReportRequest

object

The main request class which specifies the Reporting API request.

Properties


                        viewId

string

The Analytics view ID from which to retrieve data. Every ReportRequest within a batchGet method must contain the same viewId.


                        segments

array [Segment]


                        Segment

object

Properties


                        segmentId

string

The segment ID of a built-in or custom segment, for example gaid::-3.


                        dynamicSegment

DynamicSegment

A dynamic segment definition in the request.


                        DynamicSegment

object

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

Properties

`userSegment`	SegmentDefinition	User Segment to select users to include in the segment.
`sessionSegment`	SegmentDefinition	Session Segment to select sessions to include in the segment.
`name`	string	The name of the dynamic segment.


                        samplingLevel

string
Allowed values:
- SAMPLING_UNSPECIFIED
- DEFAULT
- SMALL
- LARGE


                        pivots

array [Pivot]

The pivot definitions. Requests can have a maximum of 2 pivots.


                        Pivot

object

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.

Properties


                        startGroup

integer

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.


                        metrics

array [Metric]

The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.


                        Metric

object

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

Properties

`formattingType`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	Specifies how the metric expression should be formatted, for example `INTEGER`.
`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.


                        maxGroupCount

integer

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


                        dimensions

array [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.


                        Dimension

object

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.

Properties

`name`	string	Name of the dimension to fetch, for example `ga:browser`.
`histogramBuckets`	array [string]	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.


                        dimensionFilterClauses

array [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.


                        DimensionFilterClause

object

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

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `OR` - `AND`	The operator for combining multiple dimension filters. If unspecified, it is treated as an `OR`.
`filters`	array [DimensionFilter]	The repeated set of filters. They are logically combined based on the operator specified.


                        pageToken

string


                        pageSize

integer


                        orderBys

array [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.


                        OrderBy

object

Specifies the sorting options.

Properties

`sortOrder`	string Allowed values: - `SORT_ORDER_UNSPECIFIED` - `ASCENDING` - `DESCENDING`	The sorting order for the field.
`orderType`	string Allowed values: - `ORDER_TYPE_UNSPECIFIED` - `VALUE` - `DELTA` - `SMART` - `HISTOGRAM_BUCKET` - `DIMENSION_AS_INTEGER`	The order type. The default orderType is `VALUE`.
`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.


                        metrics

array [Metric]

The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.


                        Metric

object

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

Properties

`formattingType`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	Specifies how the metric expression should be formatted, for example `INTEGER`.
`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.


                        metricFilterClauses

array [MetricFilterClause]


                        MetricFilterClause

object

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

Properties


                        operator

string
Allowed values:
- OPERATOR_UNSPECIFIED
- OR
- AND

The operator for combining multiple metric filters. If unspecified, it is treated as an OR.


                        filters

array [MetricFilter]

The repeated set of filters. They are logically combined based on the operator specified.


                        MetricFilter

object

MetricFilter specifies the filter on a metric.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `EQUAL` - `LESS_THAN` - `GREATER_THAN` - `IS_MISSING`	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.
`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.
`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.
`comparisonValue`	string	The value to compare against.


                        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.


                        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.


                        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.


                        filtersExpression

string


                        dimensions

array [Dimension]

The dimensions requested. Requests can have a total of 9 dimensions.


                        Dimension

object

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.

Properties

`name`	string	Name of the dimension to fetch, for example `ga:browser`.
`histogramBuckets`	array [string]	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.


                        dimensionFilterClauses

array [DimensionFilterClause]


                        DimensionFilterClause

object

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

Properties


                        operator

string
Allowed values:
- OPERATOR_UNSPECIFIED
- OR
- AND

The operator for combining multiple dimension filters. If unspecified, it is treated as an OR.


                        filters

array [DimensionFilter]

The repeated set of filters. They are logically combined based on the operator specified.


                        DimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `NUMERIC_EQUAL` - `NUMERIC_GREATER_THAN` - `NUMERIC_LESS_THAN` - `IN_LIST`	How to match the dimension to the expression. The default is REGEXP.
`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.
`expressions`	array [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.
`dimensionName`	string	The dimension to filter on. A DimensionFilter must contain a dimension.
`caseSensitive`	boolean	Should the match be case sensitive? Default is false.


                        dateRanges

array [DateRange]


                        DateRange

object

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

Properties

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


                        cohortGroup

CohortGroup


                        CohortGroup

object

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" }
  }]
}

Properties


                        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


                        cohorts

array [Cohort]

The definition for the cohort.


                        Cohort

object

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.

Properties

`type`	string Allowed values: - `UNSPECIFIED_COHORT_TYPE` - `FIRST_VISIT_DATE`	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.
`name`	string	A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].
`dateRange`	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.

GetReportsResponse

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

Properties

Name Data Type Description


                        resourceQuotasRemaining

ResourceQuotasRemaining

The amount of resource quota remaining for the property.


                        ResourceQuotasRemaining

object

The resource quota tokens remaining for the property after the request is completed.

Properties

`hourlyQuotaTokensRemaining`	integer	Hourly resource quota tokens remaining.
`dailyQuotaTokensRemaining`	integer	Daily resource quota remaining remaining.


                        reports

array [Report]

Responses corresponding to each of the request.


                        Report

object

The data response corresponding to the request.

Properties


                        nextPageToken

string

Page token to retrieve the next page of results in the list.


                        data

ReportData

Response data.


                        ReportData

object

The data part of the report.

Properties


                        totals

array [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.


                        DateRangeValues

object

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

Properties

`values`	array [string]	Each value corresponds to each Metric in the request.
`pivotValueRegions`	array [PivotValueRegion]	The values of each pivot region.


                        samplingSpaceSizes

array [string]

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.


                        samplesReadCounts

array [string]

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.


                        rows

array [ReportRow]

There's one ReportRow for every unique combination of dimensions.


                        ReportRow

object

A row in the report.

Properties

`metrics`	array [DateRangeValues]	List of metrics for each requested DateRange.
`dimensions`	array [string]	List of requested dimensions.


                        rowCount

integer

Total number of matching rows for this query.


                        minimums

array [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.


                        DateRangeValues

object

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

Properties

`values`	array [string]	Each value corresponds to each Metric in the request.
`pivotValueRegions`	array [PivotValueRegion]	The values of each pivot region.


                        maximums

array [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.


                        DateRangeValues

object

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

Properties

`values`	array [string]	Each value corresponds to each Metric in the request.
`pivotValueRegions`	array [PivotValueRegion]	The values of each pivot region.


                        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.


                        dataLastRefreshed

string

The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report.


                        columnHeader

ColumnHeader

The column headers.


                        ColumnHeader

object

Column headers.

Properties


                        metricHeader

MetricHeader

Metric headers for the metrics in the response.


                        MetricHeader

object

The headers for the metrics.

Properties

`pivotHeaders`	array [PivotHeader]	Headers for the pivots in the response.
`metricHeaderEntries`	array [MetricHeaderEntry]	Headers for the metrics in the response.


                        dimensions

array [string]

The dimension names in the response.


                        queryCost

integer

The amount of resource quota tokens deducted to execute the query. Includes all responses.

GoalData

Represents all the details pertaining to a goal.

Properties

Name	Data Type	Description
`goalValue`	double	Value in this goal.
`goalPreviousStep3`	string	URL of the page three steps prior to the goal completion.
`goalPreviousStep2`	string	URL of the page two steps prior to the goal completion.
`goalPreviousStep1`	string	URL of the page one step prior to the goal completion.
`goalName`	string	Name of the goal.
`goalIndex`	integer	This identifies the goal as configured for the profile.
`goalCompletions`	string	Total number of goal completions in this activity.
`goalCompletionLocation`	string	URL of the page where this goal was completed.

GoalSetData

Represents a set of goals that were reached in an activity.

Properties

Name Data Type Description


                        goals

array [GoalData]

All the goals that were reached in the current activity.


                        GoalData

object

Represents all the details pertaining to a goal.

Properties

`goalValue`	double	Value in this goal.
`goalPreviousStep3`	string	URL of the page three steps prior to the goal completion.
`goalPreviousStep2`	string	URL of the page two steps prior to the goal completion.
`goalPreviousStep1`	string	URL of the page one step prior to the goal completion.
`goalName`	string	Name of the goal.
`goalIndex`	integer	This identifies the goal as configured for the profile.
`goalCompletions`	string	Total number of goal completions in this activity.
`goalCompletionLocation`	string	URL of the page where this goal was completed.

Metric

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

Properties

Name	Data Type	Description
`formattingType`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	Specifies how the metric expression should be formatted, for example `INTEGER`.
`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.

MetricFilter

MetricFilterClause

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

Properties

Name Data Type Description


                        operator

string
Allowed values:
- OPERATOR_UNSPECIFIED
- OR
- AND

The operator for combining multiple metric filters. If unspecified, it is treated as an OR.


                        filters

array [MetricFilter]

The repeated set of filters. They are logically combined based on the operator specified.


                        MetricFilter

object

MetricFilter specifies the filter on a metric.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `EQUAL` - `LESS_THAN` - `GREATER_THAN` - `IS_MISSING`	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.
`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.
`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.
`comparisonValue`	string	The value to compare against.

MetricHeader

The headers for the metrics.

Properties

Name Data Type Description


                        pivotHeaders

array [PivotHeader]

Headers for the pivots in the response.


                        PivotHeader

object

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

Properties


                        totalPivotGroupsCount

integer

The total number of groups for this pivot.


                        pivotHeaderEntries

array [PivotHeaderEntry]

A single pivot section header.


                        PivotHeaderEntry

object

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

Properties


                        metric

MetricHeaderEntry

The metric header for the metric in the pivot.


                        MetricHeaderEntry

object

Header for the metrics.

Properties

`type`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	The type of the metric, for example `INTEGER`.
`name`	string	The name of the header.


                        dimensionValues

array [string]

The values for the dimensions in the pivot.


                        dimensionNames

array [string]

The name of the dimensions in the pivot response.


                        metricHeaderEntries

array [MetricHeaderEntry]

Headers for the metrics in the response.


                        MetricHeaderEntry

object

Header for the metrics.

Properties

`type`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	The type of the metric, for example `INTEGER`.
`name`	string	The name of the header.

MetricHeaderEntry

OrFiltersForSegment

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

Properties

Name Data Type Description


                        segmentFilterClauses

array [SegmentFilterClause]

List of segment filters to be combined with a OR operator.


                        SegmentFilterClause

object

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

Properties

not

boolean

Matches the complement (!) of the filter.


                        metricFilter

SegmentMetricFilter

Metric Filter for the segment definition.


                        SegmentMetricFilter

object

Metric filter to be used in a segment filter clause.

Properties

`scope`	string Allowed values: - `UNSPECIFIED_SCOPE` - `PRODUCT` - `HIT` - `SESSION` - `USER`	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.
`operator`	string Allowed values: - `UNSPECIFIED_OPERATOR` - `LESS_THAN` - `GREATER_THAN` - `EQUAL` - `BETWEEN`	Specifies is the operation to perform to compare the metric. The default is `EQUAL`.
`metricName`	string	The metric that will be filtered on. A `metricFilter` must contain a metric name.
`maxComparisonValue`	string	Max comparison value is only used for `BETWEEN` operator.
`comparisonValue`	string	The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.


                        dimensionFilter

SegmentDimensionFilter

Dimension Filter for the segment definition.


                        SegmentDimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `IN_LIST` - `NUMERIC_LESS_THAN` - `NUMERIC_GREATER_THAN` - `NUMERIC_BETWEEN`	The operator to use to match the dimension with the expressions.
`minComparisonValue`	string	Minimum comparison values for `BETWEEN` match type.
`maxComparisonValue`	string	Maximum comparison values for `BETWEEN` match type.
`expressions`	array [string]	The list of expressions, only the first element is used for all operators
`dimensionName`	string	Name of the dimension for which the filter is being applied.
`caseSensitive`	boolean	Should the match be case sensitive, ignored for `IN_LIST` operator.

OrderBy

PageviewData

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.

Properties

Name Data Type Description


                        startGroup

integer

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


                        metrics

array [Metric]

The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.


                        Metric

object

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

Properties

`formattingType`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	Specifies how the metric expression should be formatted, for example `INTEGER`.
`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.


                        maxGroupCount

integer

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


                        dimensions

array [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.


                        Dimension

object

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.

Properties

`name`	string	Name of the dimension to fetch, for example `ga:browser`.
`histogramBuckets`	array [string]	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.


                        dimensionFilterClauses

array [DimensionFilterClause]


                        DimensionFilterClause

object

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

Properties


                        operator

string
Allowed values:
- OPERATOR_UNSPECIFIED
- OR
- AND

The operator for combining multiple dimension filters. If unspecified, it is treated as an OR.


                        filters

array [DimensionFilter]

The repeated set of filters. They are logically combined based on the operator specified.


                        DimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `NUMERIC_EQUAL` - `NUMERIC_GREATER_THAN` - `NUMERIC_LESS_THAN` - `IN_LIST`	How to match the dimension to the expression. The default is REGEXP.
`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.
`expressions`	array [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.
`dimensionName`	string	The dimension to filter on. A DimensionFilter must contain a dimension.
`caseSensitive`	boolean	Should the match be case sensitive? Default is false.

PivotHeader

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

Properties

Name Data Type Description


                        totalPivotGroupsCount

integer

The total number of groups for this pivot.


                        pivotHeaderEntries

array [PivotHeaderEntry]

A single pivot section header.


                        PivotHeaderEntry

object

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

Properties


                        metric

MetricHeaderEntry

The metric header for the metric in the pivot.


                        MetricHeaderEntry

object

Header for the metrics.

Properties

`type`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	The type of the metric, for example `INTEGER`.
`name`	string	The name of the header.


                        dimensionValues

array [string]

The values for the dimensions in the pivot.


                        dimensionNames

array [string]

The name of the dimensions in the pivot response.

PivotHeaderEntry

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

Properties

Name Data Type Description


                        metric

MetricHeaderEntry

The metric header for the metric in the pivot.


                        MetricHeaderEntry

object

Header for the metrics.

Properties

`type`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	The type of the metric, for example `INTEGER`.
`name`	string	The name of the header.


                        dimensionValues

array [string]

The values for the dimensions in the pivot.


                        dimensionNames

array [string]

The name of the dimensions in the pivot response.

PivotValueRegion

ProductData

Report

The data response corresponding to the request.

Properties

Name Data Type Description


                        nextPageToken

string

Page token to retrieve the next page of results in the list.


                        data

ReportData

Response data.


                        ReportData

object

The data part of the report.

Properties


                        totals

array [DateRangeValues]


                        DateRangeValues

object

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

Properties


                        values

array [string]

Each value corresponds to each Metric in the request.


                        pivotValueRegions

array [PivotValueRegion]

The values of each pivot region.


                        PivotValueRegion

object

The metric values in the pivot region.

Properties


                        values

array [string]

The values of the metrics in each of the pivot regions.


                        samplingSpaceSizes

array [string]

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.


                        samplesReadCounts

array [string]

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.


                        rows

array [ReportRow]

There's one ReportRow for every unique combination of dimensions.


                        ReportRow

object

A row in the report.

Properties


                        metrics

array [DateRangeValues]

List of metrics for each requested DateRange.


                        DateRangeValues

object

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

Properties

`values`	array [string]	Each value corresponds to each Metric in the request.
`pivotValueRegions`	array [PivotValueRegion]	The values of each pivot region.


                        dimensions

array [string]

List of requested dimensions.


                        rowCount

integer

Total number of matching rows for this query.


                        minimums

array [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.


                        DateRangeValues

object

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

Properties


                        values

array [string]

Each value corresponds to each Metric in the request.


                        pivotValueRegions

array [PivotValueRegion]

The values of each pivot region.


                        PivotValueRegion

object

The metric values in the pivot region.

Properties


                        values

array [string]

The values of the metrics in each of the pivot regions.


                        maximums

array [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.


                        DateRangeValues

object

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

Properties


                        values

array [string]

Each value corresponds to each Metric in the request.


                        pivotValueRegions

array [PivotValueRegion]

The values of each pivot region.


                        PivotValueRegion

object

The metric values in the pivot region.

Properties


                        values

array [string]

The values of the metrics in each of the pivot regions.


                        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.


                        dataLastRefreshed

string

The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report.


                        columnHeader

ColumnHeader

The column headers.


                        ColumnHeader

object

Column headers.

Properties


                        metricHeader

MetricHeader

Metric headers for the metrics in the response.


                        MetricHeader

object

The headers for the metrics.

Properties


                        pivotHeaders

array [PivotHeader]

Headers for the pivots in the response.


                        PivotHeader

object

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

Properties

`totalPivotGroupsCount`	integer	The total number of groups for this pivot.
`pivotHeaderEntries`	array [PivotHeaderEntry]	A single pivot section header.


                        metricHeaderEntries

array [MetricHeaderEntry]

Headers for the metrics in the response.


                        MetricHeaderEntry

object

Header for the metrics.

Properties

`type`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	The type of the metric, for example `INTEGER`.
`name`	string	The name of the header.


                        dimensions

array [string]

The dimension names in the response.

ReportData

The data part of the report.

Properties

Name Data Type Description


                        totals

array [DateRangeValues]


                        DateRangeValues

object

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

Properties


                        values

array [string]

Each value corresponds to each Metric in the request.


                        pivotValueRegions

array [PivotValueRegion]

The values of each pivot region.


                        PivotValueRegion

object

The metric values in the pivot region.

Properties


                        values

array [string]

The values of the metrics in each of the pivot regions.


                        samplingSpaceSizes

array [string]

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.


                        samplesReadCounts

array [string]

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.


                        rows

array [ReportRow]

There's one ReportRow for every unique combination of dimensions.


                        ReportRow

object

A row in the report.

Properties


                        metrics

array [DateRangeValues]

List of metrics for each requested DateRange.


                        DateRangeValues

object

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

Properties


                        values

array [string]

Each value corresponds to each Metric in the request.


                        pivotValueRegions

array [PivotValueRegion]

The values of each pivot region.


                        PivotValueRegion

object

The metric values in the pivot region.

Properties


                        values

array [string]

The values of the metrics in each of the pivot regions.


                        dimensions

array [string]

List of requested dimensions.


                        rowCount

integer

Total number of matching rows for this query.


                        minimums

array [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.


                        DateRangeValues

object

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

Properties


                        values

array [string]

Each value corresponds to each Metric in the request.


                        pivotValueRegions

array [PivotValueRegion]

The values of each pivot region.


                        PivotValueRegion

object

The metric values in the pivot region.

Properties


                        values

array [string]

The values of the metrics in each of the pivot regions.


                        maximums

array [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.


                        DateRangeValues

object

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

Properties


                        values

array [string]

Each value corresponds to each Metric in the request.


                        pivotValueRegions

array [PivotValueRegion]

The values of each pivot region.


                        PivotValueRegion

object

The metric values in the pivot region.

Properties


                        values

array [string]

The values of the metrics in each of the pivot regions.


                        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.


                        dataLastRefreshed

string

The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report.

ReportRequest

The main request class which specifies the Reporting API request.

Properties

Name Data Type Description


                        viewId

string

The Analytics view ID from which to retrieve data. Every ReportRequest within a batchGet method must contain the same viewId.


                        segments

array [Segment]


                        Segment

object

Properties


                        segmentId

string

The segment ID of a built-in or custom segment, for example gaid::-3.


                        dynamicSegment

DynamicSegment

A dynamic segment definition in the request.


                        DynamicSegment

object

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

Properties


                        userSegment

SegmentDefinition

User Segment to select users to include in the segment.


                        SegmentDefinition

object

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

Properties


                        segmentFilters

array [SegmentFilter]

A segment is defined by a set of segment filters which are combined together with a logical AND operation.


                        sessionSegment

SegmentDefinition

Session Segment to select sessions to include in the segment.


                        SegmentDefinition

object

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

Properties


                        segmentFilters

array [SegmentFilter]

A segment is defined by a set of segment filters which are combined together with a logical AND operation.


                        name

string

The name of the dynamic segment.


                        samplingLevel

string
Allowed values:
- SAMPLING_UNSPECIFIED
- DEFAULT
- SMALL
- LARGE


                        pivots

array [Pivot]

The pivot definitions. Requests can have a maximum of 2 pivots.


                        Pivot

object

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.

Properties


                        startGroup

integer

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


                        metrics

array [Metric]

The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.


                        Metric

object

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

Properties

`formattingType`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	Specifies how the metric expression should be formatted, for example `INTEGER`.
`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.


                        maxGroupCount

integer

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


                        dimensions

array [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.


                        Dimension

object

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.

Properties

`name`	string	Name of the dimension to fetch, for example `ga:browser`.
`histogramBuckets`	array [string]	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.


                        dimensionFilterClauses

array [DimensionFilterClause]


                        DimensionFilterClause

object

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

Properties


                        operator

string
Allowed values:
- OPERATOR_UNSPECIFIED
- OR
- AND

The operator for combining multiple dimension filters. If unspecified, it is treated as an OR.


                        filters

array [DimensionFilter]

The repeated set of filters. They are logically combined based on the operator specified.


                        DimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `NUMERIC_EQUAL` - `NUMERIC_GREATER_THAN` - `NUMERIC_LESS_THAN` - `IN_LIST`	How to match the dimension to the expression. The default is REGEXP.
`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.
`expressions`	array [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.
`dimensionName`	string	The dimension to filter on. A DimensionFilter must contain a dimension.
`caseSensitive`	boolean	Should the match be case sensitive? Default is false.


                        pageToken

string


                        pageSize

integer


                        orderBys

array [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.


                        OrderBy

object

Specifies the sorting options.

Properties

`sortOrder`	string Allowed values: - `SORT_ORDER_UNSPECIFIED` - `ASCENDING` - `DESCENDING`	The sorting order for the field.
`orderType`	string Allowed values: - `ORDER_TYPE_UNSPECIFIED` - `VALUE` - `DELTA` - `SMART` - `HISTOGRAM_BUCKET` - `DIMENSION_AS_INTEGER`	The order type. The default orderType is `VALUE`.
`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.


                        metrics

array [Metric]

The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.


                        Metric

object

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

Properties

`formattingType`	string Allowed values: - `METRIC_TYPE_UNSPECIFIED` - `INTEGER` - `FLOAT` - `CURRENCY` - `PERCENT` - `TIME`	Specifies how the metric expression should be formatted, for example `INTEGER`.
`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.


                        metricFilterClauses

array [MetricFilterClause]


                        MetricFilterClause

object

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

Properties


                        operator

string
Allowed values:
- OPERATOR_UNSPECIFIED
- OR
- AND

The operator for combining multiple metric filters. If unspecified, it is treated as an OR.


                        filters

array [MetricFilter]

The repeated set of filters. They are logically combined based on the operator specified.


                        MetricFilter

object

MetricFilter specifies the filter on a metric.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `EQUAL` - `LESS_THAN` - `GREATER_THAN` - `IS_MISSING`	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.
`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.
`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.
`comparisonValue`	string	The value to compare against.


                        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.


                        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.


                        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.


                        filtersExpression

string


                        dimensions

array [Dimension]

The dimensions requested. Requests can have a total of 9 dimensions.


                        Dimension

object

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.

Properties

`name`	string	Name of the dimension to fetch, for example `ga:browser`.
`histogramBuckets`	array [string]	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.


                        dimensionFilterClauses

array [DimensionFilterClause]


                        DimensionFilterClause

object

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

Properties


                        operator

string
Allowed values:
- OPERATOR_UNSPECIFIED
- OR
- AND

The operator for combining multiple dimension filters. If unspecified, it is treated as an OR.


                        filters

array [DimensionFilter]

The repeated set of filters. They are logically combined based on the operator specified.


                        DimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `NUMERIC_EQUAL` - `NUMERIC_GREATER_THAN` - `NUMERIC_LESS_THAN` - `IN_LIST`	How to match the dimension to the expression. The default is REGEXP.
`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.
`expressions`	array [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.
`dimensionName`	string	The dimension to filter on. A DimensionFilter must contain a dimension.
`caseSensitive`	boolean	Should the match be case sensitive? Default is false.


                        dateRanges

array [DateRange]


                        DateRange

object

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

Properties

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


                        cohortGroup

CohortGroup


                        CohortGroup

object

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" }
  }]
}

Properties


                        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


                        cohorts

array [Cohort]

The definition for the cohort.


                        Cohort

object

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.

Properties


                        type

string
Allowed values:
- UNSPECIFIED_COHORT_TYPE
- FIRST_VISIT_DATE

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.


                        name

string

A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].


                        dateRange

DateRange


                        DateRange

object

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

Properties

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

ReportRow

A row in the report.

Properties

Name Data Type Description


                        metrics

array [DateRangeValues]

List of metrics for each requested DateRange.


                        DateRangeValues

object

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

Properties


                        values

array [string]

Each value corresponds to each Metric in the request.


                        pivotValueRegions

array [PivotValueRegion]

The values of each pivot region.


                        PivotValueRegion

object

The metric values in the pivot region.

Properties


                        values

array [string]

The values of the metrics in each of the pivot regions.


                        dimensions

array [string]

List of requested dimensions.

ResourceQuotasRemaining

ScreenviewData

SearchUserActivityRequest

The request to fetch User Report from Reporting API userActivity:get call.

Properties

Name Data Type Description


                        viewId

string

Required. The Analytics view ID from which to retrieve data. Every SearchUserActivityRequest must contain the viewId.


                        user

User

Required. Unique user Id to query for. Every SearchUserActivityRequest must contain this field.


                        User

object

Contains information to identify a particular user uniquely.

Properties

`userId`	string	Unique Id of the user for which the data is being requested.
`type`	string Allowed values: - `USER_ID_TYPE_UNSPECIFIED` - `USER_ID` - `CLIENT_ID`	Type of the user in the request. The field `userId` is associated with this type.


                        pageToken

string


                        pageSize

integer


                        dateRange

DateRange

Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day).


                        DateRange

object

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

Properties

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


                        activityTypes

array [string]
Allowed values:
- ACTIVITY_TYPE_UNSPECIFIED
- PAGEVIEW
- SCREENVIEW
- GOAL
- ECOMMERCE
- EVENT

Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned.

SearchUserActivityResponse

The response from userActivity:get call.

Properties

Name Data Type Description


                        totalRows

integer

Total rows returned by this query (across different pages).


                        sessions

array [UserActivitySession]

Each record represents a session (device details, duration, etc).


                        UserActivitySession

object

This represents a user session performed on a specific device at a certain time over a period of time.

Properties


                        sessionId

string

Unique ID of the session.


                        sessionDate

string

Date of this session in ISO-8601 format.


                        platform

string

Platform on which the activity happened: "android", "ios" etc.


                        deviceCategory

string

The type of device used: "mobile", "tablet" etc.


                        dataSource

string


                        activities

array [Activity]

Represents a detailed view into each of the activity in this session.


                        Activity

object

Properties


                        source

string


                        pageview

PageviewData

This will be set if activity_type equals PAGEVIEW. This field contains all the details about the visitor and the page that was visited.


                        PageviewData

object

Represents details collected when the visitor views a page.

Properties

`pageTitle`	string	The title of the page that the visitor viewed.
`pagePath`	string	The URL of the page that the visitor viewed.


                        medium

string


                        landingPagePath

string

The first page in users' sessions, or the landing page.


                        keyword

string


                        hostname

string

The hostname from which the tracking request was made.


                        goals

GoalSetData

This field contains a list of all the goals that were reached in this activity when activity_type equals GOAL.


                        GoalSetData

object

Represents a set of goals that were reached in an activity.

Properties


                        goals

array [GoalData]

All the goals that were reached in the current activity.


                        event

EventData

This field contains all the details pertaining to an event and will be set if activity_type equals EVENT.


                        EventData

object

Represents all the details pertaining to an event.

Properties

`eventValue`	string	Numeric value associated with the event.
`eventLabel`	string	Label attached with the event.
`eventCount`	string	Number of such events in this activity.
`eventCategory`	string	The object on the page that was interacted with. Eg: 'Video'.
`eventAction`	string	Type of interaction with the object. Eg: 'play'.


                        ecommerce

EcommerceData

This will be set if activity_type equals ECOMMERCE.


                        EcommerceData

object

E-commerce details associated with the user activity.

Properties

`transaction`	TransactionData	Transaction details of this e-commerce action.
`products`	array [ProductData]	Details of the products in this transaction.
`ecommerceType`	string Allowed values: - `ECOMMERCE_TYPE_UNSPECIFIED` - `CLASSIC` - `ENHANCED`	The type of this e-commerce activity.
`actionType`	string Allowed values: - `UNKNOWN` - `CLICK` - `DETAILS_VIEW` - `ADD_TO_CART` - `REMOVE_FROM_CART` - `CHECKOUT` - `PAYMENT` - `REFUND` - `CHECKOUT_OPTION`	Action associated with this e-commerce action.


                        customDimension

array [CustomDimension]

A list of all custom dimensions associated with this activity.


                        CustomDimension

object

Custom dimension.

Properties

`value`	string	Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value.
`index`	integer	Slot number of custom dimension.


                        channelGrouping

string

The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).


                        campaign

string


                        appview

ScreenviewData

This will be set if activity_type equals SCREEN_VIEW.

ScreenviewData object

Properties

`screenName`	string	The name of the screen.
`mobileDeviceModel`	string	Mobile device model. Eg: "Pixel", "iPhone" etc.
`mobileDeviceBranding`	string	Mobile manufacturer or branded name. Eg: "Google", "Apple" etc.
`appName`	string	The application name.


                        activityType

string
Allowed values:
- ACTIVITY_TYPE_UNSPECIFIED
- PAGEVIEW
- SCREENVIEW
- GOAL
- ECOMMERCE
- EVENT

Type of this activity.


                        activityTime

string


                        sampleRate

double

This field represents the sampling rate for the given request and is a number between 0.0 to 1.0. See developer guide for details.


                        nextPageToken

string

This token should be passed to SearchUserActivityRequest to retrieve the next page.

Segment

Properties

Name Data Type Description


                        segmentId

string

The segment ID of a built-in or custom segment, for example gaid::-3.


                        dynamicSegment

DynamicSegment

A dynamic segment definition in the request.


                        DynamicSegment

object

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

Properties


                        userSegment

SegmentDefinition

User Segment to select users to include in the segment.


                        SegmentDefinition

object

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

Properties


                        segmentFilters

array [SegmentFilter]

A segment is defined by a set of segment filters which are combined together with a logical AND operation.


                        SegmentFilter

object

Properties

`simpleSegment`	SimpleSegment	A Simple segment conditions consist of one or more dimension/metric conditions that can be combined
`sequenceSegment`	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.
`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" }] },`


                        sessionSegment

SegmentDefinition

Session Segment to select sessions to include in the segment.


                        SegmentDefinition

object

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

Properties


                        segmentFilters

array [SegmentFilter]

A segment is defined by a set of segment filters which are combined together with a logical AND operation.


                        SegmentFilter

object

Properties

`simpleSegment`	SimpleSegment	A Simple segment conditions consist of one or more dimension/metric conditions that can be combined
`sequenceSegment`	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.
`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" }] },`


                        name

string

The name of the dynamic segment.

SegmentDefinition

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

Properties

Name Data Type Description


                        segmentFilters

array [SegmentFilter]

A segment is defined by a set of segment filters which are combined together with a logical AND operation.


                        SegmentFilter

object

Properties


                        simpleSegment

SimpleSegment

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


                        SimpleSegment

object

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

Properties


                        orFiltersForSegment

array [OrFiltersForSegment]

A list of segment filters groups which are combined with logical AND operator.


                        OrFiltersForSegment

object

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

Properties


                        segmentFilterClauses

array [SegmentFilterClause]

List of segment filters to be combined with a OR operator.


                        sequenceSegment

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.


                        SequenceSegment

object

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.

Properties


                        segmentSequenceSteps

array [SegmentSequenceStep]

The list of steps in the sequence.


                        SegmentSequenceStep

object

A segment sequence definition.

Properties

`orFiltersForSegment`	array [OrFiltersForSegment]	A sequence is specified with a list of Or grouped filters which are combined with `AND` operator.
`matchType`	string Allowed values: - `UNSPECIFIED_MATCH_TYPE` - `PRECEDES` - `IMMEDIATELY_PRECEDES`	Specifies if the step immediately precedes or can be any time before the next step.


                        firstStepShouldMatchFirstHit

boolean

If set, first step condition must match the first hit of the visitor (in the date range).

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"
    }]
  },

SegmentDimensionFilter

Dimension filter specifies the filtering options on a dimension.

Properties

Name	Data Type	Description
`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `IN_LIST` - `NUMERIC_LESS_THAN` - `NUMERIC_GREATER_THAN` - `NUMERIC_BETWEEN`	The operator to use to match the dimension with the expressions.
`minComparisonValue`	string	Minimum comparison values for `BETWEEN` match type.
`maxComparisonValue`	string	Maximum comparison values for `BETWEEN` match type.
`expressions`	array [string]	The list of expressions, only the first element is used for all operators
`dimensionName`	string	Name of the dimension for which the filter is being applied.
`caseSensitive`	boolean	Should the match be case sensitive, ignored for `IN_LIST` operator.

SegmentFilter

Properties

Name Data Type Description


                        simpleSegment

SimpleSegment

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


                        SimpleSegment

object

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

Properties


                        orFiltersForSegment

array [OrFiltersForSegment]

A list of segment filters groups which are combined with logical AND operator.


                        OrFiltersForSegment

object

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

Properties


                        segmentFilterClauses

array [SegmentFilterClause]

List of segment filters to be combined with a OR operator.


                        SegmentFilterClause

object

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

Properties

`not`	boolean	Matches the complement (`!`) of the filter.
`metricFilter`	SegmentMetricFilter	Metric Filter for the segment definition.
`dimensionFilter`	SegmentDimensionFilter	Dimension Filter for the segment definition.


                        sequenceSegment

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.


                        SequenceSegment

object

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.

Properties


                        segmentSequenceSteps

array [SegmentSequenceStep]

The list of steps in the sequence.


                        SegmentSequenceStep

object

A segment sequence definition.

Properties


                        orFiltersForSegment

array [OrFiltersForSegment]

A sequence is specified with a list of Or grouped filters which are combined with AND operator.


                        OrFiltersForSegment

object

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

Properties


                        segmentFilterClauses

array [SegmentFilterClause]

List of segment filters to be combined with a OR operator.


                        matchType

string
Allowed values:
- UNSPECIFIED_MATCH_TYPE
- PRECEDES
- IMMEDIATELY_PRECEDES

Specifies if the step immediately precedes or can be any time before the next step.


                        firstStepShouldMatchFirstHit

boolean

If set, first step condition must match the first hit of the visitor (in the date range).

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"
    }]
  },

SegmentFilterClause

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

Properties

Name Data Type Description

not

boolean

Matches the complement (!) of the filter.


                        metricFilter

SegmentMetricFilter

Metric Filter for the segment definition.


                        SegmentMetricFilter

object

Metric filter to be used in a segment filter clause.

Properties

`scope`	string Allowed values: - `UNSPECIFIED_SCOPE` - `PRODUCT` - `HIT` - `SESSION` - `USER`	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.
`operator`	string Allowed values: - `UNSPECIFIED_OPERATOR` - `LESS_THAN` - `GREATER_THAN` - `EQUAL` - `BETWEEN`	Specifies is the operation to perform to compare the metric. The default is `EQUAL`.
`metricName`	string	The metric that will be filtered on. A `metricFilter` must contain a metric name.
`maxComparisonValue`	string	Max comparison value is only used for `BETWEEN` operator.
`comparisonValue`	string	The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.


                        dimensionFilter

SegmentDimensionFilter

Dimension Filter for the segment definition.


                        SegmentDimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `IN_LIST` - `NUMERIC_LESS_THAN` - `NUMERIC_GREATER_THAN` - `NUMERIC_BETWEEN`	The operator to use to match the dimension with the expressions.
`minComparisonValue`	string	Minimum comparison values for `BETWEEN` match type.
`maxComparisonValue`	string	Maximum comparison values for `BETWEEN` match type.
`expressions`	array [string]	The list of expressions, only the first element is used for all operators
`dimensionName`	string	Name of the dimension for which the filter is being applied.
`caseSensitive`	boolean	Should the match be case sensitive, ignored for `IN_LIST` operator.

SegmentMetricFilter

Metric filter to be used in a segment filter clause.

Properties

Name	Data Type	Description
`scope`	string Allowed values: - `UNSPECIFIED_SCOPE` - `PRODUCT` - `HIT` - `SESSION` - `USER`	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.
`operator`	string Allowed values: - `UNSPECIFIED_OPERATOR` - `LESS_THAN` - `GREATER_THAN` - `EQUAL` - `BETWEEN`	Specifies is the operation to perform to compare the metric. The default is `EQUAL`.
`metricName`	string	The metric that will be filtered on. A `metricFilter` must contain a metric name.
`maxComparisonValue`	string	Max comparison value is only used for `BETWEEN` operator.
`comparisonValue`	string	The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.

SegmentSequenceStep

A segment sequence definition.

Properties

Name Data Type Description


                        orFiltersForSegment

array [OrFiltersForSegment]

A sequence is specified with a list of Or grouped filters which are combined with AND operator.


                        OrFiltersForSegment

object

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

Properties


                        segmentFilterClauses

array [SegmentFilterClause]

List of segment filters to be combined with a OR operator.


                        SegmentFilterClause

object

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

Properties

not

boolean

Matches the complement (!) of the filter.


                        metricFilter

SegmentMetricFilter

Metric Filter for the segment definition.


                        SegmentMetricFilter

object

Metric filter to be used in a segment filter clause.

Properties

`scope`	string Allowed values: - `UNSPECIFIED_SCOPE` - `PRODUCT` - `HIT` - `SESSION` - `USER`	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.
`operator`	string Allowed values: - `UNSPECIFIED_OPERATOR` - `LESS_THAN` - `GREATER_THAN` - `EQUAL` - `BETWEEN`	Specifies is the operation to perform to compare the metric. The default is `EQUAL`.
`metricName`	string	The metric that will be filtered on. A `metricFilter` must contain a metric name.
`maxComparisonValue`	string	Max comparison value is only used for `BETWEEN` operator.
`comparisonValue`	string	The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.


                        dimensionFilter

SegmentDimensionFilter

Dimension Filter for the segment definition.


                        SegmentDimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `IN_LIST` - `NUMERIC_LESS_THAN` - `NUMERIC_GREATER_THAN` - `NUMERIC_BETWEEN`	The operator to use to match the dimension with the expressions.
`minComparisonValue`	string	Minimum comparison values for `BETWEEN` match type.
`maxComparisonValue`	string	Maximum comparison values for `BETWEEN` match type.
`expressions`	array [string]	The list of expressions, only the first element is used for all operators
`dimensionName`	string	Name of the dimension for which the filter is being applied.
`caseSensitive`	boolean	Should the match be case sensitive, ignored for `IN_LIST` operator.


                        matchType

string
Allowed values:
- UNSPECIFIED_MATCH_TYPE
- PRECEDES
- IMMEDIATELY_PRECEDES

Specifies if the step immediately precedes or can be any time before the next step.

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.

Properties

Name Data Type Description


                        segmentSequenceSteps

array [SegmentSequenceStep]

The list of steps in the sequence.


                        SegmentSequenceStep

object

A segment sequence definition.

Properties


                        orFiltersForSegment

array [OrFiltersForSegment]

A sequence is specified with a list of Or grouped filters which are combined with AND operator.


                        OrFiltersForSegment

object

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

Properties


                        segmentFilterClauses

array [SegmentFilterClause]

List of segment filters to be combined with a OR operator.


                        SegmentFilterClause

object

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

Properties

`not`	boolean	Matches the complement (`!`) of the filter.
`metricFilter`	SegmentMetricFilter	Metric Filter for the segment definition.
`dimensionFilter`	SegmentDimensionFilter	Dimension Filter for the segment definition.


                        matchType

string
Allowed values:
- UNSPECIFIED_MATCH_TYPE
- PRECEDES
- IMMEDIATELY_PRECEDES

Specifies if the step immediately precedes or can be any time before the next step.


                        firstStepShouldMatchFirstHit

boolean

If set, first step condition must match the first hit of the visitor (in the date range).

SimpleSegment

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

Properties

Name Data Type Description


                        orFiltersForSegment

array [OrFiltersForSegment]

A list of segment filters groups which are combined with logical AND operator.


                        OrFiltersForSegment

object

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

Properties


                        segmentFilterClauses

array [SegmentFilterClause]

List of segment filters to be combined with a OR operator.


                        SegmentFilterClause

object

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

Properties

not

boolean

Matches the complement (!) of the filter.


                        metricFilter

SegmentMetricFilter

Metric Filter for the segment definition.


                        SegmentMetricFilter

object

Metric filter to be used in a segment filter clause.

Properties

`scope`	string Allowed values: - `UNSPECIFIED_SCOPE` - `PRODUCT` - `HIT` - `SESSION` - `USER`	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.
`operator`	string Allowed values: - `UNSPECIFIED_OPERATOR` - `LESS_THAN` - `GREATER_THAN` - `EQUAL` - `BETWEEN`	Specifies is the operation to perform to compare the metric. The default is `EQUAL`.
`metricName`	string	The metric that will be filtered on. A `metricFilter` must contain a metric name.
`maxComparisonValue`	string	Max comparison value is only used for `BETWEEN` operator.
`comparisonValue`	string	The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.


                        dimensionFilter

SegmentDimensionFilter

Dimension Filter for the segment definition.


                        SegmentDimensionFilter

object

Dimension filter specifies the filtering options on a dimension.

Properties

`operator`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `REGEXP` - `BEGINS_WITH` - `ENDS_WITH` - `PARTIAL` - `EXACT` - `IN_LIST` - `NUMERIC_LESS_THAN` - `NUMERIC_GREATER_THAN` - `NUMERIC_BETWEEN`	The operator to use to match the dimension with the expressions.
`minComparisonValue`	string	Minimum comparison values for `BETWEEN` match type.
`maxComparisonValue`	string	Maximum comparison values for `BETWEEN` match type.
`expressions`	array [string]	The list of expressions, only the first element is used for all operators
`dimensionName`	string	Name of the dimension for which the filter is being applied.
`caseSensitive`	boolean	Should the match be case sensitive, ignored for `IN_LIST` operator.

TransactionData

User

UserActivitySession

This represents a user session performed on a specific device at a certain time over a period of time.

Properties

Name Data Type Description


                        sessionId

string

Unique ID of the session.


                        sessionDate

string

Date of this session in ISO-8601 format.


                        platform

string

Platform on which the activity happened: "android", "ios" etc.


                        deviceCategory

string

The type of device used: "mobile", "tablet" etc.


                        dataSource

string


                        activities

array [Activity]

Represents a detailed view into each of the activity in this session.


                        Activity

object

Properties


                        source

string


                        pageview

PageviewData

This will be set if activity_type equals PAGEVIEW. This field contains all the details about the visitor and the page that was visited.


                        PageviewData

object

Represents details collected when the visitor views a page.

Properties

`pageTitle`	string	The title of the page that the visitor viewed.
`pagePath`	string	The URL of the page that the visitor viewed.


                        medium

string


                        landingPagePath

string

The first page in users' sessions, or the landing page.


                        keyword

string


                        hostname

string

The hostname from which the tracking request was made.


                        goals

GoalSetData

This field contains a list of all the goals that were reached in this activity when activity_type equals GOAL.


                        GoalSetData

object

Represents a set of goals that were reached in an activity.

Properties


                        goals

array [GoalData]

All the goals that were reached in the current activity.


                        GoalData

object

Represents all the details pertaining to a goal.

Properties

`goalValue`	double	Value in this goal.
`goalPreviousStep3`	string	URL of the page three steps prior to the goal completion.
`goalPreviousStep2`	string	URL of the page two steps prior to the goal completion.
`goalPreviousStep1`	string	URL of the page one step prior to the goal completion.
`goalName`	string	Name of the goal.
`goalIndex`	integer	This identifies the goal as configured for the profile.
`goalCompletions`	string	Total number of goal completions in this activity.
`goalCompletionLocation`	string	URL of the page where this goal was completed.


                        event

EventData

This field contains all the details pertaining to an event and will be set if activity_type equals EVENT.


                        EventData

object

Represents all the details pertaining to an event.

Properties

`eventValue`	string	Numeric value associated with the event.
`eventLabel`	string	Label attached with the event.
`eventCount`	string	Number of such events in this activity.
`eventCategory`	string	The object on the page that was interacted with. Eg: 'Video'.
`eventAction`	string	Type of interaction with the object. Eg: 'play'.


                        ecommerce

EcommerceData

This will be set if activity_type equals ECOMMERCE.


                        EcommerceData

object

E-commerce details associated with the user activity.

Properties


                        transaction

TransactionData

Transaction details of this e-commerce action.


                        TransactionData

object

Represents details collected when the visitor performs a transaction on the page.

Properties

`transactionTax`	double	Total tax for the transaction.
`transactionShipping`	double	Total cost of shipping.
`transactionRevenue`	double	The total sale revenue (excluding shipping and tax) of the transaction.
`transactionId`	string	The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart.


                        products

array [ProductData]

Details of the products in this transaction.


                        ProductData

object

Details of the products in an e-commerce transaction.

Properties

`productSku`	string	Unique code that represents the product.
`productQuantity`	string	Total number of this product units in the transaction.
`productName`	string	The product name, supplied by the e-commerce tracking application, for the purchased items.
`itemRevenue`	double	The total revenue from purchased product items.


                        ecommerceType

string
Allowed values:
- ECOMMERCE_TYPE_UNSPECIFIED
- CLASSIC
- ENHANCED

The type of this e-commerce activity.


                        actionType

string
Allowed values:
- UNKNOWN
- CLICK
- DETAILS_VIEW
- ADD_TO_CART
- REMOVE_FROM_CART
- CHECKOUT
- PAYMENT
- REFUND
- CHECKOUT_OPTION

Action associated with this e-commerce action.


                        customDimension

array [CustomDimension]

A list of all custom dimensions associated with this activity.


                        CustomDimension

object

Custom dimension.

Properties

`value`	string	Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value.
`index`	integer	Slot number of custom dimension.


                        channelGrouping

string

The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).


                        campaign

string


                        appview

ScreenviewData

This will be set if activity_type equals SCREEN_VIEW.

ScreenviewData object

Properties

`screenName`	string	The name of the screen.
`mobileDeviceModel`	string	Mobile device model. Eg: "Pixel", "iPhone" etc.
`mobileDeviceBranding`	string	Mobile manufacturer or branded name. Eg: "Google", "Apple" etc.
`appName`	string	The application name.


                        activityType

string
Allowed values:
- ACTIVITY_TYPE_UNSPECIFIED
- PAGEVIEW
- SCREENVIEW
- GOAL
- ECOMMERCE
- EVENT

Type of this activity.


                        activityTime

string

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 accessCode authentication

Flow: authorizationCode
Authorization URL: https://accounts.google.com/o/oauth2/auth
Token URL: https://accounts.google.com/o/oauth2/token
Scopes:

https://www.googleapis.com/auth/analytics: View and manage your Google Analytics data
https://www.googleapis.com/auth/analytics.readonly: View your Google Analytics data

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 implicit authentication

Flow: implicit
Authorization URL: https://accounts.google.com/o/oauth2/auth
Scopes:

https://www.googleapis.com/auth/analytics: View and manage your Google Analytics data
https://www.googleapis.com/auth/analytics.readonly: View your Google Analytics data

Contact

Name	`Google`
External URL	`https://google.com`

Metadata (Technical Details)

Api Client Registration	`https://console.developers.google.com`
Origin - Format	`google`
Origin - Url	`https://analyticsreporting.googleapis.com/$discovery/rest?version=v4`
Origin - Version	`v1`
Preferred	`Yes`
Provider Name	`googleapis.com`
Service Name	`analyticsreporting`
API Version	`v4`

Comments

Loading comments ...