@datafire/google_analyticsreporting

Client library for Analytics Reporting API

Installation and Usage

npm install --save @datafire/google_analyticsreporting

let google_analyticsreporting = require('@datafire/google_analyticsreporting').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Accesses Analytics report data.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_analyticsreporting.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_analyticsreporting.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

analyticsreporting.reports.batchGet

Returns the Analytics data.

google_analyticsreporting.analyticsreporting.reports.batchGet({}, context)

Input

• input object
  • body GetReportsRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • 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.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output GetReportsResponse

analyticsreporting.userActivity.search

Returns User Activity data.

google_analyticsreporting.analyticsreporting.userActivity.search({}, context)

Input

• input object
  • body SearchUserActivityRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • 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.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output SearchUserActivityResponse

Definitions

Activity

• 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.
  • 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.
  • activityType string (values: ACTIVITY_TYPE_UNSPECIFIED, PAGEVIEW, SCREENVIEW, GOAL, ECOMMERCE, EVENT): Type of this activity.
  • appview ScreenviewData
  • 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).
  • channelGrouping string: The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
  • customDimension array: A list of all custom dimensions associated with this activity.
    • items CustomDimension
  • ecommerce EcommerceData
  • event EventData
  • goals GoalSetData
  • hostname string: The hostname from which the tracking request was made.
  • 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).
  • landingPagePath string: The first page in users' sessions, or the landing page.
  • 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).
  • pageview PageviewData
  • 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).

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

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" } }] }
  • cohorts array: The definition for the cohort.
    • items Cohort
  • lifetimeValue boolean: Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: Cohort Analysis and Lifetime Value If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting ga:cohortNthWeek the startDate in the cohort definition should be a Sunday and the endDate should be the following Saturday, and for ga:cohortNthMonth, the startDate should be the 1st of the month and endDate should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The viewId must be an app view ID

ColumnHeader

• ColumnHeader object: Column headers.
  • dimensions array: The dimension names in the response.
    • items string
  • metricHeader MetricHeader

CustomDimension

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

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.
  • endDate string: The end date for the query in the format YYYY-MM-DD.
  • startDate string: The start date for the query in the format YYYY-MM-DD.

DateRangeValues

• DateRangeValues object: Used to return a list of metrics for a single DateRange / dimension combination
  • pivotValueRegions array: The values of each pivot region.
    • items PivotValueRegion
  • values array: Each value corresponds to each Metric in the request.
    • items string

Dimension

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

DimensionFilter

