Matillion ETL Data Model for Google Analytics 4
|
string
"Auto"
string
"GoogleAnalytics4"
The schemas available are UniversalAnalytics and GoogleAnalytics4. Note that the UniversalAnalytics API is deprecated on Google's side with support ending mid-2023.
string
""
This can be set to either the Id or website URL for the Profile. If not specified all the profiles returned would be used.
This is only used for the UniversalAnalytics Schema.
string
"OFF"
The following options are available:
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
string
""
The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
string
"%APPDATA%\\CData\\GoogleAnalytics Data Provider\\OAuthSettings.txt"
When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.
Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.
If left unspecified, the default location is "%APPDATA%\\CData\\GoogleAnalytics Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
string
""
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
See Establishing a Connection to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
string
""
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).
string
"USER"
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. |
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. |
string
""
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.
string
"*"
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@cdata.com". Common fields and their meanings are displayed below.
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 it must be quoted.
string
""
The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.
string
""
The user subject for which the application is requesting delegated access. Typically, the user account name or email address.
string
""
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.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
string
"NONE"
This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the driver opens a connection to Google Analytics and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your 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.
string
""
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
int
0
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
string
""
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
string
""
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
bool
false
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
NOTE: When this property is set to True, the proxy used is determined as follows:
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
string
""
The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
int
80
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
string
"BASIC"
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
string
""
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
string
""
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
string
"AUTO"
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
string
""
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
string
""
Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property.
Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
Java logging is also supported. To enable Java logging, set Logfile to:
Logfile=JAVALOG://myloggername
As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.
The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.
When Java logging is enabled, the Verbosity will now correspond to specific logging levels.
string
"1"
The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
string
""
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
string
"100MB"
When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
Adjust the maximum number of logfiles generated with MaxLogFileCount.
int
-1
When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Adjust the maximum size of the logfiles generated with MaxLogFileSize.
string
"%APPDATA%\\CData\\GoogleAnalytics Data Provider\\Schema"
The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
Note: Given that this driver supports multiple schemas, the structure for Google Analytics custom schema files is as follows:
If left unspecified, the default location is "%APPDATA%\\CData\\GoogleAnalytics Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
string
"V4"
Set this property to V3 to use the Google Analytics v3 API or V4 to use the Google Analytics v4 API.
Note: ApiVersion is specific to UniversalAnalytics Schema only.
bool
false
When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.
When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
string
""
You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.
The cache database is determined by the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.
Note: you must add the CacheDriver JAR file to the classpath.
The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:
jdbc:googleanalytics:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;Profile=myProfile;To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:googleanalytics:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;Profile=myProfile;
The following is a JDBC URL for the SQLite JDBC driver:
jdbc:googleanalytics:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;Profile=myProfile;
The following is a JDBC URL for the included CData JDBC Driver for MySQL:
jdbc:googleanalytics:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;Profile=myProfile;
The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:
jdbc:googleanalytics:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;Profile=myProfile;
The following is a JDBC URL for the Oracle Thin Client:
jdbc:googleanalytics:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;Profile=myProfile;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
The following JDBC URL uses the official PostgreSQL JDBC driver:
jdbc:googleanalytics:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;Profile=myProfile;
string
""
The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.
The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.
The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.
Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:
jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory
To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:
jdbc:sqlite:dataSource
The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:
jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:
The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:
jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
The following are typical SQL Server connection properties:
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:
jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
The following are typical connection properties:
Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:
jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
The following are typical connection properties:
string
"%APPDATA%\\CData\\GoogleAnalytics Data Provider"
The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.
If left unspecified, the default location is "%APPDATA%\\CData\\GoogleAnalytics Data Provider" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
int
600
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
bool
false
When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
bool
false
As you execute queries with this property set, table metadata in the Google Analytics catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.
The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.
int
0
When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.
Setting BatchSize to 0 will submit the entire batch as specified.
int
0
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.
bool
false
When set to true, a connection will be made to Google Analytics when the connection is opened. This property enables the Test Connection feature available in various database tools.
This feature acts as a NOOP command as it is used to verify a connection can be made to Google Analytics and nothing from this initial connection is maintained.
Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).
string
"EndDate='Today'"
A default filter to be applied to all queries. Convenient for setting default Dimensions, StartDate, EndDate, and Segments for all queries. These values will be overridden if set in the query. Example value: Dimensions='Year' AND EndDate='Today'
bool
false
Whether to ignore exceptions related to insufficient permissions for a specific profile.
string
"TRUE"
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.
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
string
""
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
CachePartial=True | Caches only a subset of columns, which you can specify in your query. |
QueryPassthrough=True | Passes the specified query to the cache database instead of using the SQL parser of the driver. |
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. |
int
10000
The Pagesize property affects the maximum number of results to return per page from Google Analytics. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
int
60
The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.
int
100
The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.
int
1
The minimum number of connections in the pool. The default is 1.
int
60
The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.
string
""
Property ID value to be used when querying reports views in V4 schema.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
string
"RealtimeReports"
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. |
string
""
The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.
string
"DEFAULT"
Allowed Values:
DEFAULT | Returns response with a sample size that balances speed and accuracy. |
FASTER | Available only when using the V3 API. Returns a fast response with a smaller sample size. |
HIGHER_PRECISION | Available only when using the V3 API. Returns a more accurate response using a large sample size, but this may result in the response being slower. |
SMALL | Similar to FASTER, but for the V4 API. |
LARGE | Similar to HIGHER_PRECISION, but for the V4 API. |
bool
true
When SupportEnhancedSQL = true, the driver 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 driver can execute unsupported predicates, joins, and aggregation.
When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the Google Analytics API.
The driver 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 driver to filter effectively for even very large datasets.
The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.
The driver retrieves all rows necessary to process the aggregation in memory.
When SupportEnhancedSQL = true, the driver 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 driver can execute unsupported predicates, joins, and aggregation.
When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the Google Analytics API.
The driver 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 driver to filter effectively for even very large datasets.
The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.
The driver retrieves all rows necessary to process the aggregation in memory.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the driver throws an exception.
bool
false
This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.
string
""
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The driver automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the driver.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM Traffic WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
bool
false
If set to true, the provider will include the useResourceQuotas header in each request. This header will enable resource based quotas for a given request.
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.
You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
CreateTime | Datetime | True |
Time the account was created. |
DisplayName | String | True |
display name for the account. |
Name | String | True |
Account name. |
RegionCode | String | True |
Country for the account. |
UpdateTime | Datetime | True |
Time the account was last modified. |
Lists all Properties to which the user has access.
SELECT * FROM Properties WHERE Id = '54516992' SELECT * FROM Properties WHERE Parent = 'accounts/54516992'
You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
CreateTime | Datetime | True |
Time the property was created. |
CurrencyCode | String | True |
The currency type used in reports involving monetary values. |
DisplayName | String | True |
Display name for the property. |
IndustryCategory | String | True |
Industry associated with the property. |
Id | Integer | True |
Property Id. |
Parent | String | True |
Name of the property's logical parent. |
TimeZone | String | True |
Reporting Time Zone. |
UpdateTime | Datetime | True |
Time the property was last modified. |
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 driver 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 driver.
Name | Type | ReadOnly | Description |
CreateTime | Datetime | True |
Time the stream was created. |
DisplayName | String | True |
Display name for the data stream. |
Name | String | True |
Web data stream name. |
Parent | String | True |
Name of the web data stream's logical parent. |
Type | String | True |
Name of the web data stream's logical parent. |
webStreamData | String | True |
Data specific to web streams. |
androidAppStreamData | String | True |
Data specific to Android app streams. |
iosAppStreamData | String | True |
Data specific to iOS app streams. |
UpdateTime | Datetime | True |
Time the stream was last modified. |
PropertyId | Integer | True |
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'
You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
CreateTime | Datetime | True |
Time the FirebaseLink was created. |
MaximumUserAccess | String | True |
Maximum user access to the property allowed to admins of the linked Firebase project. |
Name | String | True |
FirebaseLink name. |
Parent | String | True |
Name of the FirebaseLink's logical parent. |
Project | String | True |
Firebase project resource name. |
PropertyId | Integer | True |
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'
You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to other columns will cause an error. The rest of the filter is executed client-side within the provider.
Name | Type | ReadOnly | Description |
CanManageClients | Boolean | True |
Whether the link if for a Google Ads manager account. |
AdsPersonalizationEnabled | Boolean | True |
Whether to enable personalized advertising. |
CreateTime | Datetime | True |
Time the link was created. |
CustomerId | String | True |
Google Ads customer ID. |
EmailAddress | String | True |
Email address of the user that created the link. |
Name | String | True |
GoogleAdsLinks name. |
Parent | String | True |
Name of the GoogleAdsLink's logical parent. |
UpdateTime | Datetime | True |
Time the link was last modified. |
PropertyId | Integer | True |
Property ID value to be used when querying this table. |
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
You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to other columns will cause an error.
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. |
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
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. | ||
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. | ||
FirstUserCreativeId | 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 | ||
SessionDefaultChannelGrouping | String | True | Channel groupings are rule-based definitions of your traffic sources. These default system definitions reflect Analytics | ||
SessionMedium | String | True | Channel that referred the user | ||
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 | Integer | 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 | Integer | False | False | The total amount of time (in seconds) the website or app was in the foreground of users | |
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. | |
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). | |||
Dimensions | String | A comma-separated list of dimensions to retrieve in addition to the columns defined in the schema. Set to empty string to retrieve no dimensions. | |||
Metrics | String | A comma-separated list of metrics to retrieve in addition to the columns defined in the schema. |
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 Acquisitions first user Campaign data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves user Acquisitions first user google ads ad group name data.
The driver 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 driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions first user google ads ad network type platform data.
The driver 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 driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions first user medium data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions first user source medium data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions first user source platform data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions first user source data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions session campaign report data.
n
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions session default channel grouping report data.
Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
SessionDefaultChannelGrouping | 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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions session medium report data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions session source medium report data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions session source platform report data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Acquisitions session source report data.
The driver 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'The rest of the filter is executed client-side in the driver.
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 | Integer | 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 | Integer | 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. |
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. |
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 Demographics UserAgeBracket data.
The driver 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 driver.
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 | Integer | 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. |
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 | Integer | 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. |
Retrieves Demographics Country data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Demographics UserGender data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Demographics BrandingInterest data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Demographics Language data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Demographics Region data.
The driver 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 driver.
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 | Integer | 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. |
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. | ||
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 | Integer | 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). | |||
Dimensions | String | A comma-separated list of dimensions to retrieve in addition to the columns defined in the schema. Set to empty string to retrieve no dimensions. | |||
Metrics | String | A comma-separated list of metrics to retrieve in addition to the columns defined in the schema. |
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 Ecommerce purchase item brand data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemViews | Integer | False | True | The number of times the item details were viewed. |
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 Ecommerce purchase item category data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemViews | Integer | False | True | The number of times the item details were viewed. |
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 Ecommerce purchase item category data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemViews | Integer | False | True | The number of times the item details were viewed. |
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 Ecommerce purchase item category data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemViews | Integer | False | True | The number of times the item details were viewed. |
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 Ecommerce purchase item category data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemViews | Integer | False | True | The number of times the item details were viewed. |
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 Ecommerce purchase item category data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemViews | Integer | False | True | The number of times the item details were viewed. |
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 Ecommerce purchase item category data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
ItemRevenue | Decimal | False | True | The total revenue from items only. Item revenue is the product of its price and quantity. | |
ItemViews | Integer | False | True | The number of times the item details were viewed. |
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 Ecommerce purchase item data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
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. |
Retrieves Ecommerce purchase item data.
The driver 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 driver.
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. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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 | True | The number of times users completed a purchase. | |
PurchaseToViewRate | Decimal | False | True | The total cost of shipping. | |
ItemPurchaseQuantity | Decimal | False | True | The total amount of tax. | |
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. |
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. | ||
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 | Integer | 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 | Integer | 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. | |
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). | |||
Dimensions | String | A comma-separated list of dimensions to retrieve in addition to the columns defined in the schema. Set to empty string to retrieve no dimensions. | |||
Metrics | String | A comma-separated list of metrics to retrieve in addition to the columns defined in the schema. |
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 Engagement Content Group Report data.
The driver 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 driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Engagement conversions data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Engagement events data.
The driver 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 driver.
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 | Property ID value to be used when querying this table. |
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 | Integer | 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 | Integer | 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. |
Retrieves Engagement Pages title and screen class data.
The driver 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 driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Engagement Pages Title And ScreenName data.
The driver 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 driver.
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 | Integer | 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 | Integer | 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. |
Retrieves Event data.
Retrieves data for Events 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 4 dimensions compared to the standard 9 for the standard report API.
The following is an example query:
SELECT EventCount, Platform FROM Events
As 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 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 | 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 will work when connection property ReportType=reports; | ||
PageTitle | String | True | The web page titles used on your site. This will work when connection property ReportType=reports; | ||
EventCount | Integer | False | True | Number of times an individual event was triggered. | |
Conversions | Integer | False | True | The count of conversion 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 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. | ||
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. | ||
FirstUserCreativeId | 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). | |||
Dimensions | String | A comma-separated list of dimensions to retrieve in addition to the columns defined in the schema. Set to empty string to retrieve no dimensions. | |||
Metrics | String | A comma-separated list of metrics to retrieve in addition to the columns defined in the schema. |
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. |
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 AddToCarts, 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. | ||
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 | True | The amount of time the ad unit was exposed to the user. | |
AddToCarts | Integer | False | True | The number of times users added items to their shopping carts. | |
CartToViewRate | Integer | 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). | |
Checkouts | Integer | False | True | Number of times users started the checkout process. | |
EcommercePurchases | Integer | False | True | The number of times users completed a purchase. | |
EventCount | Integer | False | True | The count of events. | |
FirstTimePurchasers | Integer | False | True | The number of users that completed their first purchase event. | |
ItemListClicks | Integer | False | True | The number of times users clicked an item when it appeared in a list. | |
ItemListClickThroughRate | Decimal | False | True | Rate at which users clicked the item in an item list to view the item details. | |
ItemListViews | Integer | False | True | The number of times the item list was viewed. | |
ItemPromotionClicks | Integer | False | The number of times an item promotion was clicked. | ||
ItemPromotionClickThroughRate | Decimal | False | The number of users who selected a promotion(s) divided by the number of users who viewed the same promotion(s). | ||
ItemPromotionViews | Integer | False | The number of times an item promotion was viewed. | ||
ItemPurchaseQuantity | Decimal | False | The total amount of tax. | ||
ItemRevenue | Decimal | False | The total revenue from items only. Item revenue is the product of its price and quantity. | ||
ItemViews | Integer | False | The number of times the item details were viewed. | ||
PublisherAdClicks | Integer | False | The number of times an ad was clicked on the publisher | ||
PublisherAdImpressions | Integer | False | The number of times an ad was displayed on the publisher | ||
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). | |||
Dimensions | String | A comma-separated list of dimensions to retrieve in addition to the columns defined in the schema. Set to empty string to retrieve no dimensions. | |||
Metrics | String | A comma-separated list of metrics to retrieve in addition to the columns defined in the schema. |
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 publisher ads page ad format data.
n
The driver 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 driver.
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 | Property ID value to be used when querying this table. |
Retrieves publisher ads ad source data.
n
The driver 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 driver.
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 | Property ID value to be used when querying this table. |
Retrieves publisher ads ad unit data.
n
The driver 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 driver.
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 | Property ID value to be used when querying this table. |
Retrieves publisher ads page path data.
n
The driver 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 driver.
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 | Property ID value to be used when querying this table. |
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. | ||
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 | Integer | 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). | |||
Dimensions | String | A comma-separated list of dimensions to retrieve in addition to the columns defined in the schema. Set to empty string to retrieve no dimensions. | |||
Metrics | String | A comma-separated list of metrics to retrieve in addition to the columns defined in the schema. |
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 Tech App Version data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Tech Browser data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Tech Device Category data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Tech Device Model data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Tech os system data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Tech Os version data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Tech platform device category data.
The driver 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 driver.
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 | Integer | 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. |
Retrieves Tech platform data data.
The driver 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 driver.
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 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. |
Retrieves Tech Screen Resolution data
The driver 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 driver.
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 | Integer | 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. |