The CData Sync App provides a straightforward way to continuously pipeline your Google Analytics data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Google Analytics connector can be used from the CData Sync application to pull data from Google Analytics and move it to any of the supported destinations.
The Sync App supports Google Analytics 4 APIs. The Sync App provides a relational view of the Google Analytics profiles in your Google account or across your Google Apps domain. The Sync App includes tables that contain often-used dimensions and metrics as columns; additionally, you can customize the table schemas or write your own to combine any valid set of dimensions and metrics. The Sync App exposes the columns available through the Data API (Google Analytics 4) and the Admin API (Google Analytics 4). You must enable these APIs by creating a project in the Google Developers Console. See "Connecting to Google Analytics" for a guide to creating a project and authenticating to the APIs.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
Provide the following connection properties before adding the authentication properties.
The Sync App supports using user accounts and GCP instance accounts for authentication.
The following sections discuss the available authentication schemes for Google Analytics:
AuthScheme must be set to OAuth in all user account flows.
Get an OAuth Access Token
Set the following connection properties to obtain the OAuthAccessToken:
Then call stored procedures to complete the OAuth exchange:
Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.
Automatic Refresh of the OAuth Access Token
To have the driver automatically refresh the OAuth access token, set the following on the first data connection:
Manual Refresh of the OAuth Access Token
The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.
Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:
Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.
Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
Option 1: Obtain and Exchange a Verifier Code
To obtain a verifier code, you must authenticate at the OAuth authorization URL.
Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
After the OAuth settings file is generated, you need to re-set the following properties to connect:
Option 2: Transfer OAuth Settings
Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.
After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.
Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.
On the headless machine, set the following connection properties to connect to data:
When running on a GCP virtual machine, the Sync App can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.
These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.
This topic provides information about the required access scopes and endpoint domains for the Google Analytics Sync App.
Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.
For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.
Scope | Description |
googleapis.com/auth/analytics.readonly | Read-only access to the Google Analytics API. Accepted values are NONE, CONSENT, and the default SELECT ACCOUNT. |
Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.
Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.
Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.
Domain | Always Required | Description |
accounts.google.com | TRUE | The domain used for OAuth. |
analyticsadmin.googleapis.com | FALSE | This domain is required if Schema=GoogleAnalytics4, which is the default. |
Google Analytics data is organized into various metrics (Sessions, Impressions, AdClicks, etc.), which can be queried over various dimensions (Country, Month, etc.). There are many valid combinations of metrics and dimensions. The Sync App surfaces some of the most commonly used combinations as tables for ease of use.
Additionally, the Sync App allows you to query all valid combinations, even those not included in the predefined tables, using two methods: by using the Dimensions and Metrics columns and by defining custom schemas. Refer to Advanced Queries for more information. Below is a guide to getting started with the default tables.
The dimensions and metrics are clearly defined for each table and can be seen in the Data Model: Simply select the metrics and dimensions you are interested in.
For example, to find the number of sessions in each month, query the Session metric over the Month dimension. This would return 12 rows: one for each month.
SELECT Sessions, Month FROM TrafficTo separate out the months in each year, include both the month and the year dimensions in the query:
SELECT Sessions, Month, Year FROM Traffic
All Google Analytics reports cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT Sessions, Month, Year FROM Traffic WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
The supported inputs for StartDate and EndDate in the Google Analytics API are 'today', 'yesterday', 'NdaysAgo' (where N is some number), and an exact date. Starting with the v4 API, up to two separate date ranges can be set in the filter.
Unlike most database tables, it is not very helpful to select all metrics and dimensions in a given table.
In some cases, it is not possible to do this since Google Analytics allows a maximum of nine dimensions and 10 metrics in a single query.
The Sync App interprets the SELECT * query as a request for a default set of metrics and dimensions.
This includes queries that explicitly select all columns. For schemas with fewer than 10 metrics, all metrics are returned.
Refer to the individual view's documentation in Data Model to see which fields are the default for each schema.
Google Analytics has a very large number of metrics and dimensions that would clutter table definitions, so the table definitions included with the product only list the most commonly used combinations. We offer two alternatives to this design choice: You can use the Dimensions and Metrics columns to request fields that are not in the default table, or you can define your own table.
To request additional dimensions or metrics for any existing table, the recommended approach is to define custom schemas; however, you can also set the Dimensions and Metrics inputs in the WHERE clause. Both inputs take a comma-separated list so that you can specify multiple fields at once. The values will be returned in the corresponding Dimensions and Metrics column in the same order that you submitted them. For example, the following query will query the Traffic table for Sessions, the Goal 1 Conversion Rate, and Goal 1 Completions and group these metrics together by the User Age Bracket dimension:
SELECT Sessions, Dimensions, Metrics FROM Traffic WHERE Dimensions='UserAgeBracket' AND Metrics='Goal1ConversionRate,Goal1Completions'In the results from the query above, the value for UserAgeBracket will be returned in the Dimensions field for each row. The Metrics field will contain a comma-separated value containing the requested metrics for Goal 1.
This section details a selection of advanced features of the Google Analytics Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App models Google Analytics entities in relational Tables, Views, and Stored Procedures. The provided tables will give you an overview of your account information and the profiles available for Google Analytics queries. Google Analytics allows for Dimensions and Metrics to be queried in a large number of arrangements. Some sample views are provided based on common Google Analytics reports. You can, however, also create your own custom views based on any combination of Dimensions and Metrics you need.
API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
The CreateCustomSchema stored procedure can be used to easily generate new schema files with a custom combination of Dimensions and Metrics. This procedure takes the TableName and a comma-separated lists of Dimensions and Metrics and builds a schema file that can be read by the Sync App. Each Dimension or Metric in the list takes the name of the value from Google Analytics (without the 'ga:' prefix). For example:
Dimensions=UserType,SessionCount
Metrics=Users,PercentNewSessionsIf the Location connection property is set, the file will be output to that folder. Otherwise, the OutputFolder input can be used to specify an output folder. To begin querying these new files, simply set the Location connection property to the folder containing these new schema files.
See GoogleAnalytics4 Data Model for the available entities in the Google Analytics 4 API.
The CData Sync App models the Google Analytics 4 API as relational tables, views, and stored procedures. The provided tables give you an overview of your account information and the profiles available for Google Analytics queries. Google Analytics supports the querying of dimensions and metrics in various arrangements. Some sample views are provided based on common Google Analytics reports.
You can also create your own custom views based on any combination of Dimensions and Metrics you need. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations. However, there is a strict limit of nine dimensions and 10 metrics per query, unless otherwise stated in the specific table or view pages.
Views are tables that cannot be modified, such as Accounts, Properties, Events, Acquisitions, and Engagement. Typically, data that is read-only and cannot be updated are shown as views. Two types of views are made available:
Additional predefined date fields are available:
month = '2022-05-01'NOTE: The default time interval for views is 30 days.
Aggregation
Aggregation is the process of reducing and summarizing data. You can apply aggregation at multiple levels:
The following examples show the syntax of aggregation queries:
SELECT Date,NewUsers, TotalUsers From Tech where StartDate = '2022-01-01' and EndDate = '2023-05-18' SELECT Hour,NewUsers, TotalUsers From Tech where StartDate = '2022-01-01' and EndDate = '2023-05-18' SELECT Day,NewUsers, TotalUsers From Tech where StartDate = '2022-01-01' and EndDate = '2023-05-18' SELECT Week,NewUsers, TotalUsers From Tech where StartDate = '2022-01-01' and EndDate = '2023-05-18' SELECT Month,NewUsers, TotalUsers From Tech where StartDate = '2022-01-01' and EndDate = '2023-05-18' SELECT Year,NewUsers, TotalUsers From Tech where StartDate = '2022-01-01' and EndDate = '2023-05-18'Some comments about the aggregation code examples:
NOTE: choosing "Date" as a metric overrides any other date metric you select. Only daily data is returned.
Stored Procedures are function-like interfaces to the data source. You can use these to search, update, and modify information in the data source.
Fully qualified queries support both the OR and AND operators used together. The OR operator can only be used with the same columns if it is combined with
the AND operator for filtering dimensions or metrics. If the OR operator is used with different columns in combination with the AND operator, it may produce unexpected results.
For example, the following query may give unexpected results:
SELECT * FROM [Acquisitions] WHERE [StartDate] = '2023-03-22' AND [EndDate] = '2023-03-22' AND [PagePath] LIKE '%as' OR [Country] LIKE 'US'Given below are a few valid queries:
SELECT * FROM [Acquisitions] WHERE [StartDate] = '2023-03-22' AND [EndDate] = '2023-03-22' AND ([Country] LIKE 'US' OR [Country] LIKE '%In')
SELECT * FROM [Acquisitions] WHERE [StartDate] = '2023-03-22' AND [EndDate] = '2023-03-22' OR [PagePath] LIKE '%as'
SELECT * FROM [Acquisitions] WHERE [PagePath] LIKE '%as' OR [PagePath] LIKE 'A' OR [Country] LIKE '%In'
SELECT * FROM [Acquisitions] WHERE [PagePath] LIKE '%as' AND [Country] LIKE '%In'
SELECT * FROM [Acquisitions] WHERE [PagePath] LIKE '%as' AND ([Country] LIKE 'India' OR [Country] LIKE '%US')
SELECT * FROM [Tech] WHERE [StartDate] = '2021-01-01' AND [EndDate] = '2021-05-18' AND [NewUsers] >= 26 AND [NewUsers] < 35 AND ([Browser] IN ('Chrome', 'Edge') OR [Browser] = 'Edge')
SELECT * FROM [TechDeviceModelReport] WHERE [Date] >= '2020-05-13' AND [Date] <= '2023-06-13' AND [DeviceModel] != '(not set)' AND [DeviceModel] != '(test)' AND ([NewUsers] = 15 OR [NewUsers] = 20)
SELECT * FROM [Tech] WHERE [StartDate] = '2017-01-01' AND [EndDate] = '2023-05-02' AND CONTAINS ([Browser], 'ed') OR CONTAINS ([Browser], 'ch')
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
Accounts | Lists all Accounts to which the user has access. |
AccountSummaries | Lists summaries of all Accounts to which the user has access. |
Acquisitions | A base view that retrieves Acquisitions data. |
AcquisitionsFirstUserCampaignReport | A predefined view that retrieves Acquisitions first user Campaign data. |
AcquisitionsFirstUserGoogleAdsAdGroupNameReport | A predefined view that retrieves user Acquisitions first user google ads ad group name data. |
AcquisitionsFirstUserGoogleAdsNetworkTypeReport | A predefined view that retrieves Acquisitions first user google ads ad network type platform data. |
AcquisitionsFirstUserMediumReport | A predefined view that retrieves Acquisitions first user medium data. |
AcquisitionsFirstUserSourceMediumReport | A predefined view that retrieves Acquisitions first user source medium data. |
AcquisitionsFirstUserSourcePlatformReport | A predefined view that retrieves Acquisitions first user source platform data. |
AcquisitionsFirstUserSourceReport | A predefined view that retrieves Acquisitions first user source data. |
AcquisitionsSessionCampaignReport | A predefined view that retrieves Acquisitions session campaign report data. |
AcquisitionsSessionDefaultChannelGroupingReport | A predefined view that retrieves Acquisitions session default channel grouping report data. |
AcquisitionsSessionMediumReport | A predefined view that retrieves Acquisitions session medium report data. |
AcquisitionsSessionSourceMediumReport | A predefined view that retrieves Acquisitions session source medium report data. |
AcquisitionsSessionSourcePlatformReport | A predefined view that retrieves Acquisitions session source platform report data. |
AcquisitionsSessionSourceReport | A predefined view that retrieves Acquisitions session source report data. |
ActiveUsers | A base view that retrieves Active Users data. |
DemographicAgeReport | A predefined view that retrieves Demographics UserAgeBracket data. |
DemographicCityReport | A predefined view that retrieves Demographics City data. |
DemographicCountryReport | A predefined view that retrieves Demographics Country data. |
DemographicGenderReport | A predefined view that retrieves Demographics UserGender data. |
DemographicInterestsReport | A predefined view that retrieves Demographics BrandingInterest data. |
DemographicLanguageReport | A predefined view that retrieves Demographics Language data. |
DemographicRegionReport | A predefined view that retrieves Demographics Region data. |
Demographics | A base view that retrieves Demographics data. |
EcommPurchasesItemBrandReport | A predefined view that retrieves Ecommerce purchase item brand data. |
EcommPurchasesItemCategory2Report | A predefined view that retrieves Ecommerce purchase item category data. |
EcommPurchasesItemCategory3Report | A predefined view that retrieves Ecommerce purchase item category data. |
EcommPurchasesItemCategory4Report | A predefined view that retrieves Ecommerce purchase item category data. |
EcommPurchasesItemCategory5Report | A predefined view that retrieves Ecommerce purchase item category data. |
EcommPurchasesItemCategoryReport | A predefined view that retrieves Ecommerce purchase item category data. |
EcommPurchasesItemCategoryReportCombined | A predefined view that retrieves Ecommerce purchase item category data. |
EcommPurchasesItemIdReport | A predefined view that retrieves Ecommerce purchase item data. |
EcommPurchasesItemNameReport | A predefined view that retrieves Ecommerce purchase item data. |
Engagement | A base view that retrieves Engagement data |
EngagementContentGroupReport | A predefined view that retrieves Engagement Content Group Report data. |
EngagementConversionsReport | A predefined view that retrieves Engagement conversions data. |
EngagementEventsReport | A predefined view that retrieves Engagement events data. |
EngagementPagesPathReport | A predefined view that retrieves Engagement Pages path report data. |
EngagementPagesTitleAndScreenClassReport | A predefined view that retrieves Engagement Pages title and screen class data. |
EngagementPagesTitleAndScreenNameReport | A predefined view that retrieves Engagement Pages Title And ScreenName data. |
Events | A base view that retrieves Event data |
GamesReporting | A base view that retrieves Games Reporting data. |
GlobalAccessObject | Retrieves data for all the available dimensions and metrics. |
KeyEvents | A base view that retrieves KeyEvents data |
MetaData | Retrieves metadata information for standard and custom dimensions / metrics. |
Monetization | A base view that retrieves Monetization data. |
MonetizationPublisherAdsAdFormatReport | A predefined view that retrieves publisher ads page ad format data. |
MonetizationPublisherAdsAdSourceReport | A predefined view that retrieves publisher ads ad source data. |
MonetizationPublisherAdsAdUnitReport | A predefined view that retrieves publisher ads ad unit data. |
MonetizationPublisherAdsPagePathReport | A predefined view that retrieves publisher ads page path data. |
Properties | Lists all Properties to which the user has access. |
PropertiesAccessBindings | Lists all access bindings on an account or property. Requires one of the following OAuth scopes: https://www.googleapis.com/auth/analytics.manage.users.readonly https://www.googleapis.com/auth/analytics.manage.users |
PropertiesAudiences | Lists Audiences on a property. |
PropertiesDataStreams | Lists all data streams under a property to which the user has access. Attribute Parent (e.g: 'properties/123') or Name (e.g: 'properties/123/webDataStreams/456') is required to query the table. |
PropertiesFireBaseLinks | Lists all FirebaseLinks on a property to which the user has access. |
PropertiesGoogleAdsLinks | Lists all GoogleAdsLinks on a property to which the user has access. |
PropertiesKeyEvents | Returns a list of Key Events in the specified parent property. |
ScreenPageViews | A base view that retrieves ScreenPage data |
Tech | A base view that retrieves Tech data. |
TechAppVersionReport | A predefined view that retrieves Tech App Version data. |
TechBrowserReport | A predefined view that retrieves Tech Browser data. |
TechDeviceCategoryReport | A predefined view that retrieves Tech Device Category data. |
TechDeviceModelReport | A predefined view that retrieves Tech Device Model data. |
TechOSSystemReport | A predefined view that retrieves Tech os system data. |
TechOSVersionReport | A predefined view that retrieves Tech Os version data. |
TechPlatformDeviceCategoryReport | A predefined view that retrieves Tech platform device category data. |
TechPlatformReport | A predefined view that retrieves Tech platform data. |
TechScreenResolutionReport | A predefined view that retrieves Tech Screen Resolution data. |
Lists all Accounts to which the user has access.
The Accounts table exposes every account the user has access to. The provider uses the GoogleAnalytics4 API to process WHERE clause conditions built with the Name column, which supports the = operator.
The following query is processed server-side:
SELECT * FROM Accounts WHERE Name = 'accounts/54516992'The rest of the filter is executed client-side within the provider.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
CreateTime | Datetime | Time the account was created. | |||
DisplayName | String | display name for the account. | |||
Name | String | Account name. | |||
RegionCode | String | Country for the account. | |||
UpdateTime | Datetime | Time the account was last modified. | |||
Deleted | Boolean | Indicates whether this Account is soft-deleted or not. |
Lists summaries of all Accounts to which the user has access.
The AccountSummaries table exposes summaries of all accounts accessible by the caller.
The following query is processed server-side:
SELECT * FROM AccountSummaries
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Account | String | Account name referred to by this account summary. | |||
DisplayName | String | display name for the account referred to by this account summary. | |||
Name | String | Account summary name. | |||
Propertysummaries | String | Summaries for child accounts of the specific account. |
A base view that retrieves Acquisitions data.
Retrieves data for Acquisitions report. At least one metric must be specified in the query. In the query you can also specify up to 9 dimensions.
The following is an example query:
SELECT Conversions, NewUsers FROM Acquisitions
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT SessionCustomChannelGroupName, FirstGroupCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM Acquisitions
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Date | Date | True | The date of the session formatted as YYYYMMDD. | ||
Year | Integer | True | The year of the session. A four-digit year from 2005 to the current year. | ||
Month | Integer | True | The month of the session. An integer from 01 to 12. | ||
Week | Integer | True | The week of the session. A number from 01 to 53. Each week starts on Sunday. | ||
Day | Integer | True | The day of the month. A number from 01 to 31. | ||
DayOfWeekName | String | True | The day of the week in English. This dimension has values of Sunday, Monday, etc. | ||
IsoWeek | Integer | True | ISO week number, where each week starts on Monday Example values include 01, 02, 53. | ||
IsoYear | Integer | True | The ISO year of the event. For details, see Example values include 2022 2023. | ||
IsoYearIsoWeek | Integer | True | The combined values of isoWeek and isoYear. Example values include 201652 and 201701. | ||
YearMonth | Integer | True | The combined values of year and month. Example values include 202212 or 202301. | ||
YearWeek | Integer | True | The combined values of year and week. Example values include 202253 or 202301. | ||
Hour | Integer | True | An hour of the day ranging from 00-23 in the timezone configured for the account. This value is also corrected for daylight savings time. | ||
FirstUserGoogleAdsAdGroupName | String | True | The Ad Group Name in Google Ads that first acquired the user. | ||
FirstUserGoogleAdsAdNetworkType | String | True | The advertising network that first acquired the user. | ||
FirstUserCampaignName | String | True | Name of the marketing campaign that first acquired the user. | ||
FirstUserGoogleAdsCreativeId | String | True | The campaign creative ID that first acquired the users. | ||
FirstUserMedium | String | True | True | The medium that first acquired the user to the website or app. | |
FirstUserSource | String | True | The source that first acquired the user to the website or app. | ||
SessionCampaignName | String | True | Campaign that referred the user's session. | ||
SessionDefaultChannelGroup | String | True | Channel groupings are rule-based definitions of your traffic sources. These default system definitions reflect Analytics' current view of what constitutes each channel. | ||
SessionMedium | String | True | Channel that referred the user's session. | ||
SessionSource | String | True | The source that initiated a session on your website or app. | ||
EventName | String | True | The name of the event. | ||
BrandingInterest | String | True | Interests demonstrated by users who are higher in the shopping funnel. Users can be counted in multiple interest categories. | ||
Country | String | True | Country from which user activity originated. | ||
City | String | True | City from which user activity originated. | ||
Language | String | True | Language setting for the device from which activity originated. | ||
UserAgeBracket | String | True | User age brackets. | ||
UserGender | String | True | User gender. | ||
Region | String | True | Geographic region from which activity originated. | ||
UnifiedScreenClass | String | True | The page title (web) or screen class (app) on which the event was logged. | ||
PagePath | String | True | The portion of the URL between the hostname and query string for web. | ||
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EngagedSessionsPerUser | Decimal | False | True | Average number of engaged sessions per user. | |
EventCount | Integer | False | True | The count of events. | |
EventsPerSession | Decimal | False | True | The average number of events per session. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
Sessions | Integer | False | True | The number of sessions that began on the site or app. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | False | The total amount of time (in seconds) the website or app was in the foreground of users device. | |
ScreenPageViews | Integer | False | False | The number of app screens or web pages the users viewed. Repeated views of a single page or screen are counted. | |
EventCountPerUser | Decimal | False | False | Average number of events triggered by each user. | |
SessionsPerUser | Decimal | False | False | The average number of sessions per user (Sessions divided by Active Users). | |
StartDate | String | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |||
EndDate | String | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions first user Campaign data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE FirstUserGoogleAdsAdGroupName = 'Test' SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE PropertyId = 342020667 AND FirstUserGoogleAdsAdGroupName = 'Test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsFirstUserCampaignReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT FirstUserCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsFirstUserCampaignReport
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
FirstUserCampaignName | String | True | True | Name of the marketing campaign that first acquired the user. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | False | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves user Acquisitions first user google ads ad group name data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE FirstUserGoogleAdsAdGroupName = 'Test' SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE PropertyId = 342020667 AND FirstUserGoogleAdsAdGroupName = 'Test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsFirstUserGoogleAdsAdGroupNameReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
FirstUserGoogleAdsAdGroupName | String | True | True | The Ad Group Name in Google Ads that first acquired the user. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions first user google ads ad network type platform data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE FirstUserGoogleAdsNetworkType = 'test' SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE PropertyId = 342020667 AND FirstUserGoogleAdsNetworkType = 'test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsFirstUserGoogleAdsNetworkType WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
FirstUserGoogleAdsAdNetworkType | String | True | True | The source platform that first acquired the user. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions first user medium data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsFirstUserMediumReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsFirstUserMediumReport WHERE FirstUserMedium = 'test' SELECT * FROM AcquisitionsFirstUserMediumReport WHERE Date = '20221115' SELECT * FROM AcquisitionsFirstUserMediumReport WHERE PropertyId = 342020667 AND FirstUserMedium = 'test' AND Date = '01/05/2023'' SELECT * FROM AcquisitionsFirstUserMediumReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsFirstUserMediumReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsFirstUserMediumReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsFirstUserMediumReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsFirstUserMediumReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT FirstUserCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsFirstUserMediumReport WHERE FirstUserMedium = 'test'
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
FirstUserMedium | String | True | True | The medium that first acquired the user to the website or app. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions first user source medium data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE FirstUserGoogleAdsAdGroupName = 'Test' SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE Date = '01/05/2023'' SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE PropertyId = 342020667 AND FirstUserGoogleAdsAdGroupName = 'Test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourceMediumReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT FirstUserCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsFirstUserSourceMediumReport
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
FirstUserSource | String | True | True | The source that first acquired the user to the website or app. | |
FirstUserMedium | String | True | True | The medium that first acquired the user to the website or app. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions first user source platform data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE FirstUserSourcePlatform = 'Test' SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE PropertyId = 342020667 AND FirstUserSourcePlatform = 'Test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourcePlatformReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT FirstUserCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsFirstUserSourcePlatformReport WHERE FirstUserSourcePlatform = 'Test'
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
FirstUserSourcePlatform | String | True | True | The source platform that first acquired the user. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions first user source data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsFirstUserSourceReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsFirstUserSourceReport WHERE FirstUserSource = '(direct)' SELECT * FROM AcquisitionsFirstUserSourceReport WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserSourceReport WHERE PropertyId = 342020667 AND FirstUserSource = '(direct)' AND Date = '01/05/2023' SELECT * FROM AcquisitionsFirstUserSourceReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsFirstUserSourceReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourceReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourceReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsFirstUserSourceReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT FirstUserCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsFirstUserSourceReport WHERE FirstUserSource = '(direct)'
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
FirstUserSource | String | True | True | The source that first acquired the user to the website or app. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | False | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions session campaign report data.
n
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE SessionDefaultChannelGrouping = 'Direct' SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE PropertyId = 342020667 AND SessionDefaultChannelGrouping = 'Direct' AND Date = '01/05/2023' SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT SessionCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsSessionDefaultChannelGroupingReport WHERE SessionDefaultChannelGrouping = 'Direct'
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
SessionCampaignName | String | True | True | Campaign that referred the user | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Sessions | Integer | False | True | The number of sessions that began on the site or app. | |
EventsPerSession | Decimal | False | True | The average number of events per session. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions session default channel grouping report data.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
SessionDefaultChannelGroup | String | True | True | Channel groupings are rule-based definitions of your traffic sources. These default system definitions reflect Analytics current view of what constitutes each channel. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EventsPerSession | Decimal | False | True | The average number of events per session. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions session medium report data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsSessionMediumReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsSessionMediumReport WHERE SessionMedium = 'test' SELECT * FROM AcquisitionsSessionMediumReport WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsSessionMediumReport WHERE PropertyId = 342020667 AND SessionMedium = 'test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsSessionMediumReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsSessionMediumReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsSessionMediumReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsSessionMediumReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsSessionMediumReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT SessionCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsSessionMediumReport WHERE SessionMedium = 'test'
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
SessionMedium | String | True | True | Channel that referred the user | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Sessions | Integer | False | True | The number of sessions that began on the site or app. | |
EventsPerSession | Decimal | False | True | The average number of events per session. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions session source medium report data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE FirstUserGoogleAdsAdGroupName = 'Test' SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE PropertyId = 342020667 AND FirstUserGoogleAdsAdGroupName = 'Test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsSessionSourceMediumReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT SessionCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsSessionSourceMediumReport
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
SessionMedium | String | True | True | Channel that referred the user | |
SessionSource | String | True | True | The source that initiated a session on your website or app. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Sessions | Integer | False | True | The number of sessions that began on the site or app. | |
EventsPerSession | Decimal | False | True | The average number of events per session. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | False | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions session source platform report data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE FirstUserGoogleAdsAdGroupName = 'Test' SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE Date = '01/05/2023' SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE PropertyId = 342020667 AND FirstUserGoogleAdsAdGroupName = 'Test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsSessionSourcePlatformReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT SessionCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsSessionSourcePlatformReport
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
SessionSourcePlatform | String | True | True | The source platform of the session | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EventsPerSession | Decimal | False | True | The average number of events per session. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | False | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Acquisitions session source report data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM AcquisitionsSessionSourceReport WHERE PropertyId = 342020667 SELECT * FROM AcquisitionsSessionSourceReport WHERE FirstUserGoogleAdsAdGroupName = 'Test' SELECT * FROM AcquisitionsSessionSourceReport WHERE Date = '01/01/2022' SELECT * FROM AcquisitionsSessionSourceReport WHERE PropertyId = 342020667 AND FirstUserGoogleAdsAdGroupName = 'Test' AND Date = '01/05/2023' SELECT * FROM AcquisitionsSessionSourceReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM AcquisitionsSessionSourceReport WHERE Date >= '01/01/2022' SELECT * FROM AcquisitionsSessionSourceReport WHERE Date <= '01/01/2022' SELECT * FROM AcquisitionsSessionSourceReport WHERE Date > '01/01/2022' SELECT * FROM AcquisitionsSessionSourceReport WHERE Date < '01/01/2022'
CustomChannelGroups are added as dimension columns. You can query customChannelGroup in the following way:
SELECT SessionCustomChannelGroupName, SessionDefaultChannelGrouping, Conversions FROM AcquisitionsSessionSourceReport
NOTE: CustomChannelGroupName is for reference purposes only. The exact value depends on the channelGroupName added. The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
SessionSource | String | True | True | The source that initiated a session on your website or app. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Sessions | Integer | False | True | The number of sessions that began on the site or app. | |
EventsPerSession | Decimal | False | True | The average number of events per session. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
UserEngagementDuration | Bigint | False | False | The total amount of time (in seconds) the website or app was in the foreground of users |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A base view that retrieves Active Users data.
Retrieves data for ActiveUsers report. At least one metric must be specified in the query. This endpoint uses the realtime report API endpoint to get more up to date data than the standard reporting endpoint. The realtime reporting API supports a maximum of four dimensions compared to the standard nine for the standard report API.
The following is an example query:
SELECT ActiveUsers, Platform FROM ActiveUsers
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
AppVersion | String | True | The app's versionName (Android) or short bundle version (iOS). | ||
City | String | True | The city from which the user activity originated. | ||
Country | String | True | The country from which the user activity originated. | ||
DeviceCategory | String | True | The type of device: Desktop, Tablet, or Mobile. | ||
Platform | String | True | True | The platform on which your app or website ran. | |
AudienceName | String | True | The given name of an Audience. | ||
UnifiedScreenName | String | True | The page title (web) or screen name (app) on which the event was logged. | ||
ActiveUsers | Integer | False | True | The total number of active users. | |
AudienceId | Long | True | The numeric identifier of an Audience. | ||
AudienceResourceName | String | True | The resource name of this audience. | ||
CityId | Integer | True | The geographic ID of the city from which the user activity originated, derived from their IP address. | ||
CountryId | String | True | The geographic ID of the country from which the user activity originated, derived from their IP address. | ||
MinutesAgo | Integer | True | The number of minutes ago that an event was collected. 00 is the current minute, and 01 means the previous minute. | ||
StreamId | Long | True | The numeric data stream identifier for your app or website. | ||
StreamName | String | True | The data stream name for your app or website. | ||
EventName | String | True | The name of the event |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Demographics UserAgeBracket data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM DemographicAgeReport WHERE PropertyId = 342020667 SELECT * FROM DemographicAgeReport WHERE UserAgeBracket = '18-24' SELECT * FROM DemographicAgeReport WHERE Date = '01/05/2023' SELECT * FROM DemographicAgeReport WHERE PropertyId = 342020667 AND Date = '01/05/2023' AND UserAgeBracket = '18-24' SELECT * FROM DemographicAgeReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM DemographicAgeReport WHERE Date >= '01/01/2022' SELECT * FROM DemographicAgeReport WHERE Date <= '01/01/2022' SELECT * FROM DemographicAgeReport WHERE Date > '01/01/2022' SELECT * FROM DemographicAgeReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
UserAgeBracket | String | True | True | User age brackets. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Demographics City data.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
City | String | True | True | City from which user activity originated. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Demographics Country data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM DemographicCountryReport WHERE PropertyId = 342020667 SELECT * FROM DemographicCountryReport WHERE Country = 'America' SELECT * FROM DemographicCountryReport WHERE Date = '01/05/2023' SELECT * FROM DemographicCountryReport WHERE PropertyId = 342020667 AND Date = '01/05/2023' AND Country = 'America' SELECT * FROM DemographicCountryReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM DemographicCountryReport WHERE Date >= '01/01/2022' SELECT * FROM DemographicCountryReport WHERE Date <= '01/01/2022' SELECT * FROM DemographicCountryReport WHERE Date > '01/01/2022' SELECT * FROM DemographicCountryReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Country | String | True | True | Country from which user activity originated. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Demographics UserGender data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM DemographicGenderReport WHERE PropertyId = 342020667 SELECT * FROM DemographicGenderReport WHERE UserGender = 'Female' SELECT * FROM DemographicGenderReport WHERE Date = '01/01/2022' SELECT * FROM DemographicGenderReport WHERE PropertyId = 342020667 AND Date = '01/01/2022' AND UserGender = 'Female' SELECT * FROM DemographicGenderReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM DemographicGenderReport WHERE Date >= '01/01/2022' SELECT * FROM DemographicGenderReport WHERE Date <= '01/01/2022' SELECT * FROM DemographicGenderReport WHERE Date > '01/01/2022' SELECT * FROM DemographicGenderReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
UserGender | String | True | True | User gender. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Demographics BrandingInterest data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM DemographicInterestsReport WHERE PropertyId = 342020667 SELECT * FROM DemographicInterestsReport WHERE BrandingInterest = 'Marketing' SELECT * FROM DemographicInterestsReport WHERE Date = '01/05/2023' SELECT * FROM DemographicInterestsReport WHERE PropertyId = 342020667 AND Date = '01/05/2023' AND BrandingInterest = 'Marketing' SELECT * FROM DemographicInterestsReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM DemographicInterestsReport WHERE Date >= '01/01/2022' SELECT * FROM DemographicInterestsReport WHERE Date <= '01/01/2022' SELECT * FROM DemographicInterestsReport WHERE Date > '01/01/2022' SELECT * FROM DemographicInterestsReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
BrandingInterest | String | True | True | Interests demonstrated by users who are higher in the shopping funnel. Users can be counted in multiple interest categories. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Demographics Language data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM DemographicLanguageReport WHERE PropertyId = 342020667 SELECT * FROM DemographicLanguageReport WHERE Language = 'English' SELECT * FROM DemographicLanguageReport WHERE Date = '01/05/2023' SELECT * FROM DemographicLanguageReport WHERE PropertyId = 342020667 AND Date = '01/05/2023' AND Language = 'English' SELECT * FROM DemographicLanguageReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM DemographicLanguageReport WHERE Date >= '01/01/2022' SELECT * FROM DemographicLanguageReport WHERE Date <= '01/01/2022' SELECT * FROM DemographicLanguageReport WHERE Date > '01/01/2022' SELECT * FROM DemographicLanguageReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Language | String | True | True | Language setting for the device from which activity originated. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Demographics Region data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM DemographicRegionReport WHERE PropertyId = 342020667 SELECT * FROM DemographicRegionReport WHERE Region = 'California' SELECT * FROM DemographicRegionReport WHERE Date = '01/05/2023' SELECT * FROM DemographicRegionReport WHERE PropertyId = 342020667 AND Date = '01/05/2023' AND Region = 'California' SELECT * FROM DemographicRegionReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM DemographicRegionReport WHERE Date >= '01/01/2022' SELECT * FROM DemographicRegionReport WHERE Date <= '01/01/2022' SELECT * FROM DemographicRegionReport WHERE Date > '01/01/2022' SELECT * FROM DemographicRegionReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Region | String | True | True | Geographic region from which activity originated. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A base view that retrieves Demographics data.
Retrieves data for Demographics report. At least one metric must be specified in the query. In the query you can also specify up to nine dimensions.
The following is an example query:
SELECT Conversions, TotalRevenue FROM Demographics
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Date | Date | True | The date of the session formatted as YYYYMMDD. | ||
Year | Integer | True | The year of the session. A four-digit year from 2005 to the current year. | ||
Month | Integer | True | The month of the session. An integer from 01 to 12. | ||
Week | Integer | True | The week of the session. A number from 01 to 53. Each week starts on Sunday. | ||
Day | Integer | True | The day of the month. A number from 01 to 31. | ||
DayOfWeekName | String | True | The day of the week in English. This dimension has values of Sunday, Monday, etc. | ||
IsoWeek | Integer | True | ISO week number, where each week starts on Monday. Example values include 01, 02, 53. | ||
IsoYear | Integer | True | The ISO year of the event.Example values include 2022 2023. | ||
IsoYearIsoWeek | Integer | True | The combined values of isoWeek and isoYear. Example values include 201652 and 201701. | ||
YearMonth | Integer | True | The combined values of year and month. Example values include 202212 or 202301. | ||
YearWeek | Integer | True | The combined values of year and week. Example values include 202253 or 202301. | ||
Hour | Integer | True | An hour of the day ranging from 00-23 in the timezone configured for the account. This value is also corrected for daylight savings time. | ||
BrandingInterest | String | True | Interests demonstrated by users who are higher in the shopping funnel. Users can be counted in multiple interest categories. | ||
Country | String | True | True | Country from which user activity originated. | |
City | String | True | City from which user activity originated. | ||
Language | String | True | Language setting for the device from which activity originated. | ||
UserAgeBracket | String | True | User age brackets. | ||
UserGender | String | True | User gender. | ||
Region | String | True | Geographic region from which activity originated. | ||
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EngagedSessionsPerUser | Decimal | False | True | Average number of engaged sessions per user. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
StartDate | String | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |||
EndDate | String | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item brand data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemBrandReport WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemBrandReport WHERE ItemBrand = 'test' SELECT * FROM EcommPurchasesItemBrandReport WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemBrandReport WHERE PropertyId = 342020667 AND ItemBrand = 'test' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemBrandReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemBrandReport WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemBrandReport WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemBrandReport WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemBrandReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemBrand | String | True | True | Brand name of the item. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemsViewed | Integer | False | True | The number of units viewed for a single item. This metric counts the quantity of items in 'view_item' events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item category data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemCategory2Report WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemCategory2Report WHERE ItemCategory2 = 'Apparel' SELECT * FROM EcommPurchasesItemCategory2Report WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategory2Report WHERE PropertyId = 342020667 AND ItemCategory2 = 'Apparel' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategory2Report WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemCategory2Report WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemCategory2Report WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemCategory2Report WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemCategory2Report WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemCategory2 | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Mens is the item category2 | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemsViewed | Integer | False | True | The number of units viewed for a single item. This metric counts the quantity of items in 'view_item' events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item category data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemCategory3Report WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemCategory3Report WHERE ItemCategory3 = 'Apparel' SELECT * FROM EcommPurchasesItemCategory3Report WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategory3Report WHERE PropertyId = 342020667 AND ItemCategory3 = 'Apparel' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategory3Report WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemCategory3Report WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemCategory3Report WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemCategory3Report WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemCategory3Report WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemCategory3 | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Summer is the item category3. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemsViewed | Integer | False | True | The number of units viewed for a single item. This metric counts the quantity of items in 'view_item' events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item category data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemCategory4Report WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemCategory4Report WHERE ItemCategory4 = 'Apparel' SELECT * FROM EcommPurchasesItemCategory4Report WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategory4Report WHERE PropertyId = 342020667 AND ItemCategory4 = 'Apparel' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategory4Report WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemCategory4Report WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemCategory4Report WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemCategory4Report WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemCategory4Report WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemCategory4 | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Shirts is the item category4. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemsViewed | Integer | False | True | The number of units viewed for a single item. This metric counts the quantity of items in 'view_item' events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item category data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemCategory5Report WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemCategory5Report WHERE ItemCategory4 = 'Apparel' SELECT * FROM EcommPurchasesItemCategory5Report WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategory5Report WHERE PropertyId = 342020667 AND ItemCategory5 = 'Apparel' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategory5Report WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemCategory5Report WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemCategory5Report WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemCategory5Report WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemCategory5Report WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemCategory5 | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, T-shirts is the item category5. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemsViewed | Integer | False | True | The number of units viewed for a single item. This metric counts the quantity of items in 'view_item' events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item category data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemCategoryReport WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemCategoryReport WHERE ItemCategory = 'Apparel' SELECT * FROM EcommPurchasesItemCategoryReport WHERE PropertyId = 342020667 AND ItemCategory = 'Apparel' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategoryReport WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategoryReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemCategoryReport WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemCategoryReport WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemCategoryReport WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemCategoryReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemCategory | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Apparel is the item category. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemsViewed | Integer | False | True | The number of units viewed for a single item. This metric counts the quantity of items in 'view_item' events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item category data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE ItemCategory = 'Apparel' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE ItemCategory2 = 'Mens' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE ItemCategory3 = 'Summer' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE ItemCategory4 = 'Shirts' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE ItemCategory5 = 'T-shirts' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE PropertyId = 342020667 AND ItemCategory = 'Apparel' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemCategoryReportCombined WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemCategory | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Apparel is the item category. | |
ItemCategory2 | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Mens is the item category2 | |
ItemCategory3 | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Summer is the item category3. | |
ItemCategory4 | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Shirts is the item category4. | |
ItemCategory5 | String | True | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, T-shirts is the item category5. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemsViewed | Integer | False | True | The number of units viewed for a single item. This metric counts the quantity of items in 'view_item' events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemIdReport WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemIdReport WHERE ItemId = '1234' SELECT * FROM EcommPurchasesItemIdReport WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemIdReport WHERE PropertyId = 342020667 AND ItemId = '1234' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemIdReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemIdReport WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemIdReport WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemIdReport WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemIdReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemId | String | True | True | ID of the item. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Ecommerce purchase item data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EcommPurchasesItemNameReport WHERE PropertyId = 342020667 SELECT * FROM EcommPurchasesItemNameReport WHERE ItemName = 'test' SELECT * FROM EcommPurchasesItemNameReport WHERE Date = '01/05/2023' SELECT * FROM EcommPurchasesItemNameReport WHERE PropertyId = 342020667 AND ItemName = 'test' AND Date = '01/05/2023' SELECT * FROM EcommPurchasesItemNameReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EcommPurchasesItemNameReport WHERE Date >= '01/01/2022' SELECT * FROM EcommPurchasesItemNameReport WHERE Date <= '01/01/2022' SELECT * FROM EcommPurchasesItemNameReport WHERE Date > '01/01/2022' SELECT * FROM EcommPurchasesItemNameReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ItemName | String | True | True | The name of the item. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemsPurchased | Integer | False | True | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A base view that retrieves Engagement data
Retrieves data for Engagement report. At least one metric must be specified in the query. In the query you can also specify up to 9 dimensions.
The following are example queries:
SELECT NewUsers, TotalRevenue FROM Engagement
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Date | Date | True | The date of the session formatted as YYYYMMDD | ||
Year | Integer | True | The year of the session. A four-digit year from 2005 to the current year. | ||
Month | Integer | True | The month of the session. A two digit integer from 01 to 12. | ||
Week | Integer | True | The week of the session. A two-digit number from 01 to 53. Each week starts on Sunday. | ||
Day | Integer | True | The day of the month. A two-digit number from 01 to 31. | ||
DayOfWeekName | String | True | The day of the week in English. This dimension has values of Sunday, Monday, etc. | ||
IsoWeek | Integer | True | ISO week number, where each week starts on Monday. For details, see http://en.wikipedia.org/wiki/ISO_week_date. Example values include 01, 02, 53. | ||
IsoYear | Integer | True | The ISO year of the event. For details, see http://en.wikipedia.org/wiki/ISO_week_date. Example values include 2022 2023. | ||
IsoYearIsoWeek | Integer | True | The combined values of isoWeek and isoYear. Example values include 201652 and 201701. | ||
YearMonth | Integer | True | The combined values of year and month. Example values include 202212 or 202301. | ||
YearWeek | Integer | True | The combined values of year and week. Example values include 202253 or 202301. | ||
Hour | Integer | True | A two-digit hour of the day ranging from 00-23 in the timezone configured for the account. This value is also corrected for daylight savings time. | ||
ContentGroup | String | True | A category that applies to items of published content | ||
EventName | String | True | The name of the event | ||
UnifiedPageScreen | String | True | The page path (web) or screen class (app) on which the event was logged | ||
UnifiedScreenClass | String | True | True | The page title (web) or screen class (app) on which the event was logged | |
UnifiedScreenName | String | True | The page title (web) or screen name (app) on which the event was logged | ||
PagePath | String | True | The portion of the URL between the hostname and query string for web | ||
PageTitle | String | True | The web page titles used on your site | ||
Conversions | Decimal | False | True | The count of conversion events | |
EngagedSessionsPerUser | Decimal | False | True | Average number of engaged sessions per user | |
EventCount | Integer | False | True | The count of events | |
EventCountPerUser | Decimal | False | True | Average number of events triggered by each user | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time | |
ScreenPageViews | Integer | False | True | The number of app screens or web pages the users viewed. Repeated views of a single page or screen are counted. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising | |
TotalUsers | Integer | False | True | The number of distinct users who visited the site or app | |
userEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users' device | |
ViewsPerUser | Decimal | False | True | Average number of screens viewed by each user | |
SessionsPerUser | Decimal | False | False | The average number of sessions per user (Sessions divided by Active Users). | |
StartDate | String | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |||
EndDate | String | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table |
A predefined view that retrieves Engagement Content Group Report data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EngagementContentGroupReport WHERE PropertyId = 342020667 SELECT * FROM EngagementContentGroupReport WHERE ContentGroup = 'CData Test' SELECT * FROM EngagementContentGroupReport WHERE Date = '01/05/2023' SELECT * FROM EngagementContentGroupReport WHERE PropertyId = 342020667 AND ContentGroup = 'CData Test' AND Date = '01/05/2023' SELECT * FROM EngagementContentGroupReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EngagementContentGroupReport WHERE Date >= '01/01/2022' SELECT * FROM EngagementContentGroupReport WHERE Date <= '01/01/2022' SELECT * FROM EngagementContentGroupReport WHERE Date > '01/01/2022' SELECT * FROM EngagementContentGroupReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ContentGroup | String | True | True | A category that applies to items of published content. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
ScreenPageViews | Integer | False | True | The number of app screens or web pages the users viewed. Repeated views of a single page or screen are counted. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The number of distinct users who visited the site or app. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users device. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Engagement conversions data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EngagementConversionsReport WHERE PropertyId = 342020667 SELECT * FROM EngagementConversionsReport WHERE EventName = 'page_view' SELECT * FROM EngagementConversionsReport WHERE Date = '01/05/2023' SELECT * FROM EngagementConversionsReport WHERE PropertyId = 342020667 AND EventName = 'page_view' AND Date = '01/05/2023' SELECT * FROM EngagementConversionsReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EngagementConversionsReport WHERE Date >= '01/01/2022' SELECT * FROM EngagementConversionsReport WHERE Date <= '01/01/2022' SELECT * FROM EngagementConversionsReport WHERE Date > '01/01/2022' SELECT * FROM EngagementConversionsReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
EventName | String | True | True | The name of the event. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EventCountPerUser | Decimal | False | True | Average number of events triggered by each user. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The number of distinct users who visited the site or app. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Engagement events data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EngagementEventsReport WHERE PropertyId = 342020667 SELECT * FROM EngagementEventsReport WHERE EventName = 'page_view' SELECT * FROM EngagementEventsReport WHERE Date = '01/05/2023' SELECT * FROM EngagementEventsReport WHERE PropertyId = 342020667 AND EventName = 'page_view' AND Date = '01/05/2023' SELECT * FROM EngagementEventsReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EngagementEventsReport WHERE Date >= '01/01/2022' SELECT * FROM EngagementEventsReport WHERE Date <= '01/01/2022' SELECT * FROM EngagementEventsReport WHERE Date > '01/01/2022' SELECT * FROM EngagementEventsReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
EventName | String | True | True | The name of the event. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
EventCountPerUser | Decimal | False | True | Average number of events triggered by each user. | |
EventCount | Integer | False | True | The count of events. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The number of distinct users who visited the site or app. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | The Property Id value to be used when querying this table. |
A predefined view that retrieves Engagement Pages path report data.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
PagePath | String | True | True | The portion of the URL between the hostname and query string for web. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
ScreenPageViews | Integer | False | True | The number of app screens or web pages the users viewed. Repeated views of a single page or screen are counted. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The number of distinct users who visited the site or app. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users device. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Engagement Pages title and screen class data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE PropertyId = 342020667 SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE UnifiedScreenClass = 'CData Test' SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE Date = '01/05/2023' SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE PropertyId = 342020667 AND UnifiedScreenClass = 'CData Test' AND Date = '01/05/2023' SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE Date >= '01/01/2022' SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE Date <= '01/01/2022' SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE Date > '01/01/2022' SELECT * FROM EngagementPagesTitleAndScreenClassReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
UnifiedScreenClass | String | True | True | The page title (web) or screen class (app) on which the event was logged. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
ScreenPageViews | Integer | False | True | The number of app screens or web pages the users viewed. Repeated views of a single page or screen are counted. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The number of distinct users who visited the site or app. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users device. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Engagement Pages Title And ScreenName data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE PropertyId = 342020667 SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE UnifiedScreenName = 'CData Test' SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE Date = '01/05/2023' SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE PropertyId = 342020667 AND UnifiedScreenName = 'CData Test' AND Date = '01/05/2023' SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE Date >= '01/01/2022' SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE Date <= '01/01/2022' SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE Date > '01/01/2022' SELECT * FROM EngagementPagesTitleAndScreenNameReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
UnifiedScreenName | String | True | True | The page title (web) or screen name (app) on which the event was logged. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
ScreenPageViews | Integer | False | True | The number of app screens or web pages the users viewed. Repeated views of a single page or screen are counted. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The number of distinct users who visited the site or app. | |
UserEngagementDuration | Bigint | False | True | The total amount of time (in seconds) the website or app was in the foreground of users device. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A base view that retrieves Event data
Retrieves data for Events reports. At least one metric must be specified in the query. This endpoint uses the real-time report API endpoint to get more up-to-date data than the standard reporting endpoint. The real-time reporting API supports a maximum of four dimensions compared to nine for the standard report API.
The following is an example query:
SELECT EventCount, Platform FROM Events
Since PagePath and PlatTitle dimensions are not available in the runRealReport endpoint, use the connection property ReportType = reports to leverage the result with these dimensions.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
AppVersion | String | True | The application's versionName (Android) or short bundle version (iOS) | ||
City | String | True | The city from which the user activity originated | ||
Country | String | True | The country from which the user activity originated | ||
DeviceCategory | String | True | The type of device: Desktop, Tablet, or Mobile | ||
Platform | String | True | The platform on which your app or website ran | ||
AudienceName | String | True | The given name of an Audience | ||
UnifiedScreenName | String | True | The page title (web) or screen name (app) on which the event was logged | ||
EventName | String | True | True | The name of the event | |
PagePath | String | True | The portion of the URL between the hostname and query string for web. This works when connection property ReportType=reports;. | ||
PageTitle | String | True | The web page titles used on your site. This works when connection property ReportType=reports; | ||
EventCount | Integer | False | True | Number of times an individual event was triggered | |
Conversions | Decimal | False | True | The count of conversion events | |
AudienceId | Long | True | The numeric identifier of an Audience. | ||
AudienceResourceName | String | True | The resource name of this audience. | ||
CityId | Integer | True | The geographic ID of the city from which the user activity originated, derived from their IP address. | ||
CountryId | String | True | The geographic ID of the country from which the user activity originated, derived from their IP address. | ||
MinutesAgo | Integer | True | The number of minutes ago that an event was collected. 00 is the current minute, and 01 means the previous minute. | ||
StreamId | Long | True | The numeric data stream identifier for your app or website. | ||
StreamName | String | True | The data stream name for your app or website. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table |
A base view that retrieves Games Reporting data.
Retrieves data for GamesReporting report. At least one metric must be specified in the query. In the query you can also specify up to 9 dimensions.
The following is an example query:
SELECT AveragePurchaseRevenue, AverageRevenuePerUser FROM GamesReporting
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Date | Date | True | The date of the session formatted as YYYYMMDD. | ||
Year | Integer | True | The year of the session. A four-digit year from 2005 to the current year. | ||
Month | Integer | True | The month of the session. A two digit integer from 01 to 12. | ||
Week | Integer | True | The week of the session. A two-digit number from 01 to 53. Each week starts on Sunday. | ||
Day | Integer | True | The day of the month. A two-digit number from 01 to 31. | ||
DayOfWeekName | String | True | The day of the week in English. This dimension has values of Sunday, Monday, etc. | ||
IsoWeek | Integer | True | ISO week number, where each week starts on Monday. Example values include 01, 02, 53. | ||
IsoYear | Integer | True | The ISO year of the event. Example values include 2022 2023. | ||
IsoYearIsoWeek | Integer | True | The combined values of isoWeek and isoYear. Example values include 201652 and 201701. | ||
YearMonth | Integer | True | The combined values of year and month. Example values include 202212 or 202301. | ||
YearWeek | Integer | True | The combined values of year and week. Example values include 202253 or 202301. | ||
Hour | Integer | True | A two-digit hour of the day ranging from 00-23 in the timezone configured for the account. This value is also corrected for daylight savings time. | ||
AudienceName | String | True | The given name of an Audience. | ||
FirstUserCampaignName | String | True | Name of the marketing campaign that first acquired the user. | ||
FirstUserGoogleAdsCreativeId | String | True | The campaign creative ID that first acquired the user. | ||
FirstUserGoogleAdsAdGroupId | String | True | The Ad Group Id in Google Ads that first acquired the user. | ||
FirstUserGoogleAdsAdGroupName | String | True | The Ad Group Name in Google Ads that first acquired the user. | ||
FirstUserGoogleAdsAdNetworkType | String | True | The advertising network that first acquired the user. | ||
FirstUserMedium | String | True | True | The medium that first acquired the user to the website or app. | |
FirstUserSource | String | True | The source that first acquired the user to the website or app. | ||
AveragePurchaseRevenue | Decimal | False | True | The average purchase revenue in the transaction group of events. | |
AveragePurchaseRevenuePerPayingUser | Decimal | False | True | Average revenue per paying user (ARPPU) is the total purchase revenue per active user that logged a purchase event. The summary metric is for the time period selected. | |
AverageRevenuePerUser | Decimal | False | True | Average revenue per active user (ARPU). The summary metric is for the time period selected. | |
EngagedSessionsPerUser | Decimal | False | True | Average number of engaged sessions per user. | |
FirstTimeBuyersPerNewUsers | Decimal | False | True | Percentage of unique new users to the game who made their first in-app purchase. | |
FirstTimePurchasers | Integer | False | True | The number of users that completed their first purchase event. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
StartDate | String | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |||
EndDate | String | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
Retrieves data for all the available dimensions and metrics.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
achievementId | String | True | The achievement Id in a game for an event. Populated by the event parameter achievementid. | ||
adFormat | String | True | Describes the way ads looked and where they were located. Typical formats include Interstitial, Banner, Rewarded, and Native advanced. | ||
adSourceName | String | True | The source network that served the ad. Typical sources include AdMob Network, Liftoff, Facebook Audience Network, and Mediated house ads. | ||
adUnitName | String | True | The name you chose to describe this Ad unit. Ad units are containers you place in your apps to show ads to users. | ||
appVersion | String | True | The apps versionName (Android) or short bundle version (iOS). | ||
audienceId | String | True | The numeric identifier of an Audience. Users are reported in the audiences to which they belonged during the reports date range. Current user behavior does not affect historical audience membership in reports. | ||
audienceName | String | True | The given name of an Audience. Users are reported in the audiences to which they belonged during the report's date range. Current user behavior does not affect historical audience membership in reports. | ||
brandingInterest | String | True | Interests demonstrated by users who are higher in the shopping funnel. Users can be counted in multiple interest categories. | ||
browser | String | True | The browsers used to view your website. | ||
campaignId | String | True | The identifier of the marketing campaign. Present only for conversion events. Includes Google Ads Campaigns, Manual Campaigns, and other Campaigns. | ||
campaignName | String | True | The name of the marketing campaign. Present only for conversion events. Includes Google Ads Campaigns, Manual Campaigns, and other Campaigns. | ||
character | String | True | The player character in a game for an event. Populated by the event parameter character. | ||
city | String | True | The city from which the user activity originated. | ||
cityId | String | True | The geographic Id of the city from which the user activity originated, derived from their IP address. | ||
cohort | String | True | The cohorts name in the request. A cohort is a set of users who started using your website or app in any consecutive group of days. If a cohort name is not specified in the request, cohorts are named by their zero based index: cohort_0, cohort_1, etc. | ||
cohortNthDay | String | True | Day offset relative to the firstSessionDate for the users in the cohort. For example, if a cohort is selected with the start and end date of 2020-03-01, then for the date 2020-03-02, cohortNthDay is 0001. | ||
cohortNthMonth | String | True | Month offset relative to the firstSessionDate for the users in the cohort. Month boundaries align with calendar month boundaries. For example, if a cohort is selected with the start and end date in March 2020, then for any date in April 2020, cohortNthMonth is 0001. | ||
cohortNthWeek | String | True | Week offset relative to the firstSessionDate for the users in the cohort. Weeks start on Sunday and end on Saturday. For example, if a cohort is selected with the start and end date in the range 2020-11-08 to 2020-11-14, then for the dates in the range 2020-11-15 to 2020-11-21, cohortNthWeek is 0001. | ||
contentGroup | String | True | A category that applies to items of published content. Populated by the event parameter content_group. | ||
contentId | String | True | The identifier of the selected content. Populated by the event parameter content_id. | ||
contentType | String | True | The category of the selected content. Populated by the event parameter content_type. | ||
continent | String | True | The continent from which the user activity originated. For example, Americas or Asia. | ||
continentId | String | True | The geographic Id of the continent from which the user activity originated, derived from their IP address. | ||
country | String | True | The country from which the user activity originated. | ||
countryId | String | True | The geographic Id of the country from which the user activity originated, derived from their IP address. Formatted according to ISO 3166-1 alpha-2 standard. | ||
date | String | True | The date of the event, formatted as YYYYMMDD. | ||
dateHour | String | True | The combined values of date and hour formatted as YYYYMMDDHH. | ||
dateHourMinute | String | True | The combined values of date, hour, and minute formatted as YYYYMMDDHHMM. | ||
day | String | True | The day of the month, a two-digit number from 01 to 31. | ||
dayOfWeek | String | True | The integer day of the week. It returns values in the range [0,6] with Sunday as the first day of the week. | ||
dayOfWeekName | String | True | The day of the week in English. This dimension has values of Sunday, Monday, etc. | ||
defaultChannelGroup | String | True | The conversion's default channel group is based primarily on source and medium. | ||
deviceCategory | String | True | The type of device: Desktop, Tablet, or Mobile. | ||
deviceModel | String | True | The mobile device model (example: iPhone 10,6). | ||
eventName | String | True | The name of the event. | ||
fileExtension | String | True | The extension of the downloaded file (for example, pdf or txt). Automatically populated if Enhanced Measurement is enabled . | ||
fileName | String | True | The page path of the downloaded file . Automatically populated if Enhanced Measurement is enabled. | ||
firstSessionDate | String | True | The date the user's first session occurred, formatted as YYYYMMDD. | ||
firstUserCampaignId | String | True | Identifier of the marketing campaign that first acquired the user. Includes Google Ads Campaigns, Manual Campaigns, and other Campaigns. | ||
firstUserCampaignName | String | True | Name of the marketing campaign that first acquired the user. Includes Google Ads Campaigns, Manual Campaigns, and other Campaigns. | ||
firstUserDefaultChannelGroup | String | True | The default channel group that first acquired the user. Default channel group is based primarily on source and medium. | ||
firstUserGoogleAdsAccountName | String | True | The Account name from Google Ads that first acquired the user. | ||
firstUserGoogleAdsAdGroupId | String | True | The Ad Group Id in Google Ads that first acquired the user. | ||
firstUserGoogleAdsAdGroupName | String | True | The Ad Group Name in Google Ads that first acquired the user. | ||
firstUserGoogleAdsAdNetworkType | String | True | The advertising network that first acquired the user. | ||
firstUserGoogleAdsCampaignId | String | True | Identifier of the Google Ads marketing campaign that first acquired the user. | ||
firstUserGoogleAdsCampaignName | String | True | Name of the Google Ads marketing campaign that first acquired the user. | ||
firstUserGoogleAdsCampaignType | String | True | The campaign type of the Google Ads campaign that first acquired the user. Campaign types determine where customers see your ads and the settings and options available to you in Google Ads. Campaign type is an enumeration that includes: Search, Display, Shopping, Video, Discovery, App, Smart, Hotel, Local, and Performance Max. | ||
firstUserGoogleAdsCreativeId | String | True | The Id of the Google Ads creative that first acquired the user. Creative IDs identify individual ads. | ||
firstUserGoogleAdsCustomerId | String | True | The Customer Id from Google Ads that first acquired the user. Customer IDs in Google Ads uniquely identify Google Ads accounts. | ||
firstUserGoogleAdsKeyword | String | True | The matched keyword that first acquired the user. Keywords are words or phrases describing your product or service that you choose to get your ad in front of the right customers. | ||
firstUserGoogleAdsQuery | String | True | The search query that first acquired the user. | ||
firstUserManualAdContent | String | True | The ad content that first acquired the user. Populated by the utm_content parameter. | ||
firstUserManualTerm | String | True | The term that first acquired the user. Populated by the utm_term parameter. | ||
firstUserMedium | String | True | The medium that first acquired the user to your website or app. | ||
firstUserSource | String | True | The source that first acquired the user to your website or app. | ||
firstUserSourceMedium | String | True | The combined values of the dimensions firstUserSource and firstUserMedium. | ||
firstUserSourcePlatform | String | True | The source platform that first acquired the user. Please do not depend on this field returning Manual for traffic that uses UTMs; this field will update from returning Manual to returning (not set) for an upcoming feature launch. | ||
fullPageUrl | String | True | The hostname, page path, and query string for web pages visited | ||
googleAdsAccountName | String | True | The Account name from Google Ads for the campaign that led to the conversion event. Corresponds to customer.descriptive_name in the Google Ads API. | ||
googleAdsAdGroupId | String | True | The ad group id attributed to the conversion event. | ||
googleAdsAdGroupName | String | True | The ad group name attributed to the conversion event. | ||
googleAdsAdNetworkType | String | True | The advertising network type of the conversion. | ||
googleAdsCampaignId | String | True | The campaign Id for the Google Ads campaign attributed to the conversion event. | ||
googleAdsCampaignName | String | True | The campaign name for the Google Ads campaign attributed to the conversion event. | ||
googleAdsCampaignType | String | True | The campaign type for the Google Ads campaign attributed to the conversion event. Campaign types determine where customers see your ads and the settings and options available to you in Google Ads. Campaign type is an enumeration that includes: Search, Display, Shopping, Video, Discovery, App, Smart, Hotel, Local, and Performance Max. | ||
googleAdsCreativeId | String | True | The Id of the Google Ads creative attributed to the conversion event. Creative IDs identify individual ads. | ||
googleAdsCustomerId | String | True | The Customer Id from Google Ads for the campaign that led to conversion event. Customer IDs in Google Ads uniquely identify Google Ads accounts. | ||
googleAdsKeyword | String | True | The matched keyword that led to the conversion event. Keywords are words or phrases describing your product or service that you choose to get your ad in front of the right customers. | ||
googleAdsQuery | String | True | The search query that led to the conversion event. | ||
groupId | String | True | The player group Id in a game for an event. Populated by the event parameter group_id. | ||
hostName | String | True | Includes the subdomain and domain names of a URL; for example, the Host Name of www.example.com/contact.html is www.example.com. | ||
hour | String | True | The two-digit hour of the day that the event was logged. This dimension ranges from 0-23 and is reported in your property's timezone. | ||
isConversionEvent | String | True | The string 'true' if the event is a conversion. Events are marked as conversions at collection time; changes to an event's conversion marking apply going forward. You can mark any event as a conversion in Google Analytics, and some events (i.e. first_open, purchase) are marked as conversions by default. | ||
isoWeek | String | True | ISO week number, where each week starts on Monday. Example values include 01, 02, and 53. | ||
isoYear | String | True | The ISO year of the event. Example values include 2022 and 2023. | ||
isoYearIsoWeek | String | True | The combined values of isoWeek and isoYear. Example values include 201652 and 201701. | ||
itemAffiliation | String | True | The name or code of the affiliate (partner/vendor if any) associated with an individual item. Populated by the 'affiliation' item parameter. | ||
itemBrand | String | True | Brand name of the item. | ||
itemCategory | String | True | The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Apparel is the item category. | ||
itemCategory2 | String | True | The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Mens is the item category 2. | ||
itemCategory3 | String | True | The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Summer is the item category 3. | ||
itemCategory4 | String | True | The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Shirts is the item category 4. | ||
itemCategory5 | String | True | The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, T-shirts is the item category 5. | ||
itemId | String | True | The Id of the item. | ||
itemListId | String | True | The Id of the item list. | ||
itemListName | String | True | The name of the item list. | ||
itemListPosition | String | True | The position of an item (e.g., a product you sell) in a list. This dimension is populated in tagging by the index parameter in the items array. | ||
itemLocationID | String | True | The physical location associated with the item (e.g. the physical store location). It is recommended to use the [Google Place ID] that corresponds to the associated item. A custom location Id can also be used. This field is populated in tagging by the location_id parameter in the items array. | ||
itemName | String | True | The name of the item. | ||
itemPromotionCreativeName | String | True | The name of the item-promotion creative. | ||
itemPromotionCreativeSlot | String | True | The name of the promotional creative slot associated with the item. This dimension can be specified in tagging by the creative_slot parameter at the event or item level. If the parameter is specified at both the event and item level, the item-level parameter is used. | ||
itemPromotionId | String | True | The Id of the item promotion. | ||
itemPromotionName | String | True | The name of the promotion for the item. | ||
itemVariant | String | True | The specific variation of a product. e.g., XS, S, M, L for size; or Red, Blue, Green, Black for color. Populated by the item_variant parameter. | ||
landingPage | String | True | The page path associated with the first pageview in a session. | ||
landingPagePlusQueryString | String | True | The page path + query string associated with the first pageview in a session. | ||
language | String | True | The language setting of the user's browser or device. e.g. English | ||
languageCode | String | True | The language setting (ISO 639) of the user's browser or device. e.g. en-us | ||
level | String | True | The players level in a game. Populated by the event parameter level. | ||
linkClasses | String | True | The HTML class attribute for an outbound link | ||
StartDate | String | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |||
EndDate | String | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
A base view that retrieves KeyEvents data
Retrieves data for KeyEvents reports. At least one metric must be specified in the query. This endpoint uses the real-time report API endpoint to get more up-to-date data than the standard reporting endpoint. The real-time reporting API supports a maximum of four dimensions compared to nine for the standard report API.
The following is an example query:
SELECT KeyEvents, EventName FROM KeyEvents;
Since PagePath and PlatTitle dimensions are not available in the runRealReport endpoint, use the connection property ReportType = reports to leverage the result with these dimensions.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
AppVersion | String | True | The application's versionName (Android) or short bundle version (iOS) | ||
City | String | True | The city from which the user activity originated | ||
Country | String | True | The country from which the user activity originated | ||
DeviceCategory | String | True | The type of device: Desktop, Tablet, or Mobile | ||
Platform | String | True | The platform on which your app or website ran | ||
AudienceName | String | True | The given name of an Audience | ||
UnifiedScreenName | String | True | The page title (web) or screen name (app) on which the event was logged | ||
EventName | String | True | True | The name of the event | |
PagePath | String | True | The portion of the URL between the hostname and query string for web. This works when connection property ReportType=reports;. | ||
PageTitle | String | True | The web page titles used on your site. This works when connection property ReportType=reports; | ||
AudienceId | Long | True | The numeric identifier of an Audience. | ||
AudienceResourceName | String | True | The resource name of this audience. | ||
CityId | Integer | True | The geographic ID of the city from which the user activity originated, derived from their IP address. | ||
CountryId | String | True | The geographic ID of the country from which the user activity originated, derived from their IP address. | ||
MinutesAgo | Integer | True | The number of minutes ago that an event was collected. 00 is the current minute, and 01 means the previous minute. | ||
StreamId | Long | True | The numeric data stream identifier for your app or website. | ||
StreamName | String | True | The data stream name for your app or website. | ||
KeyEvents | String | False | True | The count of key events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table |
Retrieves metadata information for standard and custom dimensions / metrics.
Retrieves metadata information for standard and custom dimensions / metrics. If PropertyID connection property not set, dimensions and metrics common to all properties will be retrieved.
The following is an example query:
SELECT * FROM Metadata
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ApiName | String | The API name for the dimension / metric. | |||
CustomDefinition | Boolean | Whether the dimension / metric is custom or not. | |||
Description | String | Description of how the dimension / metric is used and calculated. | |||
Type | String | Datatype of the dimension / metric. | |||
FieldType | String | Whether the field is a dimension or metric. | |||
UIName | String | The dimension / metric name within the Google Analytics user interface. | |||
DimensionDeprecatedAPINames | String | Returns the list of depricated names for this dimension but still usable. | |||
MetricDeprecatedAPINames | String | Returns the list of depricated names for this metric but still usable. | |||
Expressions | String | The mathematical expression for this derived metric. | |||
BlockedReasons | String | Return the reasons why access to this metric is blocked for this property. | |||
Category | String | The display name of the category that this dimension / metric belongs to. |
A base view that retrieves Monetization data.
Retrieves data for Monetization report. At least one metric must be specified in the query. In the query you can also specify up to nine dimensions.
The following is an example query:
SELECT ItemsAddedToCart, CartToViewRate FROM Monetization
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Date | Date | True | The date of the session formatted as YYYYMMDD. | ||
Year | Integer | True | The year of the session. A four-digit year from 2005 to the current year. | ||
Month | Integer | True | The month of the session. An integer from 01 to 12. | ||
Week | Integer | True | The week of the session. A number from 01 to 53. Each week starts on Sunday. | ||
Day | Integer | True | The day of the month. A number from 01 to 31. | ||
DayOfWeekName | String | True | The day of the week in English. This dimension has values of Sunday, Monday, etc. | ||
IsoWeek | Integer | True | ISO week number, where each week starts on Monday. Example values include 01, 02, 53. | ||
IsoYear | Integer | True | The ISO year of the event. Example values include 2022 2023. | ||
IsoYearIsoWeek | Integer | True | The combined values of isoWeek and isoYear. Example values include 201652 and 201701. | ||
YearMonth | Integer | True | The combined values of year and month. Example values include 202212 or 202301. | ||
YearWeek | Integer | True | The combined values of year and week. Example values include 202253 or 202301. | ||
Hour | Integer | True | An hour of the day ranging from 00-23 in the timezone configured for the account. This value is also corrected for daylight savings time. | ||
Country | String | True | The country of users, derived from IP addresses. | ||
City | String | True | The cities of property users, derived from IP addresses. | ||
AdFormat | String | True | Format of the ad(e.g., text, image, video). | ||
AdSourceName | String | True | Demand source that provided the ad. | ||
AdUnitName | String | True | Space on the website or app that displayed the ad. | ||
ItemBrand | String | True | Brand name of the item. | ||
ItemCategory | String | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Apparel is the item category. | ||
ItemCategory2 | String | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Mens is the item category2 | ||
ItemCategory3 | String | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Summer is the item category3. | ||
ItemCategory4 | String | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Shirts is the item category4. | ||
ItemCategory5 | String | True | Hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, T-shirts is the item category5. | ||
ItemId | String | True | ID of the item. | ||
ItemListId | String | True | The ID of the item list. | ||
ItemListName | String | True | The name of the item list. | ||
ItemName | String | True | True | The name of the item. | |
ItemPromotionCreativeName | String | True | The name of the item-promotion creative. | ||
ItemPromotionId | String | True | ID of the item promotion. | ||
ItemPromotionName | String | True | Name of the promotion for the item. | ||
OrderCoupon | String | True | Code for the order-level coupon. | ||
UnifiedPageScreen | String | True | The page path (web) or screen class (app) on which the event was logged. | ||
TransactionId | String | True | The ID of the ecommerce transaction. | ||
adUnitExposure | Integer | False | The amount of time the ad unit was exposed to the user. This metric is not compatible with item-scoped dimensions. | ||
ItemsAddedToCart | Integer | False | True | The number of times users added items to their shopping carts. Since AddToCarts is not compatible with item-scoped dimensions, hence this is the replacement of the AddToCarts metric. | |
CartToViewRate | Decimal | False | True | The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). | |
ItemsCheckedOut | Integer | False | True | Number of times users started the checkout process. Since Checkouts is not compatible with item-scoped dimensions, hence this is the replacement of the Checkouts metric. | |
EcommercePurchases | Integer | False | The number of times users completed a purchase. This metric is not compatible with item-scoped dimensions. | ||
EventCount | Integer | False | The count of events. This metric is not compatible with item-scoped dimensions. This metric is not compatible with item-scoped dimensions. | ||
FirstTimePurchasers | Integer | False | True | The number of users that completed their first purchase event. | |
ItemsClickedInList | Integer | False | True | The number of times users clicked an item when it appeared in a list. Since ItemListClicks is not compatible with item-scoped dimensions, hence this is the replacement of the ItemListClicks metric. | |
ItemListClickThroughRate | Decimal | False | True | Rate at which users clicked the item in an item list to view the item details. | |
ItemsViewedInList | Integer | False | True | The number of times the item list was viewed. Since ItemListViews is not compatible with item-scoped dimensions, hence this is the replacement of the ItemListViews metric. | |
PromotionClicks | Integer | False | The number of times an item promotion was clicked. ItemPromotionClicks metric has been renamed to this metric. | ||
ItemPromotionClickThroughRate | Decimal | False | The number of users who selected a promotion(s) divided by the number of users who viewed the same promotion(s). | ||
PromotionViews | Integer | False | The number of times an item promotion was viewed. ItemPromotionViews metric has been renamed to this metric. | ||
ItemsPurchased | Integer | False | The total amount of tax. ItemPurchaseQuantity metric has been renamed to this metric. | ||
ItemRevenue | Decimal | False | The total revenue from items only. Item revenue is the product of its price and quantity. | ||
ItemViewEvents | Integer | False | The number of times the item details were viewed. ItemViews metric has been renamed to this metric. | ||
PublisherAdClicks | Integer | False | The number of times an ad was clicked on the publisher's site. | ||
PublisherAdImpressions | Integer | False | The number of times an ad was displayed on the publisher's site. | ||
PurchaseToViewRate | Decimal | False | The total cost of shipping. | ||
TotalAdRevenue | Integer | False | Sum of all advertising revenue. | ||
StartDate | String | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |||
EndDate | String | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves publisher ads page ad format data.
n
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE PropertyId = 342020667 SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE AdFormat = 'image' SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE Date = '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE PropertyId = 342020667 AND AdFormat = 'image' AND Date = '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE Date >= '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE Date <= '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE Date > '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdFormatReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
AdFormat | String | True | True | Format of the ad(e.g., text, image, video). | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
PublisherAdImpressions | Integer | False | True | The number of times an ad was displayed on the publishers site. | |
adUnitExposure | Integer | False | True | The amount of time the ad unit was exposed to the user. | |
PublisherAdClicks | Integer | False | True | The number of times an ad was clicked on the publisherss site. | |
TotalAdRevenue | Integer | False | True | Sum of all advertising revenue. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | The Property Id value to be used when querying this table. |
A predefined view that retrieves publisher ads ad source data.
n
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE PropertyId = 342020667 SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE AdSourceName = 'test' SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE Date = '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE PropertyId = 342020667 AND AdSourceName = 'test' AND Date = '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE Date >= '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE Date <= '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE Date > '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdSourceReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
AdSourceName | String | True | True | Demand source that provided the ad. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
PublisherAdImpressions | Integer | False | True | The number of times an ad was displayed on the publishers site. | |
adUnitExposure | Integer | False | True | The amount of time the ad unit was exposed to the user. | |
PublisherAdClicks | Integer | False | True | The number of times an ad was clicked on the publishers site. | |
TotalAdRevenue | Integer | False | True | Sum of all advertising revenue. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | The Property Id value to be used when querying this table. |
A predefined view that retrieves publisher ads ad unit data.
n
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE PropertyId = 342020667 SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE AdUnitName = 'Test' SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE Date = '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE PropertyId = 342020667 AND AdUnitName = 'Test' AND Date = '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE Date >= '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE Date <= '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE Date > '01/01/2022' SELECT * FROM MonetizationPublisherAdsAdUnitReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
AdUnitName | String | True | True | Space on the website or app that displayed the ad. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
PublisherAdImpressions | Integer | False | True | The number of times an ad was displayed on the publishers site. | |
adUnitExposure | Integer | False | True | The amount of time the ad unit was exposed to the user. | |
PublisherAdClicks | Integer | False | True | The number of times an ad was clicked on the publishers site. | |
TotalAdRevenue | Integer | False | True | Sum of all advertising revenue. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | The Property Id value to be used when querying this table. |
A predefined view that retrieves publisher ads page path data.
n
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE PropertyId = 342020667 SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE PagePath = '/cdataH.test.io/' SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE Date = '01/05/2023' SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE PropertyId = 342020667 AND PagePath = '/cdataH.test.io/' AND Date = '01/05/2023' SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE Date >= '01/01/2022' SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE Date <= '01/01/2022' SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE Date > '01/01/2022' SELECT * FROM MonetizationPublisherAdsPagePathReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
PagePath | String | True | True | The portion of the URL between the hostname and query string for web. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
PublisherAdImpressions | Integer | False | True | The number of times an ad was displayed on the publishers site. | |
adUnitExposure | Integer | False | True | The amount of time the ad unit was exposed to the user. | |
PublisherAdClicks | Integer | False | True | The number of times an ad was clicked on the publishers site. | |
TotalAdRevenue | Integer | False | True | Sum of all advertising revenue. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | The Property Id value to be used when querying this table. |
Lists all Properties to which the user has access.
SELECT * FROM Properties WHERE Id = '54516992' SELECT * FROM Properties WHERE Parent = 'accounts/54516992'
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
CreateTime | Datetime | Time the property was created. | |||
CurrencyCode | String | The currency type used in reports involving monetary values. | |||
DisplayName | String | Display name for the property. | |||
IndustryCategory | String | Industry associated with the property. | |||
Id | Integer | Property Id. | |||
Parent | String | Name of the property's logical parent. | |||
TimeZone | String | Reporting Time Zone. | |||
UpdateTime | Datetime | Time the property was last modified. | |||
DeleteTime | Datetime | Time at which this property was trashed. |
Lists all access bindings on an account or property. Requires one of the following OAuth scopes: https://www.googleapis.com/auth/analytics.manage.users.readonly https://www.googleapis.com/auth/analytics.manage.users
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
SELECT * FROM PropertiesAccessBindings where parent ='properties/307712345'; SELECT * FROM PropertiesAccessBindings where name = 'properties/307712345/accessBindings/1234559643';The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Name [KEY] | String | Resource name of this binding. Format: accounts/{account}/accessBindings/{accessBinding} or properties/{property}/accessBindings/{accessBinding} | |||
Parent | String | Name of the Access Binding's logical parent. Format: accounts/{account} or properties/{property} | |||
User | String | The email address of the user to set roles for. | |||
Roles | String | A list of roles for to grant to the parent resource. | |||
PropertyId | Integer | Property ID value to be used when querying this table. |
Lists Audiences on a property.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
SELECT * FROM PropertiesAudiences where parent = 'properties/153123282' SELECT * FROM PropertiesAudiences where name = 'properties/211225502/audiences/2041236988'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Name [KEY] | String | The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId} | |||
Parent | String | Name of the Audiences's logical parent. | |||
PropertyId | Integer | Property ID value to be used when querying this table. | |||
DisplayName | String | The display name of the Audience. | |||
Description | String | The description of the Audience. | |||
MembershipDurationDays | Integer | The duration a user should stay in an Audience. It cannot be set to more than 540 days. | |||
AdsPersonalizationEnabled | Boolean | It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization. | |||
EventTrigger | String | Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience. | |||
ExclusionDurationMode | String | Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. | |||
FilterClauses | String | Filter clauses that define the Audience. All clauses will be AND’ed together. | |||
CreateTime | Datetime | Time when the Audience was created. |
Lists all data streams under a property to which the user has access. Attribute Parent (e.g: 'properties/123') or Name (e.g: 'properties/123/webDataStreams/456') is required to query the table.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
SELECT * FROM PropertiesDataStreams WHERE Parent = 'properties/123' SELECT * FROM PropertiesDataStreams WHERE Name = 'properties/123/webDataStreams/456'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
CreateTime | Datetime | Time the stream was created. | |||
DisplayName | String | Display name for the data stream. | |||
Name | String | Web data stream name. | |||
Parent | String | Name of the web data stream's logical parent. | |||
Type | String | Name of the web data stream's logical parent. | |||
webStreamData | String | Data specific to web streams. | |||
androidAppStreamData | String | Data specific to Android app streams. | |||
iosAppStreamData | String | Data specific to iOS app streams. | |||
UpdateTime | Datetime | Time the stream was last modified. | |||
PropertyId | Integer | The Property Id value to be used when querying this table. |
Lists all FirebaseLinks on a property to which the user has access.
Lists all FirebaseLinks on a property to which the user has access. The provider uses the GoogleAnalytics4 API to process WHERE clause conditions built with the Parent column and the = operator. Queries are processed server-side.
The following is an example query:
SELECT * FROM PropertiesFirebaseLinks WHERE Parent = 'properties/54516992'
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
CreateTime | Datetime | Time the FirebaseLink was created. | |||
MaximumUserAccess | String | Maximum user access to the property allowed to admins of the linked Firebase project. | |||
Name | String | FirebaseLink name. | |||
Parent | String | Name of the FirebaseLink's logical parent. | |||
Project | String | Firebase project resource name. | |||
PropertyId | Integer | The Property Id value to be used when querying this table. |
Lists all GoogleAdsLinks on a property to which the user has access.
Lists all GoogleAdsLinks on a property to which the user has access.
The provider will use the GoogleAnalytics4 API to process WHERE clause conditions built with the Parent column with the = operator.
Queries are processed server-side, and a value for the attribute Parent is required to query this table. The following is an example query:
SELECT * FROM PropertiesGoogleAdsLinks WHERE Parent = 'properties/54516992'The rest of the filter is executed client-side within the provider.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
CanManageClients | Boolean | Whether the link if for a Google Ads manager account. | |||
AdsPersonalizationEnabled | Boolean | Whether to enable personalized advertising. | |||
CreateTime | Datetime | Time the link was created. | |||
CustomerId | String | Google Ads customer ID. | |||
EmailAddress | String | Email address of the user that created the link. | |||
Name | String | GoogleAdsLinks name. | |||
Parent | String | Name of the GoogleAdsLink's logical parent. | |||
UpdateTime | Datetime | Time the link was last modified. | |||
PropertyId | Integer | The Property Id value to be used when querying this table. |
Returns a list of Key Events in the specified parent property.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
SELECT * FROM PropertiesKeyEvents where parent = 'properties/309787233' SELECT * FROM PropertiesKeyEvents where name = 'properties/309787233/keyEvents/7710067029'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Name [KEY] | String | Resource name of this key event. Format: properties/{property}/keyEvents/{keyEvent} | |||
Parent | String | Name of the Key Events's logical parent. | |||
PropertyId | Integer | Property ID value to be used when querying this table. | |||
EventName | String | The event name for this key event. Examples: 'click', 'purchase' | |||
CreateTime | Datetime | Time when this key event was created in the property. | |||
Deletable | Boolean | Whether this event can be deleted. | |||
Custom | Boolean | Whether this key event refers to a custom event. | |||
CountingMethod | String | The method by which Key Events will be counted across multiple events within a session. | |||
DefaultValue | String | Defines a default value/currency for a key event. |
A base view that retrieves ScreenPage data
Retrieves data for ScreenPageViews reports. At least one metric must be specified in the query. This endpoint uses the real-time report API endpoint to get more up-to-date data than the standard reporting endpoint. The real-time reporting API supports a maximum of four dimensions compared to nine for the standard report API.
The following is an example query:
SELECT ScreenPageViews, EventName FROM ScreenPageViews;
Since PagePath and PlatTitle dimensions are not available in the runRealReport endpoint, use the connection property ReportType = reports to leverage the result with these dimensions.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
AppVersion | String | True | The application's versionName (Android) or short bundle version (iOS) | ||
City | String | True | The city from which the user activity originated | ||
Country | String | True | The country from which the user activity originated | ||
DeviceCategory | String | True | The type of device: Desktop, Tablet, or Mobile | ||
Platform | String | True | The platform on which your app or website ran | ||
AudienceName | String | True | The given name of an Audience | ||
UnifiedScreenName | String | True | The page title (web) or screen name (app) on which the event was logged | ||
EventName | String | True | True | The name of the event | |
PagePath | String | True | The portion of the URL between the hostname and query string for web. This works when connection property ReportType=reports;. | ||
PageTitle | String | True | The web page titles used on your site. This works when connection property ReportType=reports; | ||
AudienceId | Long | True | The numeric identifier of an Audience. | ||
AudienceResourceName | String | True | The resource name of this audience. | ||
CityId | Integer | True | The geographic ID of the city from which the user activity originated, derived from their IP address. | ||
CountryId | String | True | The geographic ID of the country from which the user activity originated, derived from their IP address. | ||
MinutesAgo | Integer | True | The number of minutes ago that an event was collected. 00 is the current minute, and 01 means the previous minute. | ||
StreamId | Long | True | The numeric data stream identifier for your app or website. | ||
StreamName | String | True | The data stream name for your app or website. | ||
ScreenPageViews | String | False | True | The number of app screens or web pages your users viewed. Repeated views of a single page or screen are counted. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table |
A base view that retrieves Tech data.
Retrieves data for Tech report. At least one metric must be specified in the query. In the query you can also specify up to nine dimensions.
The following is an example query:
SELECT Conversions, EngagementRate, EventCount FROM Tech
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Date | Date | True | The date of the session formatted as YYYYMMDD. | ||
Year | Integer | True | The year of the session. A four-digit year from 2005 to the current year. | ||
Month | Integer | True | The month of the session. An integer from 01 to 12. | ||
Week | Integer | True | The week of the session. A number from 01 to 53. Each week starts on Sunday. | ||
Day | Integer | True | The day of the month. A number from 01 to 31. | ||
DayOfWeekName | String | True | The day of the week in English. This dimension has values of Sunday, Monday, etc. | ||
IsoWeek | Integer | True | ISO week number, where each week starts on Monday. Example values include 01, 02, 53. | ||
IsoYear | Integer | True | The ISO year of the event. Example values include 2022 2023. | ||
IsoYearIsoWeek | Integer | True | The combined values of isoWeek and isoYear. Example values include 201652 and 201701. | ||
YearMonth | Integer | True | The combined values of year and month. Example values include 202212 or 202301. | ||
YearWeek | Integer | True | The combined values of year and week. Example values include 202253 or 202301. | ||
Hour | Integer | True | An hour of the day ranging from 00-23 in the timezone configured for the account. This value is also corrected for daylight savings time. | ||
AppVersion | String | True | Version of the app. | ||
Browser | String | True | True | Browser used to engage with the site. | |
DeviceCategory | String | True | Type of device used to engage with the site/app: Desktop, Tablet, or Mobile. | ||
DeviceModel | String | True | Model of the device used to engage with the site/app. | ||
OperatingSystem | String | True | Operating systems used by visitors to the app or website. | ||
OperatingSystemVersion | String | True | Version of the operating systems used by visitors to the app or website. | ||
OperatingSystemWithVersion | String | True | Operating system name and version. | ||
Platform | String | True | Platform for the app or site (Android, iOS, Web). | ||
ScreenResolution | String | True | Resolution of the screen used to engage with the site/app. | ||
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. | |
StartDate | String | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |||
EndDate | String | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Tech App Version data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechAppVersionReport WHERE PropertyId = 342020667 SELECT * FROM TechAppVersionReport WHERE AppVersion = 'test' SELECT * FROM TechAppVersionReport WHERE Date = '01/05/2023' SELECT * FROM TechAppVersionReport WHERE PropertyId = 342020667 AND AppVersion = 'test' AND Date = '01/05/2023' SELECT * FROM TechAppVersionReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechAppVersionReport WHERE Date >= '01/01/2022' SELECT * FROM TechAppVersionReport WHERE Date <= '01/01/2022' SELECT * FROM TechAppVersionReport WHERE Date > '01/01/2022' SELECT * FROM TechAppVersionReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
AppVersion | String | True | True | Version of the app. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Tech Browser data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechBrowserReport WHERE PropertyId = 342020667 SELECT * FROM TechBrowserReport WHERE Browser = 'chrome' SELECT * FROM TechBrowserReport WHERE Date = '01/05/2023' SELECT * FROM TechBrowserReport WHERE PropertyId = 342020667 AND Browser = 'chrome' AND Date = '01/05/2023' SELECT * FROM TechBrowserReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechBrowserReport WHERE Date >= '01/01/2022' SELECT * FROM TechBrowserReport WHERE Date <= '01/01/2022' SELECT * FROM TechBrowserReport WHERE Date > '01/01/2022' SELECT * FROM TechBrowserReport WHERE Date < '01/01/2022'
The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Browser | String | True | True | Browser used to engage with the site. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Tech Device Category data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechDeviceCategoryReport WHERE PropertyId = 342020667 SELECT * FROM TechDeviceCategoryReport WHERE DeviceCategory = 'desktop' SELECT * FROM TechDeviceCategoryReport WHERE Date = '01/05/2023' SELECT * FROM TechDeviceCategoryReport WHERE PropertyId = 342020667 AND DeviceCategory = 'desktop' AND Date = '01/05/2023' SELECT * FROM TechDeviceCategoryReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechDeviceCategoryReport WHERE Date >= '01/01/2022' SELECT * FROM TechDeviceCategoryReport WHERE Date <= '01/01/2022' SELECT * FROM TechDeviceCategoryReport WHERE Date > '01/01/2022' SELECT * FROM TechDeviceCategoryReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
DeviceCategory | String | True | True | Type of device used to engage with the site/app: Desktop, Tablet, or Mobile. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Tech Device Model data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechDeviceModelReport WHERE PropertyId = 342020667 SELECT * FROM TechDeviceModelReport WHERE DeviceModel = 'test' SELECT * FROM TechDeviceModelReport WHERE Date = '01/01/2022' SELECT * FROM TechDeviceModelReport WHERE PropertyId = 342020667 AND DeviceModel = 'test' AND Date = '01/01/2022' SELECT * FROM TechDeviceModelReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechDeviceModelReport WHERE Date >= '01/01/2022' SELECT * FROM TechDeviceModelReport WHERE Date <= '01/01/2022' SELECT * FROM TechDeviceModelReport WHERE Date > '01/01/2022' SELECT * FROM TechDeviceModelReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
DeviceModel | String | True | True | Model of the device used to engage with the site/app. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Tech os system data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechOSSystemReport WHERE PropertyId = 342020667 SELECT * FROM TechOSSystemReport WHERE OperatingSystem = 'Windows' SELECT * FROM TechOSSystemReport WHERE Date = '01/05/2023' SELECT * FROM TechOSSystemReport WHERE PropertyId = 342020667 AND OperatingSystem = 'Windows' AND Date = '01/05/2023' SELECT * FROM TechOSSystemReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechOSSystemReport WHERE Date >= '01/01/2022' SELECT * FROM TechOSSystemReport WHERE Date <= '01/01/2022' SELECT * FROM TechOSSystemReport WHERE Date > '01/01/2022' SELECT * FROM TechOSSystemReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
OperatingSystem | String | True | True | Operating systems used by visitors to the app or website. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Tech Os version data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechOSVersionReport WHERE PropertyId = 342020667 SELECT * FROM TechOSVersionReport WHERE OperatingSystemVersion = '10' SELECT * FROM TechOSVersionReport WHERE Date = '01/01/2022' SELECT * FROM TechOSVersionReport WHERE PropertyId = 342020667 AND OperatingSystem = '10' AND Date = '01/01/2022' SELECT * FROM TechOSVersionReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechOSVersionReport WHERE Date >= '01/01/2022' SELECT * FROM TechOSVersionReport WHERE Date <= '01/01/2022' SELECT * FROM TechOSVersionReport WHERE Date > '01/01/2022' SELECT * FROM TechOSVersionReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
OperatingSystemVersion | String | True | True | Version of the operating systems used by visitors to the app or website. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Tech platform device category data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechPlatformDeviceCategoryReport WHERE PropertyId = 342020667 SELECT * FROM TechPlatformDeviceCategoryReport WHERE Platform = 'web' SELECT * FROM TechPlatformDeviceCategoryReport WHERE Date = '01/05/2023' SELECT * FROM TechPlatformDeviceCategoryReport WHERE PropertyId = 342020667 AND DeviceCategory = 'desktop' SELECT * FROM TechPlatformDeviceCategoryReport WHERE PropertyId = 342020667 AND Platform = 'web' SELECT * FROM TechPlatformDeviceCategoryReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechPlatformDeviceCategoryReport WHERE Date >= '01/01/2022' SELECT * FROM TechPlatformDeviceCategoryReport WHERE Date <= '01/01/2022' SELECT * FROM TechPlatformDeviceCategoryReport WHERE Date > '01/01/2022' SELECT * FROM TechPlatformDeviceCategoryReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
DeviceCategory | String | True | True | Type of device used to engage with the site/app: Desktop, Tablet, or Mobile. | |
Platform | String | True | True | Platform for the app or site (Android, iOS, Web). | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
A predefined view that retrieves Tech platform data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechPlatformReport WHERE PropertyId = 342020667 SELECT * FROM TechPlatformReport WHERE Platform = 'web' SELECT * FROM TechPlatformReport WHERE Date = '01/05/2023' SELECT * FROM TechPlatformReport WHERE PropertyId = 342020667 AND Platform = 'web' AND Date = '01/05/2023' SELECT * FROM TechPlatformReport WHERE PropertyId = 342020667 AND Platform = 'web' SELECT * FROM TechPlatformReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechPlatformReport WHERE Date >= '01/01/2022' SELECT * FROM TechPlatformReport WHERE Date <= '01/01/2022' SELECT * FROM TechPlatformReport WHERE Date > '01/01/2022' SELECT * FROM TechPlatformReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
Platform | String | True | True | Platform for the app or site (Android, iOS, Web). | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than ten seconds, had a conversion event, or had two or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | The Property Id value to be used when querying this table. |
A predefined view that retrieves Tech Screen Resolution data.
The Sync App uses the Google Analytics API to process WHERE clause conditions built with the following columns and operators:
For example, the following queries are processed server-side:
SELECT * FROM TechScreenResolutionReport WHERE PropertyId = 342020667 SELECT * FROM TechScreenResolutionReport WHERE ScreenResolution = '1920x1080' SELECT * FROM TechScreenResolutionReport WHERE Date = '01/05/2023' SELECT * FROM TechScreenResolutionReport WHERE PropertyId = 342020667 AND ScreenResolution = '1920x1080' AND Date = '01/05/2023' SELECT * FROM TechScreenResolutionReport WHERE Date >= '01/01/2022' AND <= '01/05/2023' SELECT * FROM TechScreenResolutionReport WHERE Date >= '01/01/2022' SELECT * FROM TechScreenResolutionReport WHERE Date <= '01/01/2022' SELECT * FROM TechScreenResolutionReport WHERE Date > '01/01/2022' SELECT * FROM TechScreenResolutionReport WHERE Date < '01/01/2022'The rest of the filter is executed client-side in the Sync App.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
ScreenResolution | String | True | True | Resolution of the screen used to engage with the site/app. | |
Date | Date | True | True | The date of the session formatted as YYYYMMDD. | |
Conversions | Decimal | False | True | The count of conversion events. | |
EngagementRate | Decimal | False | True | The percentage of engaged sessions. | |
EngagedSessions | Integer | False | True | The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views. | |
EventCount | Integer | False | True | The count of events. | |
NewUsers | Integer | False | True | The number of users who interacted with the site or launched the app for the first time. | |
TotalRevenue | Integer | False | True | The sum of revenue from purchases, subscriptions, and advertising. | |
TotalUsers | Integer | False | True | The total number of users. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PropertyId | String | Property ID value to be used when querying this table. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
AuthScheme | The type of authentication to use when connecting to Google Analytics. |
Schema | The type of schema to use. |
Property | Description |
OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
DelegatedServiceAccounts | A space-delimited list of service account emails for delegated requests. |
RequestingServiceAccount | A service account email to make a delegated request. |
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
Property | Description |
SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Property | Description |
LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Property | Description |
Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Property | Description |
AWSWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via AWS. |
DefaultEndDate | A default end date to be applied to all queries. |
DefaultStartDate | A default start date to be applied to all queries. |
IgnorePermissionsException | Whether to ignore exceptions related to insufficient permissions for a specific profile. |
IncludeDeleted | If set to True, the provider include the deleted rows. The default value is False which will not include these rows. |
IncludeEmptyRows | If set to false, the provider does not include rows if all the retrieved metrics are equal to zero. The default is true which will include these rows. |
MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
Pagesize | Specifies the maximum number of results to return from Google Analytics, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
PropertyId | Property ID value to be used when querying reports views in V4 schema. |
PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
ReportType | The type of Reports to get results in case of Events and ActiveUsers view. |
SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
WorkloadPoolId | The ID of your Workload Identity Federation pool. |
WorkloadProjectId | The ID of the Google Cloud project that hosts your Workload Identity Federation pool. |
WorkloadProviderId | The ID of your Workload Identity Federation pool provider. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
AuthScheme | The type of authentication to use when connecting to Google Analytics. |
Schema | The type of schema to use. |
The type of authentication to use when connecting to Google Analytics.
The type of schema to use.
The schema available is GoogleAnalytics4.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
DelegatedServiceAccounts | A space-delimited list of service account emails for delegated requests. |
RequestingServiceAccount | A service account email to make a delegated request. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
A space-delimited list of service account emails for delegated requests.
The service account emails must be specified in a space-delimited list.
Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain.
The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the requesting service account. The requesting service account is the one specified in the RequestingServiceAccount property.
Note that for delegated requests, the requesting service account must have the permission iam.serviceAccounts.getAccessToken, which can also be granted through the serviceAccountTokenCreator role.
A service account email to make a delegated request.
The service account email of the account for which the credentials are requested in a delegated request. With the list of delegated service accounts in DelegatedServiceAccounts, this property is used to make a delegated request.
You must have the IAM permission iam.serviceAccounts.getAccessToken on this service account.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
The JWT Certificate store.
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
This property can take one of the following values:
USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
BCFKSFILE | The certificate store is the name of a file that contains an Bouncy Castle keystore. |
BCFKSBLOB | The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore. |
GOOGLEJSON | The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service. |
GOOGLEJSONBLOB | The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service. |
The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.
The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
The value of this property is used to locate a matching certificate in the store. The search process works as follows:
You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected]. Common fields include:
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".
The issuer of the Java Web Token.
The issuer of the Java Web Token. Enter the value of the service account email address.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.
The user subject for which the application is requesting delegated access.
The user subject for which the application is requesting delegated access. Enter the email address of the user for which the application is requesting delegated access.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
Protocol | Default Port | Description |
TUNNEL | 80 | The port where the Sync App opens a connection to Google Analytics. Traffic flows back and forth via the proxy at this location. |
SOCKS4 | 1080 | The port where the Sync App opens a connection to Google Analytics. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
SOCKS5 | 1080 | The port where the Sync App sends data to Google Analytics. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
ProxyAuthScheme Value | Value to set for ProxyUser |
BASIC | The user name of a user registered with the proxy server. |
DIGEST | The user name of a user registered with the proxy server. |
NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
ProxyAuthScheme Value | Value to set for ProxyPassword |
BASIC | The password associated with the proxy server user specified in ProxyUser. |
DIGEST | The password associated with the proxy server user specified in ProxyUser. |
NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
NTLM | The password associated with the Windows user account specified in ProxyUser. |
NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
Note: Since this Sync App supports multiple schemas, custom schema files for Google Analytics should be structured such that:
Location should always be set to the parent folder, and not to an individual schema's folder.
If left unspecified, the default location is %APPDATA%\\CData\\GoogleAnalytics Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
AWSWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via AWS. |
DefaultEndDate | A default end date to be applied to all queries. |
DefaultStartDate | A default start date to be applied to all queries. |
IgnorePermissionsException | Whether to ignore exceptions related to insufficient permissions for a specific profile. |
IncludeDeleted | If set to True, the provider include the deleted rows. The default value is False which will not include these rows. |
IncludeEmptyRows | If set to false, the provider does not include rows if all the retrieved metrics are equal to zero. The default is true which will include these rows. |
MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
Pagesize | Specifies the maximum number of results to return from Google Analytics, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
PropertyId | Property ID value to be used when querying reports views in V4 schema. |
PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
ReportType | The type of Reports to get results in case of Events and ActiveUsers view. |
SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
WorkloadPoolId | The ID of your Workload Identity Federation pool. |
WorkloadProjectId | The ID of the Google Cloud project that hosts your Workload Identity Federation pool. |
WorkloadProviderId | The ID of your Workload Identity Federation pool provider. |
Configuration properties to provide when using Workload Identity Federation via AWS.
The properties are formatted as a semicolon-separated list of Key=Value properties, where the value is optionally quoted.
For example, this setting authenticates in AWS using a user's root keys:
AWSWorkloadIdentityConfig="AuhtScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"
A default end date to be applied to all queries.
A default end date to be applied to all queries. These values will be overridden if set in the query.
A default start date to be applied to all queries.
A default start date to be applied to all queries. These values will be overridden if set in the query.
Whether to ignore exceptions related to insufficient permissions for a specific profile.
Whether to ignore exceptions related to insufficient permissions for a specific profile.
If set to True, the provider include the deleted rows. The default value is False which will not include these rows.
Allowed Values:
TRUE | The provider includes the deleted rows. |
FALSE | The provider does not include the deleted rows. |
If set to false, the provider does not include rows if all the retrieved metrics are equal to zero. The default is true which will include these rows.
Allowed Values:
TRUE | The provider includes the rows where all the retrieved metrics are equal to zero. |
FALSE | The provider does not include the rows where all the retrieved metrics are equal to zero. |
Note that it is still possible for no rows to be returned with this set to TRUE depending on the dimensions included in the query. This property will only work when the cardinality of the dimension is known over the date range (such as with the Date dimension). If the cardinality is unknown or not defined, such as with the ProductName dimension on the Ecommerce table, no results would be returned.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of results to return from Google Analytics, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.
Property ID value to be used when querying reports views in V4 schema.
Property ID value to be used when querying reports views in V4 schema.
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
The type of Reports to get results in case of Events and ActiveUsers view.
The ReportType available are RealtimeReports and Reports. For the Events and ActiveUsers view
RealtimeReports | Driver will use runRealtimeReport endpoint. |
Reports | Driver will use runReport endpoint. |
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
When SupportEnhancedSQL = true, the Sync App offloads as much of the SELECT statement processing as possible to Google Analytics and then processes the rest of the query in memory. In this way, the Sync App can execute unsupported predicates, joins, and aggregation.
When SupportEnhancedSQL = false, the Sync App limits SQL execution to what is supported by the Google Analytics API.
The Sync App determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the Sync App to filter effectively for even very large datasets.
The Sync App uses various techniques to join in memory. The Sync App trades off memory utilization against the requirement of reading the same table more than once.
The Sync App retrieves all rows necessary to process the aggregation in memory.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{ "MyView": { "query": "SELECT * FROM Traffic WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.
The ID of your Workload Identity Federation pool.
The ID of your Workload Identity Federation pool.
The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
The ID of your Workload Identity Federation pool provider.
The ID of your Workload Identity Federation pool provider.