Returns the Analytics data.
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. |
Name | Data Type | Description |
---|---|---|
GetReportsRequest
|
object |
The batch request containing multiple report request. |
useResourceQuotas
|
boolean |
Enables
resource based
quotas,
(defaults to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
GetReportsResponse
|
object |
The main response class which holds the reports from the Reporting API
|
resourceQuotasRemaining
|
ResourceQuotasRemaining |
The amount of resource quota remaining for the property. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reports
|
array [Report] |
Responses corresponding to each of the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queryCost
|
integer |
The amount of resource quota tokens deducted to execute the query. Includes all responses. |
Returns User Activity data.
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. |
Name | Data Type | Description |
---|---|---|
SearchUserActivityRequest
|
object |
The request to fetch User Report from Reporting API |
viewId
|
string |
Required. The Analytics
view ID
from which to retrieve data. Every
SearchUserActivityRequest must contain the
|
||||||||||
user
|
User |
Required. Unique user Id to query for. Every SearchUserActivityRequest must contain this field. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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). |
||||||||||
Properties
|
||||||||||||
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. |
Name | Data Type | Description |
---|---|---|
SearchUserActivityResponse
|
object |
The response from |
totalRows
|
integer |
Total rows returned by this query (across different pages). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sessions
|
array [UserActivitySession] |
Each record represents a session (device details, duration, etc). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
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.
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
event
|
EventData |
This field contains all the details pertaining to an event and will be
set if |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ecommerce
|
EcommerceData |
This will be set if |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customDimension
|
array [CustomDimension] |
A list of all custom dimensions associated with this activity. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
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.
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
|
||||||||||
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 |
||||||||||
Properties
|
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" }
}]
}
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:
When the lifetimeValue is true:
|
||||||||||||||||||||||||||
cohorts
|
array [Cohort] |
The definition for the cohort. |
||||||||||||||||||||||||||
Properties
|
Column headers.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metricHeader
|
MetricHeader |
Metric headers for the metrics in the response. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
dimensions
|
array [string] |
The dimension names in the response. |
Custom dimension.
Name | Data Type | Description |
---|---|---|
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. |
A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
The start and end dates are specified in
ISO8601 date format YYYY-MM-DD
.
Name | Data Type | Description |
---|---|---|
startDate
|
string |
The start date for the query in the format |
endDate
|
string |
The end date for the query in the format |
Used to return a list of metrics for a single DateRange / dimension combination
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
values
|
array [string] |
Each value corresponds to each Metric in the request. |
|||||||
pivotValueRegions
|
array [PivotValueRegion] |
The values of each pivot region. |
|||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
Name of the dimension to fetch, for example |
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:
NOTE: If you are applying histogram mutation on any dimension, and using
that dimension in sort, you will want to use the sort type
"<50", "1001+", "121-1000", "50-120" And the ascending "<50", "50-120", "121-1000", "1001+" The client has to explicitly request |
Dimension filter specifies the filtering options on a dimension.
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 |
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 |
dimensionName
|
string |
The dimension to filter on. A DimensionFilter must contain a dimension. |
caseSensitive
|
boolean |
Should the match be case sensitive? Default is false. |
A group of dimension filters. Set the operator value to specify how the filters are logically combined.
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 |
|||||||||||||||||||
filters
|
array [DimensionFilter] |
The repeated set of filters. They are logically combined based on the operator specified. |
|||||||||||||||||||
Properties
|
Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userSegment
|
SegmentDefinition |
User Segment to select users to include in the segment. |
||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
sessionSegment
|
SegmentDefinition |
Session Segment to select sessions to include in the segment. |
||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of the dynamic segment. |
E-commerce details associated with the user activity.
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
transaction
|
TransactionData |
Transaction details of this e-commerce action. |
||||||||||||||||
Properties
|
||||||||||||||||||
products
|
array [ProductData] |
Details of the products in this transaction. |
||||||||||||||||
Properties
|
||||||||||||||||||
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. |
Represents all the details pertaining to an event.
Name | Data Type | Description |
---|---|---|
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'. |
The batch request containing multiple report request.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
useResourceQuotas
|
boolean |
Enables
resource based
quotas,
(defaults to |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The main response class which holds the reports from the Reporting API
batchGet
call.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
resourceQuotasRemaining
|
ResourceQuotasRemaining |
The amount of resource quota remaining for the property. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reports
|
array [Report] |
Responses corresponding to each of the request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queryCost
|
integer |
The amount of resource quota tokens deducted to execute the query. Includes all responses. |
Represents all the details pertaining to a goal.
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. |
Represents a set of goals that were reached in an activity.
Name | Data Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
goals
|
array [GoalData] |
All the goals that were reached in the current activity. |
||||||||||||||||||||||||||||
Properties
|
Metrics
are the quantitative measurements. For example, the metric ga:users
indicates the total number of users for the requested time period.
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
|
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 |
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 specifies the filter on a metric.
Name | Data Type | Description |
---|---|---|
operator
|
string Allowed values: - OPERATOR_UNSPECIFIED - EQUAL - LESS_THAN - GREATER_THAN - IS_MISSING |
Is the metric |
not
|
boolean |
Logical |
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. |
Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.
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 |
||||||||||||||||
filters
|
array [MetricFilter] |
The repeated set of filters. They are logically combined based on the operator specified. |
||||||||||||||||
Properties
|
The headers for the metrics.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pivotHeaders
|
array [PivotHeader] |
Headers for the pivots in the response. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
metricHeaderEntries
|
array [MetricHeaderEntry] |
Headers for the metrics in the response. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
Header for the metrics.
Name | Data Type | Description |
---|---|---|
type
|
string Allowed values: - METRIC_TYPE_UNSPECIFIED - INTEGER - FLOAT - CURRENCY - PERCENT - TIME |
The type of the metric, for example |
name
|
string |
The name of the header. |
A list of segment filters in the OR
group are combined with the logical OR
operator.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
segmentFilterClauses
|
array [SegmentFilterClause] |
List of segment filters to be combined with a |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Specifies the sorting options.
Name | Data Type | Description |
---|---|---|
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 |
fieldName
|
string |
The field which to sort by. The default sort order is ascending. Example:
|
Represents details collected when the visitor views a page.
Name | Data Type | Description |
---|---|---|
pageTitle
|
string |
The title of the page that the visitor viewed. |
pagePath
|
string |
The URL of the page that the visitor viewed. |
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.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 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. |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
dimensionFilterClauses
|
array [DimensionFilterClause] |
DimensionFilterClauses are logically combined with an |
||||||||||||||||||||||||||||||||
Properties
|
The headers for each of the pivot sections defined in the request.
Name | Data Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalPivotGroupsCount
|
integer |
The total number of groups for this pivot. |
||||||||||||||||||||||||||
pivotHeaderEntries
|
array [PivotHeaderEntry] |
A single pivot section header. |
||||||||||||||||||||||||||
Properties
|
The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
metric
|
MetricHeaderEntry |
The metric header for the metric in the pivot. |
||||||||||
Properties
|
||||||||||||
dimensionValues
|
array [string] |
The values for the dimensions in the pivot. |
||||||||||
dimensionNames
|
array [string] |
The name of the dimensions in the pivot response. |
The metric values in the pivot region.
Name | Data Type | Description |
---|---|---|
values
|
array [string] |
The values of the metrics in each of the pivot regions. |
Details of the products in an e-commerce transaction.
Name | Data Type | Description |
---|---|---|
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. |
The data response corresponding to the request.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Page token to retrieve the next page of results in the list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
ReportData |
Response data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
columnHeader
|
ColumnHeader |
The column headers. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The data part of the report.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
|
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
maximums
|
array [DateRangeValues] |
Minimum and maximum values seen over all matching rows. These are both
empty when |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
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. |
The main request class which specifies the Reporting API request.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
viewId
|
string |
The Analytics
view ID
from which to retrieve data. Every ReportRequest
within a |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
samplingLevel
|
string Allowed values: - SAMPLING_UNSPECIFIED - DEFAULT - SMALL - LARGE |
The desired report
sample size.
If the the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pivots
|
array [Pivot] |
The pivot definitions. Requests can have a maximum of 2 pivots. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metrics
|
array [Metric] |
The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metricFilterClauses
|
array [MetricFilterClause] |
The metric filter clauses. They are logically combined with the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dimensions
|
array [Dimension] |
The dimensions requested. Requests can have a total of 9 dimensions. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dimensionFilterClauses
|
array [DimensionFilterClause] |
The dimension filter clauses for filtering Dimension Values. They are
logically combined with the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cohortGroup
|
CohortGroup |
Cohort group associated with this request. If there is a cohort group
in the request the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
A row in the report.
Name | Data Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metrics
|
array [DateRangeValues] |
List of metrics for each requested DateRange. |
||||||||||||||||||||
Properties
|
||||||||||||||||||||||
dimensions
|
array [string] |
List of requested dimensions. |
The resource quota tokens remaining for the property after the request is completed.
Name | Data Type | Description |
---|---|---|
hourlyQuotaTokensRemaining
|
integer |
Hourly resource quota tokens remaining. |
dailyQuotaTokensRemaining
|
integer |
Daily resource quota remaining remaining. |
Name | Data Type | Description |
---|---|---|
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. |
The request to fetch User Report from Reporting API userActivity:get
call.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
viewId
|
string |
Required. The Analytics
view ID
from which to retrieve data. Every
SearchUserActivityRequest must contain the
|
||||||||||
user
|
User |
Required. Unique user Id to query for. Every SearchUserActivityRequest must contain this field. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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). |
||||||||||
Properties
|
||||||||||||
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. |
The response from userActivity:get
call.
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). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
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.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
segmentId
|
string |
The segment ID of a built-in or custom segment, for example |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dynamicSegment
|
DynamicSegment |
A dynamic segment definition in the request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
SegmentDefinition defines the segment to be a set of SegmentFilters which
are combined together with a logical AND
operation.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
segmentFilters
|
array [SegmentFilter] |
A segment is defined by a set of segment filters which are combined
together with a logical |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Dimension filter specifies the filtering options on a dimension.
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 |
maxComparisonValue
|
string |
Maximum comparison values for |
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 |
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.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
simpleSegment
|
SimpleSegment |
A Simple segment conditions consist of one or more dimension/metric conditions that can be combined |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
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:
|
Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter.
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
not
|
boolean |
Matches the complement ( |
||||||||||||||||||||||
metricFilter
|
SegmentMetricFilter |
Metric Filter for the segment definition. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
dimensionFilter
|
SegmentDimensionFilter |
Dimension Filter for the segment definition. |
||||||||||||||||||||||
Properties
|
Metric filter to be used in a segment filter clause.
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 |
metricName
|
string |
The metric that will be filtered on. A |
maxComparisonValue
|
string |
Max comparison value is only used for |
comparisonValue
|
string |
The value to compare against. If the operator is |
A segment sequence definition.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
orFiltersForSegment
|
array [OrFiltersForSegment] |
A sequence is specified with a list of Or grouped filters which are
combined with |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
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.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
segmentSequenceSteps
|
array [SegmentSequenceStep] |
The list of steps in the sequence. |
||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||
firstStepShouldMatchFirstHit
|
boolean |
If set, first step condition must match the first hit of the visitor (in the date range). |
A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
orFiltersForSegment
|
array [OrFiltersForSegment] |
A list of segment filters groups which are combined with logical |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Represents details collected when the visitor performs a transaction on the page.
Name | Data Type | Description |
---|---|---|
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. |
Contains information to identify a particular user uniquely.
Name | Data Type | Description |
---|---|---|
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 |
This represents a user session performed on a specific device at a certain time over a period of time.
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 |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/analytics
: View and manage your Google Analytics datahttps://www.googleapis.com/auth/analytics.readonly
: View your Google Analytics data
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/analytics
: View and manage your Google Analytics datahttps://www.googleapis.com/auth/analytics.readonly
: View your Google Analytics dataName | Google |
External URL | https://google.com |
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 |