• DimensionFilter object: Dimension filter specifies the filtering options on a dimension.
  • caseSensitive boolean: Should the match be case sensitive? Default is false.
  • dimensionName string: The dimension to filter on. A DimensionFilter must contain a dimension.
  • expressions array: 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.
    • items string
  • not boolean: Logical NOT operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false.
  • operator string (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.

DimensionFilterClause

• DimensionFilterClause object: A group of dimension filters. Set the operator value to specify how the filters are logically combined.
  • filters array: The repeated set of filters. They are logically combined based on the operator specified.
    • items DimensionFilter
  • operator string (values: OPERATOR_UNSPECIFIED, OR, AND): The operator for combining multiple dimension filters. If unspecified, it is treated as an OR.

DynamicSegment

• DynamicSegment object: Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.
  • name string: The name of the dynamic segment.
  • sessionSegment SegmentDefinition
  • userSegment SegmentDefinition

EcommerceData

• EcommerceData object: E-commerce details associated with the user activity.
  • actionType string (values: UNKNOWN, CLICK, DETAILS_VIEW, ADD_TO_CART, REMOVE_FROM_CART, CHECKOUT, PAYMENT, REFUND, CHECKOUT_OPTION): Action associated with this e-commerce action.
  • ecommerceType string (values: ECOMMERCE_TYPE_UNSPECIFIED, CLASSIC, ENHANCED): The type of this e-commerce activity.
  • products array: Details of the products in this transaction.
    • items ProductData
  • transaction TransactionData

EventData

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

GetReportsRequest

• GetReportsRequest object: The batch request containing multiple report request.
  • reportRequests array: 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.
    • items ReportRequest
  • 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.

GetReportsResponse

• GetReportsResponse object: The main response class which holds the reports from the Reporting API batchGet call.
  • queryCost integer: The amount of resource quota tokens deducted to execute the query. Includes all responses.
  • reports array: Responses corresponding to each of the request.
    • items Report
  • resourceQuotasRemaining ResourceQuotasRemaining

GoalData

• GoalData object: Represents all the details pertaining to a goal.
  • goalCompletionLocation string: URL of the page where this goal was completed.
  • goalCompletions string: Total number of goal completions in this activity.
  • goalIndex integer: This identifies the goal as configured for the profile.
  • goalName string: Name of the goal.
  • goalPreviousStep1 string: URL of the page one step prior to the goal completion.
  • goalPreviousStep2 string: URL of the page two steps prior to the goal completion.
  • goalPreviousStep3 string: URL of the page three steps prior to the goal completion.
  • goalValue number: Value in this goal.

GoalSetData

• GoalSetData object: Represents a set of goals that were reached in an activity.
  • goals array: All the goals that were reached in the current activity.
    • items GoalData

Metric

• Metric object: Metrics are the quantitative measurements. For example, the metric ga:users indicates the total number of users for the requested time period.
  • 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.
  • 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.
  • formattingType string (values: METRIC_TYPE_UNSPECIFIED, INTEGER, FLOAT, CURRENCY, PERCENT, TIME): Specifies how the metric expression should be formatted, for example INTEGER.

MetricFilter

• MetricFilter object: MetricFilter specifies the filter on a metric.
  • comparisonValue string: The value to compare against.
  • metricName string: The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression.
  • not boolean: Logical NOT operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false.
  • operator string (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.

MetricFilterClause

• MetricFilterClause object: Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.
  • filters array: The repeated set of filters. They are logically combined based on the operator specified.
    • items MetricFilter
  • operator string (values: OPERATOR_UNSPECIFIED, OR, AND): The operator for combining multiple metric filters. If unspecified, it is treated as an OR.

MetricHeader

• MetricHeader object: The headers for the metrics.
  • metricHeaderEntries array: Headers for the metrics in the response.
    • items MetricHeaderEntry
  • pivotHeaders array: Headers for the pivots in the response.
    • items PivotHeader

MetricHeaderEntry

• MetricHeaderEntry object: Header for the metrics.
  • name string: The name of the header.
  • type string (values: METRIC_TYPE_UNSPECIFIED, INTEGER, FLOAT, CURRENCY, PERCENT, TIME): The type of the metric, for example INTEGER.

OrFiltersForSegment

• OrFiltersForSegment object: A list of segment filters in the OR group are combined with the logical OR operator.
  • segmentFilterClauses array: List of segment filters to be combined with a OR operator.
    • items SegmentFilterClause

OrderBy

• OrderBy object: Specifies the sorting options.
  • fieldName string: The field which to sort by. The default sort order is ascending. Example: ga:browser. Note, that you can only specify one field for sort here. For example, ga:browser, ga:city is not valid.
  • orderType string (values: ORDER_TYPE_UNSPECIFIED, VALUE, DELTA, SMART, HISTOGRAM_BUCKET, DIMENSION_AS_INTEGER): The order type. The default orderType is VALUE.
  • sortOrder string (values: SORT_ORDER_UNSPECIFIED, ASCENDING, DESCENDING): The sorting order for the field.

PageviewData

• PageviewData object: Represents details collected when the visitor views a page.
  • pagePath string: The URL of the page that the visitor viewed.
  • pageTitle string: The title of the page that the visitor viewed.

Pivot

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

PivotHeader

• PivotHeader object: The headers for each of the pivot sections defined in the request.
  • pivotHeaderEntries array: A single pivot section header.
    • items PivotHeaderEntry
  • totalPivotGroupsCount integer: The total number of groups for this pivot.

PivotHeaderEntry

• PivotHeaderEntry object: The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.
  • dimensionNames array: The name of the dimensions in the pivot response.
    • items string
  • dimensionValues array: The values for the dimensions in the pivot.
    • items string
  • metric MetricHeaderEntry

PivotValueRegion

• PivotValueRegion object: The metric values in the pivot region.
  • values array: The values of the metrics in each of the pivot regions.
    • items string

ProductData

• ProductData object: Details of the products in an e-commerce transaction.
  • itemRevenue number: The total revenue from purchased product items.
  • productName string: The product name, supplied by the e-commerce tracking application, for the purchased items.
  • productQuantity string: Total number of this product units in the transaction.
  • productSku string: Unique code that represents the product.

Report

• Report object: The data response corresponding to the request.
  • columnHeader ColumnHeader
  • data ReportData
  • nextPageToken string: Page token to retrieve the next page of results in the list.

ReportData

• ReportData object: The data part of the report.
  • 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.
  • 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.
  • maximums array: 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.
    • items DateRangeValues
  • minimums array: 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.
    • items DateRangeValues
  • rowCount integer: Total number of matching rows for this query.
  • rows array: There's one ReportRow for every unique combination of dimensions.
    • items ReportRow
  • samplesReadCounts array: 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.
    • items string
  • samplingSpaceSizes array: 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.
    • items string
  • totals array: 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.
    • items DateRangeValues

ReportRequest

• ReportRequest object: The main request class which specifies the Reporting API request.
  • cohortGroup CohortGroup
  • dateRanges array: 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.
    • items DateRange
  • dimensionFilterClauses array: 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.
    • items DimensionFilterClause
  • dimensions array: The dimensions requested. Requests can have a total of 9 dimensions.
    • items Dimension
  • 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.
  • hideTotals boolean: If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
  • hideValueRanges boolean: If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.
  • 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.
  • metricFilterClauses array: 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.
    • items MetricFilterClause
  • metrics array: The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.
    • items Metric
  • orderBys array: 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.
    • items OrderBy
  • 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.
  • 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.
  • pivots array: The pivot definitions. Requests can have a maximum of 2 pivots.
    • items Pivot
  • samplingLevel string (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.
  • segments array: 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.
    • items Segment
  • viewId string: The Analytics view ID from which to retrieve data. Every ReportRequest within a batchGet method must contain the same viewId.

ReportRow

• ReportRow object: A row in the report.
  • dimensions array: List of requested dimensions.
    • items string
  • metrics array: List of metrics for each requested DateRange.
    • items DateRangeValues

ResourceQuotasRemaining

• ResourceQuotasRemaining object: The resource quota tokens remaining for the property after the request is completed.
  • dailyQuotaTokensRemaining integer: Daily resource quota remaining remaining.
  • hourlyQuotaTokensRemaining integer: Hourly resource quota tokens remaining.

ScreenviewData

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

SearchUserActivityRequest

• SearchUserActivityRequest object: The request to fetch User Report from Reporting API userActivity:get call.
  • activityTypes array: 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.
    • items string (values: ACTIVITY_TYPE_UNSPECIFIED, PAGEVIEW, SCREENVIEW, GOAL, ECOMMERCE, EVENT)
  • dateRange DateRange
  • 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.
  • 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 SearchUserActivityRequest request.
  • user User
  • viewId string: Required. The Analytics view ID from which to retrieve data. Every SearchUserActivityRequest must contain the viewId.

SearchUserActivityResponse

• SearchUserActivityResponse object: The response from userActivity:get call.
  • nextPageToken string: This token should be passed to SearchUserActivityRequest to retrieve the next page.
  • sampleRate number: 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.
  • sessions array: Each record represents a session (device details, duration, etc).
    • items UserActivitySession
  • totalRows integer: Total rows returned by this query (across different pages).

Segment

• 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.
  • dynamicSegment DynamicSegment
  • segmentId string: The segment ID of a built-in or custom segment, for example gaid::-3.

SegmentDefinition

• SegmentDefinition object: SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical AND operation.
  • segmentFilters array: A segment is defined by a set of segment filters which are combined together with a logical AND operation.
    • items SegmentFilter

SegmentDimensionFilter

• SegmentDimensionFilter object: Dimension filter specifies the filtering options on a dimension.
  • caseSensitive boolean: Should the match be case sensitive, ignored for IN_LIST operator.
  • dimensionName string: Name of the dimension for which the filter is being applied.
  • expressions array: The list of expressions, only the first element is used for all operators
    • items string
  • maxComparisonValue string: Maximum comparison values for BETWEEN match type.
  • minComparisonValue string: Minimum comparison values for BETWEEN match type.
  • operator string (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.

SegmentFilter

• 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.
  • 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" }] },
  • sequenceSegment SequenceSegment
  • simpleSegment SimpleSegment

SegmentFilterClause

• SegmentFilterClause object: Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter.
  • dimensionFilter SegmentDimensionFilter
  • metricFilter SegmentMetricFilter
  • not boolean: Matches the complement (!) of the filter.

SegmentMetricFilter

• SegmentMetricFilter object: Metric filter to be used in a segment filter clause.
  • comparisonValue string: The value to compare against. If the operator is BETWEEN, this value is treated as minimum comparison value.
  • maxComparisonValue string: Max comparison value is only used for BETWEEN operator.
  • metricName string: The metric that will be filtered on. A metricFilter must contain a metric name.
  • operator string (values: UNSPECIFIED_OPERATOR, LESS_THAN, GREATER_THAN, EQUAL, BETWEEN): Specifies is the operation to perform to compare the metric. The default is EQUAL.
  • scope string (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.

SegmentSequenceStep

• SegmentSequenceStep object: A segment sequence definition.
  • matchType string (values: UNSPECIFIED_MATCH_TYPE, PRECEDES, IMMEDIATELY_PRECEDES): Specifies if the step immediately precedes or can be any time before the next step.
  • orFiltersForSegment array: A sequence is specified with a list of Or grouped filters which are combined with AND operator.
    • items OrFiltersForSegment

SequenceSegment

• 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.
  • firstStepShouldMatchFirstHit boolean: If set, first step condition must match the first hit of the visitor (in the date range).
  • segmentSequenceSteps array: The list of steps in the sequence.
    • items SegmentSequenceStep

SimpleSegment

• SimpleSegment object: A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.
  • orFiltersForSegment array: A list of segment filters groups which are combined with logical AND operator.
    • items OrFiltersForSegment

TransactionData

• TransactionData object: Represents details collected when the visitor performs a transaction on the page.
  • transactionId string: The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart.
  • transactionRevenue number: The total sale revenue (excluding shipping and tax) of the transaction.
  • transactionShipping number: Total cost of shipping.
  • transactionTax number: Total tax for the transaction.

User

• User object: Contains information to identify a particular user uniquely.
  • type string (values: USER_ID_TYPE_UNSPECIFIED, USER_ID, CLIENT_ID): Type of the user in the request. The field userId is associated with this type.
  • userId string: Unique Id of the user for which the data is being requested.

UserActivitySession

• UserActivitySession object: This represents a user session performed on a specific device at a certain time over a period of time.
  • activities array: Represents a detailed view into each of the activity in this session.
    • items Activity
  • 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.
  • deviceCategory string: The type of device used: "mobile", "tablet" etc.
  • platform string: Platform on which the activity happened: "android", "ios" etc.
  • sessionDate string: Date of this session in ISO-8601 format.
  • sessionId string: Unique ID of the session.