Matillion ETL Data Model for Google Universal Analytics
Version - 21.0.7898.0

Note: Data models are true for the latest version of Matillion ETL. If you are on an older version or using a component from an old job, your experience may differ.



Connection String OptionsBack To Top

  1. AuthScheme
  2. Schema
  3. Profile
  4. InitiateOAuth
  5. OAuthClientId
  6. OAuthClientSecret
  7. OAuthAccessToken
  8. OAuthSettingsLocation
  9. OAuthVerifier
  10. OAuthRefreshToken
  11. OAuthExpiresIn
  12. OAuthTokenTimestamp
  13. OAuthJWTCert
  14. OAuthJWTCertType
  15. OAuthJWTCertPassword
  16. OAuthJWTCertSubject
  17. OAuthJWTIssuer
  18. OAuthJWTSubject
  19. SSLServerCert
  20. FirewallType
  21. FirewallServer
  22. FirewallPort
  23. FirewallUser
  24. FirewallPassword
  25. ProxyAutoDetect
  26. ProxyServer
  27. ProxyPort
  28. ProxyAuthScheme
  29. ProxyUser
  30. ProxyPassword
  31. ProxySSLType
  32. ProxyExceptions
  33. Logfile
  34. Verbosity
  35. LogModules
  36. MaxLogFileSize
  37. MaxLogFileCount
  38. Location
  39. BrowsableSchemas
  40. Tables
  41. Views
  42. ApiVersion
  43. AutoCache
  44. CacheDriver
  45. CacheConnection
  46. CacheLocation
  47. CacheTolerance
  48. Offline
  49. CacheMetadata
  50. BatchSize
  51. ConnectionLifeTime
  52. ConnectOnOpen
  53. DefaultFilter
  54. IgnorePermissionsException
  55. IncludeEmptyRows
  56. MaxRows
  57. Other
  58. Pagesize
  59. PoolIdleTimeout
  60. PoolMaxSize
  61. PoolMinSize
  62. PoolWaitTime
  63. PropertyId
  64. PseudoColumns
  65. RTK
  66. SamplingLevel
  67. SupportEnhancedSQL
  68. Timeout
  69. UseConnectionPooling
  70. UseResourceQuotas

AuthScheme

Data Type

string

Default Value

"Auto"

Remarks



Schema

Data Type

string

Default Value

"UniversalAnalytics"

Remarks

The schemas available are UniversalAnalytics and GoogleAnalytics4.



Profile

Data Type

string

Default Value

""

Remarks

This can be set to either the Id or website URL for the Profile. If not specified, the first Profile returned will be used. This value can be retrieved from the Profiles table or will be retrieved automatically if this value is not set.



InitiateOAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.



OAuthClientId

Data Type

string

Default Value

""

Remarks

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.



OAuthClientSecret

Data Type

string

Default Value

""

Remarks

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.



OAuthAccessToken

Data Type

string

Default Value

""

Remarks

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.



OAuthSettingsLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\GoogleAnalytics Data Provider\\OAuthSettings.txt"

Remarks

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



OAuthVerifier

Data Type

string

Default Value

""

Remarks

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.

Authentication on Headless Machines

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



OAuthRefreshToken

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.



OAuthExpiresIn

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.



OAuthTokenTimestamp

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.



OAuthJWTCert

Data Type

string

Default Value

""

Remarks

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware 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).



OAuthJWTCertType

Data Type

string

Default Value

"USER"

Remarks

This property can take one of the following values:

USERFor 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.
MACHINEFor Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILEThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEThe certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOBThe 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_FILEThe certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBThe certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEThe certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEThe certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILEThe certificate store is the name of a PKCS7 file containing certificates.
PPKFILEThe certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILEThe certificate store is the name of a file that contains a certificate in XML format.
XMLBLOBThe certificate store is a string that contains a certificate in XML format.
GOOGLEJSONThe certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service.
GOOGLEJSONBLOBThe certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service.



OAuthJWTCertPassword

Data Type

string

Default Value

""

Remarks

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.



OAuthJWTCertSubject

Data Type

string

Default Value

"*"

Remarks

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.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.



OAuthJWTIssuer

Data Type

string

Default Value

""

Remarks

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.



OAuthJWTSubject

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.



SSLServerCert

Data Type

string

Default Value

""

Remarks

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.



FirewallType

Data Type

string

Default Value

"NONE"

Remarks

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.



FirewallServer

Data Type

string

Default Value

""

Remarks

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.



FirewallPort

Data Type

int

Default Value

0

Remarks

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.



FirewallUser

Data Type

string

Default Value

""

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.



FirewallPassword

Data Type

string

Default Value

""

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.



ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

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.



ProxyServer

Data Type

string

Default Value

""

Remarks

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.



ProxyPort

Data Type

int

Default Value

80

Remarks

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.



ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

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.



ProxyUser

Data Type

string

Default Value

""

Remarks

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



ProxyPassword

Data Type

string

Default Value

""

Remarks

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.



ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

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:

AUTODefault 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.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe 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.



ProxyExceptions

Data Type

string

Default Value

""

Remarks

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.



Logfile

Data Type

string

Default Value

""

Remarks

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

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.



Verbosity

Data Type

string

Default Value

"1"

Remarks

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.



LogModules

Data Type

string

Default Value

""

Remarks

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.



MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

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.



MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

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.



Location

Data Type

string

Default Value

"%APPDATA%\\CData\\GoogleAnalytics Data Provider\\Schema"

Remarks

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



BrowsableSchemas

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.



Tables

Data Type

string

Default Value

""

Remarks

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.



Views

Data Type

string

Default Value

""

Remarks

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.



ApiVersion

Data Type

string

Default Value

"V4"

Remarks

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.



AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.

Setting the Caching Database

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:

See Also



CacheDriver

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note that you must also add the CacheDriver JAR file to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

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;
SQLite

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;
MySQL

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;

  
SQL Server

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;
Oracle

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

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;



CacheConnection

Data Type

string

Default Value

""

Remarks

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.

Derby and Java DB

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

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:

jdbc:sqlite:dataSource

MySQL

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:

SQL Server

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:
Oracle

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:
PostgreSQL

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:



CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\GoogleAnalytics Data Provider"

Remarks

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

See Also



CacheTolerance

Data Type

int

Default Value

600

Remarks

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.



Offline

Data Type

bool

Default Value

false

Remarks

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.



CacheMetadata

Data Type

bool

Default Value

false

Remarks

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.

When to Use CacheMetadata

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.

When Not to Use CacheMetadata



BatchSize

Data Type

int

Default Value

0

Remarks

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.



ConnectionLifeTime

Data Type

int

Default Value

0

Remarks

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.



ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

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



DefaultFilter

Data Type

string

Default Value

"EndDate='Today'"

Remarks

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'



IgnorePermissionsException

Data Type

bool

Default Value

false

Remarks

Whether to ignore exceptions related to insufficient permissions for a specific profile.



IncludeEmptyRows

Data Type

string

Default Value

"TRUE"

Remarks

Allowed Values:

TRUEThe provider includes the rows where all the retrieved metrics are equal to zero.
FALSEThe 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.



MaxRows

Data Type

int

Default Value

-1

Remarks

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.



Other

Data Type

string

Default Value

""

Remarks

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.

Caching Configuration

CachePartial=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.



Pagesize

Data Type

int

Default Value

10000

Remarks

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.



PoolIdleTimeout

Data Type

int

Default Value

60

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.



PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.



PoolMinSize

Data Type

int

Default Value

1

Remarks

The minimum number of connections in the pool. The default is 1.



PoolWaitTime

Data Type

int

Default Value

60

Remarks

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.



PropertyId

Data Type

string

Default Value

""

Remarks

Property ID value to be used when querying reports views in V4 schema.



PseudoColumns

Data Type

string

Default Value

""

Remarks

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, "*=*".



RTK

Data Type

string

Default Value

""

Remarks

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.



SamplingLevel

Data Type

string

Default Value

"DEFAULT"

Remarks

Allowed Values:

DEFAULTReturns response with a sample size that balances speed and accuracy.
FASTERAvailable only when using the V3 API. Returns a fast response with a smaller sample size.
HIGHER_PRECISIONAvailable 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.
SMALLSimilar to FASTER, but for the V4 API.
LARGESimilar to HIGHER_PRECISION, but for the V4 API.



SupportEnhancedSQL

Data Type

bool

Default Value

false

Remarks

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.

Execution of Predicates

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.

Execution of Joins

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.

Execution of Aggregates

The driver retrieves all rows necessary to process the aggregation in memory.



Timeout

Data Type

int

Default Value

60

Remarks

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.



UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.



UseResourceQuotas

Data Type

bool

Default Value

false

Remarks

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.





TablesBack To Top

  1. Accounts
  2. Goals
  3. Profiles
  4. Segments
  5. UserActivity
  6. WebProperties

Accounts

Lists all Accounts to which the user has access.

Table Specific Information

Select

The Accounts table exposes every account the user has access to. Filters are not available in the WHERE clause for this table but LIMIT is supported.

Columns

Name Type ReadOnly Description
Id [KEY] String True

Account Id.

Kind String True

Resource type for Analytics account.

SelfLink String True

Link for this account.

Name String True

Account name.

Permissions String True

All the permissions that the user has for this account. These include any implied permissions.

Created Datetime True

Time the account was created.

Updated Datetime True

Time the account was last modified.

ChildLink String True

Child link for an account entry. Points to the list of Web properties for this account.



Goals

A Goals resource describes a goal for one of a user's profiles.

Columns

Name Type ReadOnly Description
Id [KEY] String True

Goal Id.

WebPropertyId [KEY] String True

Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

Kind String True

Resource type for Analytics profile.

SelfLink String True

Link for this goal.

AccountId String True

Account ID to which this goal belongs.

InternalWebPropertyId String True

Internal ID for the web property to which this goal belongs.

ProfileId String True

View (Profile) ID to which this goal belongs.

Name String True

Goal name.

Active Boolean True

Determines whether this goal is active.

Value Double True

Goal value.

Type String True

Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, and EVENT.

Created Datetime True

Time this goal was created.

Updated Datetime True

Time this goal was last modified.

ParentLink String True

Parent link for a goal. Points to the view (profile) to which this goal belongs.

UrlDestinationDetails String True

Details for the goal of the type URL_DESTINATION.

VisitTimeOnSiteDetails String True

Details for the goal of the type VISIT_TIME_ON_SITE.

VisitNumPagesDetails String True

Value used for this comparison.

EventDetails String True

Details for the goal of the type EVENT.



Profiles

Lists all Profiles to which the user has access.

Table Specific Information

Select

The Profiles table exposes all profiles that the user has access to. The AccountId and WebPropertyId fields are available for filtering in the WHERE clause with = operator. For example:

  SELECT * FROM Profiles WHERE AccountId = '123456'
Columns

Name Type ReadOnly Description
Id [KEY] String True

Profile Id.

Kind String True

Resource type for Analytics profile.

SelfLink String True

Link for this profile.

AccountId String True

Account Id to which this profile belongs.

WebPropertyId String True

Web property Id of the form UA-XXXXX-YY to which this profile belongs.

InternalWebPropertyId String True

Internal Id for the Web property to which this profile belongs.

Name String True

Name of this profile.

Currency String True

The currency type associated with this profile.

Timezone String True

Time zone for which this profile has been configured.

WebsiteURL String True

Website URL for this profile.

DefaultPage String True

Default page for this profile.

ExcludeQueryParameters String True

The query parameters that are excluded from this profile.

SiteSearchQueryParameters String True

The site search query parameters for this profile.

SiteSearchCategoryParameters String True

Site search category parameters for this profile.

Type String True

Profile type.

Permissions String True

All the permissions that the user has for this profile. These include any implied permissions.

Created Datetime True

Time this profile was created.

Updated Datetime True

Time this profile was last modified.

eCommerceTracking Boolean True

Indicates whether e-commerce tracking is enabled for this profile.

ParentLink String True

Parent link for this profile. Points to the Web property to which this profile belongs.

ChildLink String True

Child link for this profile. Points to the list of goals for this profile.



Segments

Lists all Segments to which the user has access.

Table Specific Information

Select

The Segments table exposes all segments that the user has access to. Filters are not available in the WHERE clause for this table but LIMIT is supported.

Columns

Name Type ReadOnly Description
Id [KEY] String True

Segment Id.

Kind String True

Resource type for Analytics segment.

SelfLink String True

Link for this segment.

SegmentID String True

Segment Id. Can be used with the segment parameter in Data Feed.

Name String True

Segment name.

Definition String True

Segment definition.

Type String True

Type for a segment. Possible values are BUILT_IN or CUSTOM.

Created Datetime True

Time the segment was created.

Updated Datetime True

Time the segment was last modified.



UserActivity

List information on a user's activity.

Table Specific Information

Select

This view requires column 'ClientID' to be specified in order to execute a query. Unfortunately, we don't expose a 'Clients' or 'Users' table (or equivalent) to display client IDs. This is an API limitation.

Because of this, the only way to retrieve a ClientID is by following the below steps:

  1. Login to Google Analytics in your preferred browser.
  2. Expand the 'Audience' report on the left side of the screen.
  3. Choose 'User Explorer' option.

Client IDs will be displayed under column 'Client Id'. Use one of those values when building the query in the driver, e.g.:

SELECT * FROM UserActivity WHERE ClientId = '194067010.1581918826' 

Note: Profile is also required for this table.

Columns

Name Type ReadOnly Description
ClientId String True

The Client ID or User ID associated with the user. This can be found in the 'User Explorer' section of Google Analytics' UI.

ActivityTime String True

Timestamp of the activity.

Source String True

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

Medium String True

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

ChannelGrouping String True

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

Campaign String True

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

Keyword String True

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

Hostname String True

The hostname from which the tracking request was made.

LandingPagePath String True

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

ActivityType String True

Type of this activity.

Event String True

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

PageView String True

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

AppView String True

This will be set if activityType equals SCREEN_VIEW.

Ecommerce String True

This will be set if activityType equals ECOMMERCE.

Goals String True

This will be set if activityType equals GOAL.

StartDate String True

Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).

EndDate String True

End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).

SamplesReadCounts String True

Comma separated list of samples read counts when the response data is sampled.

SamplingSpaceSizes String True

Comma separated list of samples space sizes counts when the response data is sampled.



WebProperties

Lists Web Properties to which the user has access.

Columns

Name Type ReadOnly Description
Id [KEY] String True

Web property Id.

Kind String True

Resource type for Analytics web property.

SelfLink String True

Link for this web property.

AccountId String True

Account Id to which this web property belongs.

InternalWebPropertyId String True

Internal Id for the web property.

DefaultProfileId String True

Default view (profile) Id.

IndustryVertical String True

The industry vertical/category selected for this web property

Level String True

Level for this web property.

Name String True

Name of this web property.

ProfileCount Integer True

View (Profile) count for this web property.

WebsiteURL String True

Website URL for this web property.

Permissions String True

All the permissions that the user has for this web property. These include any implied permissions.

Created Datetime True

Time this web property was created.

Updated Datetime True

Time this web property was last modified.

ParentLink String True

Parent link for this profile. Points to the Account to which this profile belongs.

ChildLink String True

Child link for this web property. Points to the list of views (profiles) for this web property.





ViewsBack To Top

  1. AdSense
  2. AdWords
  3. Ecommerce
  4. Events
  5. Global_Access_Object
  6. GoalCompletions
  7. SiteContent
  8. SiteSearch
  9. SiteSpeed
  10. Traffic

AdSense

Retrieves AdSense data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses Date instead of the default Campaign dimension:

SELECT Date, Sessions, Users, OrganicSearches, GoalValueAll, TransactionRevenue, AdsenseRevenue, AdsenseAdsClicks, AdsensePageImpressions FROM AdSense
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will return the Campaign name and revenue for Campaigns with revenue of more than 100:
SELECT Campaign, AdsenseRevenue FROM AdSense WHERE AdsenseRevenue > 100
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM AdSense WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT Campaign, Sessions, Users, OrganicSearches, GoalValueAll, TransactionRevenue, AdsenseRevenue, AdsenseAdsClicks, AdsensePageImpressions FROM AdSense
Columns

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.
Campaign String True True When using manual campaign tracking, this value is the value of the utm_campaign campaign tracking parameter. When using AdWords autotagging, this value is the name(s) of the online ad campaign that you use for your property. Otherwise, this value is the following: not set.
Sessions Integer False True Counts the total number of sessions.
Users Integer False True Total number of users to your property for the requested time period.
OrganicSearches Integer False True The number of organic searches that happened within a session. This metric is search-engine agnostic.
GoalValueAll Double False True The total numeric value for all goals defined for your profile.
TransactionRevenue Decimal False True The total sale revenue provided in the transaction, excluding shipping and tax.
AdsenseRevenue Decimal False True The total revenue from AdSense ads.
AdsenseAdsClicks Integer False True The number of times AdSense ads on your site were clicked.
AdsensePageImpressions Integer False True The number of page views during which an AdSense ad was displayed. A page impression can have multiple ad units.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



AdWords

Retrieves AdWords data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses Keyword instead of the default Campaign dimension:

SELECT Keyword, Sessions, Impressions, AdClicks, AdCost, CTR, CPC, RPC, ROI, Margin FROM AdWords
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will find the total number of AdClicks from the United States:
SELECT Country, AdClicks FROM AdWords WHERE Country = 'United States'
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM AdWords WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
Because there are more than 10 Metrics available for the AdWords table, a query that selects all columns only returns the default Metrics for this table (see columns marked as default Metrics below). If you need to select other Metrics, select them explicitly instead of using '*'. The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT Campaign, Sessions, Impressions, AdClicks, AdCost, CTR, CPC, RPC, ROI, Margin FROM AdWords
Columns

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.
Language String True The language provided by the HTTP Request for the browser. Values are given as an ISO-639 code.
Country String True The country of users, derived from IP addresses.
City String True The cities of property users, derived from IP addresses.
Browser String True The names of browsers used by users to your website. For example, Internet Explorer or Firefox.
OperatingSystem String True The operating system used by your users. For example, Windows, Linux , Macintosh, iPhone, iPod.
DeviceCategory String True The type of device: desktop, tablet, or mobile.
Campaign String True True When using manual campaign tracking, this value is the value of the utm_campaign campaign tracking parameter. When using AdWords autotagging, this value is the name(s) of the online ad campaign that you use for your property. Otherwise, this value is: not set.
AdGroup String True The name of your AdWords ad group.
Keyword String True When using manual campaign tracking, this value is the value of the utm_term campaign tracking parameter; i.e., the keywords used by users to reach your property when using AdWords autotagging or if a user used organic search to reach your property. Otherwise this value is: not set.
Sessions Integer False True Counts the total number of sessions.
Impressions Integer False True Total number of campaign impressions.
AdClicks Integer False True The total number of times users have clicked on an ad to reach your property.
AdCost Decimal False True Derived cost for the advertising campaign. The currency for this value is based on the currency that you set in your AdWords account.
CTR Double False True Click-through rate for your ad. This is equal to the number of clicks divided by the number of impressions for your ad (e.g., how many times users clicked on one of your ads where that ad appeared).
CPC Decimal False True Cost to advertiser per click.
RPC Decimal False True RPC, or revenue-per-click, is the average revenue from e-commerce sales and/or goal value you received for each click on one of your search ads.
ROI Decimal False True Returns on Investment is overall transaction profit divided by derived advertising cost.
Margin Decimal False True The overall transaction profit margin.
PercentNewSessions Double False The percentage of sessions by people who had never visited your property before.
NewUsers Integer False The number of users whose visit to your property was marked as a first-time session.
BounceRate Double False The percentage of single-page session.
PageviewsPerSession Double False The average number of pages viewed during a session on your property.
AvgSessionDuration Double False The average duration of user sessions represented in total seconds.
GoalConversionRateAll Double False The percentage of sessions that resulted in a conversion to at least one of your goals.
Transactions Integer False The total number of transactions.
RevenuePerTransaction Decimal False The average revenue for an e-commerce transaction.
TransactionRevenue Decimal False The total sale revenue provided in the transaction, excluding shipping and tax.
TransactionRevenuePerSession Decimal False Average transaction revenue for a session on your property.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



Ecommerce

Retrieves Ecommerce data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses ProductSku instead of the default Date dimension:

SELECT ProductSku, UniquePurchases, ItemQuantity FROM Ecommerce
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. The following query will find all product SKUs with more than 100 unique purchases:
SELECT ProductSku, UniquePurchases FROM Ecommerce WHERE UniquePurchases > 100
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM Ecommerce WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT Sessions, Users, Transactions, TransactionRevenue, TransactionShipping, TransactionTax, RevenuePerTransaction, UniquePurchases, ItemQuantity, ItemRevenue FROM Ecommerce
Columns

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.
ProductName String True The product name for purchased items, as supplied by your e-commerce tracking application.
ProductSku String True The product SKUs for purchased items, as you have defined them in your e-commerce tracking application.
ProductCategory String True Any product variations (e.g., size or color) for purchased items, as supplied by your e-commerce application.
TransactionId String True The transaction ID for the shopping cart purchase.
Sessions Integer False True Counts the total number of sessions.
Users Integer False True Total number of users to your property for the requested time period.
Transactions Integer False True The total number of transactions.
TransactionRevenue Decimal False True The total sale revenue provided in the transaction, excluding shipping and tax.
TransactionShipping Decimal False True The total cost of shipping.
TransactionTax Decimal False True The total amount of tax.
RevenuePerTransaction Decimal False True The average revenue for an e-commerce transaction.
UniquePurchases Integer False True The number of product sets purchased.
ItemQuantity Integer False True The total number of items purchased.
ItemRevenue Decimal False True The total revenue from purchased product items on your property.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



Events

Retrieves Event data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses EventLabel instead of the default EventCategory dimension:

SELECT EventLabel, TotalEvents, UniqueEvents, EventValue, SessionsWithEvent, AvgEventValue, EventsPerSessionWithEvent FROM Events
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will return all Events with less than or equal to 200 total events:
SELECT EventLabel, TotalEvents FROM Events WHERE TotalEvents <= 200
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM Events WHERE StartDate = '39daysAgo' AND EndDate = 'Today'
The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT EventCategory, TotalEvents, UniqueEvents, EventValue, SessionsWithEvent, AvgEventValue, EventsPerSessionWithEvent FROM Events
Columns

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.
EventCategory String True True The category of the event.
EventAction String True The action of the event.
EventLabel String True The label of the event.
TotalEvents Integer False True The total number of events for the profile, across all categories.
UniqueEvents Integer False True The total number of unique events for the profile, across all categories.
EventValue Long False True The total value of events for the profile.
SessionsWithEvent Integer False True The total number of sessions with events.
AvgEventValue Double False True The average value of an event.
EventsPerSessionWithEvent Double False True The average number of events per session with event.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



Global_Access_Object

Retrieves data for all the available dimensions and metrics.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
UserType String True A boolean, either New Visitor or Returning Visitor, indicating if the users are new or returning.
SessionCount String True The session index for a user. Each session from a unique user will get its own incremental index starting from 1 for the first session. Subsequent sessions do not change previous session indices. For example, if a user has 4 sessions to the website, sessionCount for that user will have 4 distinct values of '1' through '4'.
DaysSinceLastSession String True The number of days elapsed since users last visited the property, used to calculate user loyalty.
UserDefinedValue String True The value provided when defining custom user segments for the property.
UserBucket String True Randomly assigned users tag to allow A/B testing and splitting of remarketing lists. Ranges from 1-100.
SessionDurationBucket String True The length (returned as a string) of a session measured in seconds and reported in second increments.
ReferralPath String True The path of the referring URL (e.g., document.referrer). If someone places on their webpage a link to the property, this is the path of the page containing the referring link.
FullReferrer String True The full referring URL including the hostname and path.
Campaign String True For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set).
Source String True The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct).
Medium String True The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none).
SourceMedium String True Combined values of ga:source and ga:medium.
Keyword String True For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).
AdContent String True For manual campaign tracking, it is the value of the utm_content campaign tracking parameter. For AdWords autotagging, it is the first line of the text for the online Ad campaign. If you use mad libs for the AdWords content, it contains the keywords you provided for the mad libs keyword match. If you use none of the above, its value is (not set).
SocialNetwork String True The social network name. This is related to the referring social network for traffic sources; e.g., Google+, Blogger.
HasSocialSourceReferral String True A boolean, either Yes or No, indicates whether sessions to the property are from a social source.
AdGroup String True The name of the AdWords ad group.
AdSlot String True The location (Top, RHS, or not set) of the advertisement on the hosting page.
AdDistributionNetwork String True The network (Content, Search, Search partners, etc.) used to deliver the ads.
AdMatchType String True The match type (Phrase, Exact, Broad, etc.) applied for users' search term.
AdKeywordMatchType String True The match type (Phrase, Exact, or Broad) applied to the keywords. For details, see https://support.google.com/adwords/answer/2472708.
AdMatchedQuery String True The search query that triggered impressions.
AdPlacementDomain String True The domain where the ads on the content network were placed.
AdPlacementUrl String True The URL where the ads were placed on the content network.
AdFormat String True The AdWords ad format (Text, Image, Flash, Video, etc.).
AdTargetingType String True This (keyword, placement, or vertical targeting) indicates how the AdWords ads were targeted.
AdTargetingOption String True It is Automatic placements or Managed placements, indicating how the ads were managed on the content network.
AdDisplayUrl String True The URL the AdWords ads displayed.
AdDestinationUrl String True The URL to which the AdWords ads referred traffic.
AdwordsCustomerID String True Customer's AdWords ID, corresponding to AdWords API AccountInfo.customerId.
AdwordsCampaignID String True AdWords API Campaign.id.
AdwordsAdGroupID String True AdWords API AdGroup.id.
AdwordsCreativeID String True AdWords API Ad.id.
AdwordsCriteriaID String True AdWords API Criterion.id. The geographical targeting Criteria IDs are listed at https://developers.google.com/analytics/devguides/collection/protocol/v1/geoid.
AdQueryWordCount String True The number of words in the search query.
GoalCompletionLocation String True The page path or screen name that matched any destination type goal completion.
GoalPreviousStep1 String True The page path or screen name that matched any destination type goal, one step prior to the goal completion location.
GoalPreviousStep2 String True The page path or screen name that matched any destination type goal, two steps prior to the goal completion location.
GoalPreviousStep3 String True The page path or screen name that matched any destination type goal, three steps prior to the goal completion location.
Browser String True The name of users' browsers, for example, Internet Explorer or Firefox.
BrowserVersion String True The version of users' browsers, for example, 2.0.0.14.
OperatingSystem String True Users' operating system, for example, Windows, Linux, Macintosh, or iOS.
OperatingSystemVersion String True The version of users' operating system, i.e., XP for Windows, PPC for Macintosh.
MobileDeviceBranding String True Mobile manufacturer or branded name.
MobileDeviceModel String True Mobile device model.
MobileInputSelector String True Selector (e.g., touchscreen, joystick, clickwheel, stylus) used on the mobile device.
MobileDeviceInfo String True The branding, model, and marketing name used to identify the mobile device.
MobileDeviceMarketingName String True The marketing name used for the mobile device.
DeviceCategory String True The type of device: desktop, tablet, or mobile.
Continent String True Users' continent, derived from users' IP addresses or Geographical IDs.
SubContinent String True Users' sub-continent, derived from their IP addresses or Geographical IDs. For example, Polynesia or Northern Europe.
Country String True Users' country, derived from their IP addresses or Geographical IDs.
Region String True Users' region, derived from their IP addresses or Geographical IDs. In U.S., a region is a state, New York, for example.
Metro String True The Designated Market Area (DMA) from where traffic arrived.
City String True Users' city, derived from their IP addresses or Geographical IDs.
Latitude String True The approximate latitude of users' city, derived from their IP addresses or Geographical IDs. Locations north of the equator have positive latitudes and locations south of the equator have negative latitudes.
Longitude String True The approximate longitude of users' city, derived from their IP addresses or Geographical IDs. Locations east of the prime meridian have positive longitudes and locations west of the prime meridian have negative longitudes.
NetworkDomain String True The domain name of users' ISP, derived from the domain name registered to the ISP's IP address.
NetworkLocation String True The names of the service providers used to reach the property. For example, if most users of the website come via the major cable internet service providers, its value will be these service providers' names.
FlashVersion String True The version of Flash, including minor versions, supported by users' browsers.
JavaEnabled String True A boolean, either Yes or No, indicating whether Java is enabled in users' browsers.
Language String True The language, in ISO-639 code format (e.g., en-gb for British English), provided by the HTTP Request for the browser.
ScreenColors String True The color depth of users' monitors, retrieved from the DOM of users' browsers. For example, 4-bit, 8-bit, 24-bit, or undefined-bit.
SourcePropertyDisplayName String True Source property display name of roll-up properties. This is valid for only roll-up properties.
SourcePropertyTrackingId String True Source property tracking ID of roll-up properties. This is valid for only roll-up properties.
ScreenResolution String True Resolution of users' screens, for example, 1024x738.
Hostname String True The hostname from which the tracking request was made.
PagePath String True A page on the website specified by path and/or query parameters. Use this with hostname to get the page's full URL.
PagePathLevel1 String True This dimension rolls up all the page paths in the first hierarchical level in pagePath.
PagePathLevel2 String True This dimension rolls up all the page paths in the second hierarchical level in pagePath.
PagePathLevel3 String True This dimension rolls up all the page paths in the third hierarchical level in pagePath.
PagePathLevel4 String True This dimension rolls up all the page paths into hierarchical levels. Up to 4 pagePath levels maybe specified. All additional levels in the pagePath hierarchy are also rolled up in this dimension.
PageTitle String True The page's title. Multiple pages might have the same page title.
LandingPagePath String True The first page in users' sessions, or the landing page.
SecondPagePath String True The second page in users' sessions.
ExitPagePath String True The last page or exit page in users' sessions.
PreviousPagePath String True A page visited before another page on the same property, typically used with the pagePath dimension.
PageDepth String True The number of pages visited by users during a session. The value is a histogram that counts pageviews across a range of possible values. In this calculation, all sessions will have at least one pageview, and some percentage of sessions will have more.
SearchUsed String True A boolean, either Visits With Site Search or Visits Without Site Search, to distinguish whether internal search was used in a session.
SearchKeyword String True Search term used within the property.
SearchKeywordRefinement String True Subsequent keyword search term or string entered by users after a given initial string search.
SearchCategory String True The category used for the internal search if site search categories are enabled in the view. For example, the product category may be electronics, furniture, or clothing.
SearchStartPage String True The page where users initiated an internal search.
SearchDestinationPage String True The page users immediately visited after performing an internal search on the site. This is usually the search results page.
SearchAfterDestinationPage String True The page that users visited after performing an internal search on the site.
AppInstallerId String True The ID of the app installer (e.g., Google Play Store) from which the app was downloaded. By default, the app installer ID is set by the PackageManager#getInstallerPackageName method.
AppVersion String True The application version.
AppName String True The application name.
AppId String True The application ID.
ScreenName String True The name of the screen.
ScreenDepth String True The number of screenviews (reported as a string) per session, useful for historgrams.
LandingScreenName String True The name of the first viewed screen.
ExitScreenName String True The name of the screen where users exited the application.
EventCategory String True The event category.
EventAction String True Event action.
EventLabel String True Event label.
TransactionId String True The transaction ID, supplied by the ecommerce tracking method, for the purchase in the shopping cart.
Affiliation String True A product affiliation to designate a supplying company or brick and mortar location.
SessionsToTransaction String True The number of sessions between users' purchases and the related campaigns that lead to the purchases.
DaysToTransaction String True The number of days between users' purchases and the most recent campaign source prior to the purchase.
ProductSku String True The product SKU, defined in the ecommerce tracking application, for purchased items.
ProductName String True The product name, supplied by the ecommerce tracking application, for purchased items.
ProductCategory String True Any product variation (size, color) supplied by the ecommerce application for purchased items, not compatible with Enhanced Ecommerce.
CurrencyCode String True The local currency code (based on ISO 4217 standard) of the transaction.
SocialInteractionNetwork String True For social interactions, this represents the social network being tracked.
SocialInteractionAction String True For social interactions, this is the social action (e.g., +1, bookmark) being tracked.
SocialInteractionNetworkAction String True For social interactions, this is the concatenation of the socialInteractionNetwork and socialInteractionAction action (e.g., Google: +1) being tracked at this hit level.
SocialInteractionTarget String True For social interactions, this is the URL (or resource) which receives the social network action.
SocialEngagementType String True Engagement type.
UserTimingCategory String True For easier reporting purposes, this is used to categorize all user timing variables into logical groups.
UserTimingLabel String True The name of the resource's action being tracked.
UserTimingVariable String True Used to add flexibility to visualize user timings in the reports.
ExceptionDescription String True The description for the exception.
ExperimentId String True The user-scoped ID of the content experiment that users were exposed to when the metrics were reported.
ExperimentVariant String True The user-scoped ID of the particular variant that users were exposed to during a content experiment.
Date String True The date of the session formatted as YYYYMMDD.
Year String True The year of the session, a four-digit year from 2005 to the current year.
Month String True Month of the session, a two digit integer from 01 to 12.
Week String True The week of the session, a two-digit number from 01 to 53. Each week starts on Sunday.
Day String True The day of the month, a two-digit number from 01 to 31.
Hour String 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. If the timezone follows daylight savings time, there will be an apparent bump in the number of sessions during the changeover hour (e.g., between 1:00 and 2:00) for the day per year when that hour repeats. A corresponding hour with zero sessions will occur at the opposite changeover. (Google Analytics does not track user time more precisely than hours.)
Minute String True Returns the minutes, between 00 and 59, in the hour.
NthMonth String True The index for a month in the specified date range. In the date range, the index for the first month is 0, for the second month 1, and so on.
NthWeek String True The index for each week in the specified date range. The index for the first week in the date range is 0, for the second week 1, and so on. The index corresponds to week entries.
NthDay String True The index for each day in the specified date range. The index for the first day (i.e., start-date) in the date range is 0, for the second day 1, and so on.
NthMinute String True The index for each minute in the specified date range. The index for the first minute of the first day (i.e., start-date) in the date range is 0, for the next minute 1, and so on.
DayOfWeek String True Day of the week, a one-digit number from 0 (Sunday) to 6 (Saturday).
DayOfWeekName String True Name (in English) of the day of the week.
DateHour String True Combined values of ga:date and ga:hour formated as YYYYMMDDHH.
DateHourMinute String True Combined values of ga:date, ga:hour and ga:minute formated as YYYYMMDDHHMM.
YearMonth String True Combined values of ga:year and ga:month.
YearWeek String True Combined values of ga:year and ga:week.
IsoWeek String True ISO week number, where each week starts on Monday. For details, see http://en.wikipedia.org/wiki/ISO_week_date. ga:isoWeek should only be used with ga:isoYear because ga:year represents Gregorian calendar.
IsoYear String True The ISO year of the session. For details, see http://en.wikipedia.org/wiki/ISO_week_date. ga:isoYear should only be used with ga:isoWeek because ga:week represents Gregorian calendar.
IsoYearIsoWeek String True Combined values of ga:isoYear and ga:isoWeek.
DcmClickAd String True DCM ad name of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickAdId String True DCM ad ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickAdType String True DCM ad type name of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickAdTypeId String True DCM ad type ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickAdvertiser String True DCM advertiser name of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickAdvertiserId String True DCM advertiser ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickCampaign String True DCM campaign name of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickCampaignId String True DCM campaign ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickCreativeId String True DCM creative ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickCreative String True DCM creative name of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickRenderingId String True DCM rendering ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickCreativeType String True DCM creative type name of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickCreativeTypeId String True DCM creative type ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickCreativeVersion String True DCM creative version of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickSite String True Site name where the DCM creative was shown and clicked on for the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickSiteId String True DCM site ID where the DCM creative was shown and clicked on for the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickSitePlacement String True DCM site placement name of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickSitePlacementId String True DCM site placement ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmClickSpotId String True DCM Floodlight configuration ID of the DCM click matching the Google Analytics session (Analytics 360 only).
DcmFloodlightActivity String True DCM Floodlight activity name associated with the floodlight conversion (Analytics 360 only).
DcmFloodlightActivityAndGroup String True DCM Floodlight activity name and group name associated with the floodlight conversion (Analytics 360 only).
DcmFloodlightActivityGroup String True DCM Floodlight activity group name associated with the floodlight conversion (Analytics 360 only).
DcmFloodlightActivityGroupId String True DCM Floodlight activity group ID associated with the floodlight conversion (Analytics 360 only).
DcmFloodlightActivityId String True DCM Floodlight activity ID associated with the floodlight conversion (Analytics 360 only).
DcmFloodlightAdvertiserId String True DCM Floodlight advertiser ID associated with the floodlight conversion (Analytics 360 only).
DcmFloodlightSpotId String True DCM Floodlight configuration ID associated with the floodlight conversion (Analytics 360 only).
DcmLastEventAd String True DCM ad name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventAdId String True DCM ad ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventAdType String True DCM ad type name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventAdTypeId String True DCM ad type ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventAdvertiser String True DCM advertiser name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventAdvertiserId String True DCM advertiser ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventAttributionType String True There are two possible values: ClickThrough and ViewThrough. If the last DCM event associated with the Google Analytics session was a click, then the value will be ClickThrough. If the last DCM event associated with the Google Analytics session was an ad impression, then the value will be ViewThrough (Analytics 360 only).
DcmLastEventCampaign String True DCM campaign name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventCampaignId String True DCM campaign ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventCreativeId String True DCM creative ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventCreative String True DCM creative name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventRenderingId String True DCM rendering ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventCreativeType String True DCM creative type name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventCreativeTypeId String True DCM creative type ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventCreativeVersion String True DCM creative version of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventSite String True Site name where the DCM creative was shown and clicked on for the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventSiteId String True DCM site ID where the DCM creative was shown and clicked on for the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventSitePlacement String True DCM site placement name of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventSitePlacementId String True DCM site placement ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
DcmLastEventSpotId String True DCM Floodlight configuration ID of the last DCM event (impression or click within the DCM lookback window) associated with the Google Analytics session (Analytics 360 only).
LandingContentGroup1 String True Content group of users' landing pages.
LandingContentGroup2 String True Content group of users' landing pages.
LandingContentGroup3 String True Content group of users' landing pages.
LandingContentGroup4 String True Content group of users' landing pages.
LandingContentGroup5 String True Content group of users' landing pages.
LandingContentGroup6 String True Content group of users' landing pages.
LandingContentGroup7 String True Content group of users' landing pages.
LandingContentGroup8 String True Content group of users' landing pages.
LandingContentGroup9 String True Content group of users' landing pages.
LandingContentGroup10 String True Content group of users' landing pages.
LandingContentGroup11 String True Content group of users' landing pages.
LandingContentGroup12 String True Content group of users' landing pages.
LandingContentGroup13 String True Content group of users' landing pages.
LandingContentGroup14 String True Content group of users' landing pages.
LandingContentGroup15 String True Content group of users' landing pages.
LandingContentGroup16 String True Content group of users' landing pages.
LandingContentGroup17 String True Content group of users' landing pages.
LandingContentGroup18 String True Content group of users' landing pages.
LandingContentGroup19 String True Content group of users' landing pages.
LandingContentGroup20 String True Content group of users' landing pages.
PreviousContentGroup1 String True Refers to content group that was visited before another content group.
PreviousContentGroup2 String True Refers to content group that was visited before another content group.
PreviousContentGroup3 String True Refers to content group that was visited before another content group.
PreviousContentGroup4 String True Refers to content group that was visited before another content group.
PreviousContentGroup5 String True Refers to content group that was visited before another content group.
PreviousContentGroup6 String True Refers to content group that was visited before another content group.
PreviousContentGroup7 String True Refers to content group that was visited before another content group.
PreviousContentGroup8 String True Refers to content group that was visited before another content group.
PreviousContentGroup9 String True Refers to content group that was visited before another content group.
PreviousContentGroup10 String True Refers to content group that was visited before another content group.
PreviousContentGroup11 String True Refers to content group that was visited before another content group.
PreviousContentGroup12 String True Refers to content group that was visited before another content group.
PreviousContentGroup13 String True Refers to content group that was visited before another content group.
PreviousContentGroup14 String True Refers to content group that was visited before another content group.
PreviousContentGroup15 String True Refers to content group that was visited before another content group.
PreviousContentGroup16 String True Refers to content group that was visited before another content group.
PreviousContentGroup17 String True Refers to content group that was visited before another content group.
PreviousContentGroup18 String True Refers to content group that was visited before another content group.
PreviousContentGroup19 String True Refers to content group that was visited before another content group.
PreviousContentGroup20 String True Refers to content group that was visited before another content group.
ContentGroup1 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup2 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup3 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup4 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup5 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup6 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup7 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup8 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup9 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup10 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup11 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup12 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup13 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup14 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup15 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup16 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup17 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup18 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup19 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
ContentGroup20 String True The content group on a property. A content group is a collection of content providing a logical structure that can be determined by tracking code or page title/URL regex match, or predefined rules.
UserAgeBracket String True Age bracket of users.
UserGender String True Gender of users.
InterestOtherCategory String True Indicates that users are more likely to be interested in learning about the specified category, and more likely to be ready to purchase.
InterestAffinityCategory String True Indicates that users are more likely to be interested in learning about the specified category.
InterestInMarketCategory String True Indicates that users are more likely to be ready to purchase products or services in the specified category.
DfpLineItemId String True The ID of the Google Ad Manager line item.
DfpLineItemName String True The name of the Google Ad Manager line item.
AcquisitionCampaign String True The campaign through which users were acquired, derived from users' first session.
AcquisitionMedium String True The medium through which users were acquired, derived from users' first session.
AcquisitionSource String True The source through which users were acquired, derived from users' first session.
AcquisitionSourceMedium String True The combined value of ga:userAcquisitionSource and ga:acquisitionMedium.
AcquisitionTrafficChannel String True Traffic channel through which users were acquired. It is extracted from users' first session. Traffic channel is computed based on the default channel grouping rules (at view level if available) at the time of user acquisition.
BrowserSize String True The viewport size of users' browsers. A session-scoped dimension, browser size captures the initial dimensions of the viewport in pixels and is formatted as width x height, for example, 1920x960.
CampaignCode String True For manual campaign tracking, it is the value of the utm_id campaign tracking parameter.
ChannelGrouping String True The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
CheckoutOptions String True User options specified during the checkout process, e.g., FedEx, DHL, UPS for delivery options; Visa, MasterCard, AmEx for payment options. This dimension should be used with ga:shoppingStage (Enhanced Ecommerce).
CityId String True Users' city ID, derived from their IP addresses or Geographical IDs. The city IDs are the same as the Criteria IDs found at https://developers.google.com/analytics/devguides/collection/protocol/v1/geoid.
Cohort String True Name of the cohort to which a user belongs. Depending on how cohorts are defined, a user can belong to multiple cohorts, similar to how a user can belong to multiple segments.
CohortNthDay String True Day offset relative to the cohort definition date. For example, if a cohort is defined with the first visit date as 2015-09-01, then for the date 2015-09-04, ga:cohortNthDay will be 3.
CohortNthMonth String True Month offset relative to the cohort definition date. The semantics of this dimension differs based on whether lifetime value is requested or not. For a cohorts report not requesting lifetime value: This is the week offset from the cohort definition start date. For example, if cohort is defined as 2015-09-01<= first session date<= 2015-09-30. Then, for 2015-09-01<= date<= 2015-09-30, ga:cohortNthMonth = 0. 2015-10-01<= date<= 2015-10-31, ga:cohortNthMonth = 2. and so on. For a cohorts request requesting lifetime value: ga:cohortNthMonth is calculated relative to the users acquisition date. It is not dependent on the cohort definition date. For example, if we define a cohort as 2015-10-01<= first session date<= 2015-09-30. And a user was acquired on 2015-09-04. Then, for 2015-09-04<= date<= 2015-10-04, ga:cohortNthMonth = 0 2015-10-04<= date<= 2015-11-04, ga:cohortNthMonth = 1, and so on.
CohortNthWeek String True Week offset relative to the cohort definition date. The semantics of this dimension differs based on whether lifetime value is requested or not. For a cohorts report not requesting lifetime value: This is the week offset from the cohort definition start date. For example, if cohort is defined as 2015-09-01<= first session date<= 2015-09-07. Then, for 2015-09-01<= date<= 2015-09-07, ga:cohortNthWeek = 0. 2015-09-08<= date<= 2015-09-14, ga:cohortNthWeek = 1. etc. For a cohorts request requesting lifetime value: ga:cohortNthWeek is calculated relative to the users acquisition date. It is not dependent on the cohort definition date. For example, if we define a cohort as 2015-09-01<= first session date<= 2015-09-07. And a user was acquired on 2015-09-04. Then, for 2015-09-04<= date<= 2015-09-10, ga:cohortNthWeek = 0 2015-09-11<= date<= 2015-09-17, ga:cohortNthWeek = 1
ContinentId String True Users' continent ID, derived from users' IP addresses or Geographical IDs.
CountryIsoCode String True Users' country's ISO code (in ISO-3166-1 alpha-2 format), derived from their IP addresses or Geographical IDs. For example, BR for Brazil, CA for Canada.
DataSource String True The data source of a hit. By default, hits sent from analytics.js are reported as
DbmClickAdvertiser String True DBM advertiser name of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickAdvertiserId String True DBM advertiser ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickCreativeId String True DBM creative ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickExchange String True DBM exchange name of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickExchangeId String True DBM exchange ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickInsertionOrder String True DBM insertion order name of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickInsertionOrderId String True DBM insertion order ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickLineItem String True DBM line item name of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickLineItemId String True DBM line item ID of the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickSite String True DBM site name where the DBM creative was shown and clicked on for the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmClickSiteId String True DBM site ID where the DBM creative was shown and clicked on for the DBM click matching the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventAdvertiser String True DBM advertiser name of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventAdvertiserId String True DBM advertiser ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventCreativeId String True DBM creative ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventExchange String True DBM exchange name of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventExchangeId String True DBM exchange ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventInsertionOrder String True DBM insertion order name of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventInsertionOrderId String True DBM insertion order ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventLineItem String True DBM line item name of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventLineItemId String True DBM line item ID of the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventSite String True DBM site name where the DBM creative was shown and clicked on for the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DbmLastEventSiteId String True DBM site ID where the DBM creative was shown and clicked on for the last DBM event (impression or click within the DBM lookback window) associated with the Google Analytics session (Analytics 360 only, requires integration with DBM).
DsAdGroup String True DS Ad Group (Analytics 360 only, requires integration with DS).
DsAdGroupId String True DS Ad Group ID (Analytics 360 only, requires integration with DS).
DsAdvertiser String True DS Advertiser (Analytics 360 only, requires integration with DS).
DsAdvertiserId String True DS Advertiser ID (Analytics 360 only, requires integration with DS).
DsAgency String True DS Agency (Analytics 360 only, requires integration with DS).
DsAgencyId String True DS Agency ID (Analytics 360 only, requires integration with DS).
DsCampaign String True DS Campaign (Analytics 360 only, requires integration with DS).
DsCampaignId String True DS Campaign ID (Analytics 360 only, requires integration with DS).
DsEngineAccount String True DS Engine Account (Analytics 360 only, requires integration with DS).
DsEngineAccountId String True DS Engine Account ID (Analytics 360 only, requires integration with DS).
DsKeyword String True DS Keyword (Analytics 360 only, requires integration with DS).
DsKeywordId String True DS Keyword ID (Analytics 360 only, requires integration with DS).
ExperimentCombination String True The user-scoped ID of the experiment and variant that users were exposed to during an experiment.
ExperimentName String True The user-scoped name of the content experiment that users were exposed to when the metrics were reported.
InternalPromotionCreative String True The creative content designed for a promotion (Enhanced Ecommerce).
InternalPromotionId String True The ID of the promotion (Enhanced Ecommerce).
InternalPromotionName String True The name of the promotion (Enhanced Ecommerce).
InternalPromotionPosition String True The position of the promotion on the web page or application screen (Enhanced Ecommerce).
IsTrueViewVideoAd String True A boolean, Yes or No, indicating whether the ad is an AdWords TrueView video ad.
MetroId String True The three digit Designated Market Area (DMA) code from where traffic arrived, derived from users' IP addresses or Geographical IDs.
NthHour String True The index for each hour in the specified date range. The index for the first hour of the first day (i.e., start-date) in the date range is 0, for the next hour 1, and so on.
OrderCouponCode String True Code for the order-level coupon (Enhanced Ecommerce).
ProductBrand String True The brand name under which the product is sold (Enhanced Ecommerce).
ProductCategoryHierarchy String True The hierarchical category in which the product is classified (Enhanced Ecommerce).
ProductCategoryLevel1 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel2 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel3 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel4 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel5 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel6 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel7 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel8 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel9 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel10 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel11 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel12 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel13 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel14 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel15 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel16 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel17 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel18 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel19 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCategoryLevel20 String True Level (1-5) in the product category hierarchy, starting from the top (Enhanced Ecommerce).
ProductCouponCode String True Code for the product-level coupon (Enhanced Ecommerce).
ProductListName String True The name of the product list in which the product appears (Enhanced Ecommerce).
ProductListPosition String True The position of the product in the product list (Enhanced Ecommerce).
ProductVariant String True The specific variation of a product, e.g., XS, S, M, L for size; or Red, Blue, Green, Black for color (Enhanced Ecommerce).
RegionId String True Users' region ID, derived from their IP addresses or Geographical IDs. In U.S., a region is a state, New York, for example. The region IDs are the same as the Criteria IDs listed at https://developers.google.com/analytics/devguides/collection/protocol/v1/geoid.
RegionIsoCode String True Users' region ISO code in ISO-3166-2 format, derived from their IP addresses or Geographical IDs.
ShoppingStage String True Various stages of the shopping experience that users completed in a session, e.g., PRODUCT_VIEW, ADD_TO_CART, CHECKOUT, etc. (Enhanced Ecommerce).
SubContinentCode String True Users' sub-continent code in UN M.49 format, derived from their IP addresses or Geographical IDs. For example, 061 for Polynesia, 154 for Northern Europe.
Dimension1 String True The value of the requested custom dimension-01.
Dimension2 String True The value of the requested custom dimension-02.
Dimension3 String True The value of the requested custom dimension-03.
dimension4 String True The value of the requested custom dimension-04.
dimension5 String True The value of the requested custom dimension-05.
Dimension6 String True The value of the requested custom dimension-06.
Dimension7 String True The value of the requested custom dimension-07.
Dimension8 String True The value of the requested custom dimension-08.
Dimension9 String True The value of the requested custom dimension-09.
Dimension10 String True The value of the requested custom dimension-10.
Dimension11 String True The value of the requested custom dimension-11.
Dimension12 String True The value of the requested custom dimension-12.
Dimension13 String True The value of the requested custom dimension-13.
Dimension14 String True The value of the requested custom dimension-14.
Dimension15 String True The value of the requested custom dimension-15.
Dimension16 String True The value of the requested custom dimension-16.
Dimension17 String True The value of the requested custom dimension-17.
Dimension18 String True The value of the requested custom dimension-18.
Dimension19 String True The value of the requested custom dimension-19.
Dimension20 String True The value of the requested custom dimension-20.
CustomVarName1 String True The name for the requested custom variable-01.
CustomVarName2 String True The name for the requested custom variable-02.
CustomVarName3 String True The name for the requested custom variable-03.
CustomVarName4 String True The name for the requested custom variable-04.
CustomVarName5 String True The name for the requested custom variable-05.
CustomVarValue1 String True The value for the requested custom variable-01.
CustomVarValue2 String True The value for the requested custom variable-02.
CustomVarValue3 String True The value for the requested custom variable-03.
CustomVarValue4 String True The value for the requested custom variable-04.
CustomVarValue5 String True The value for the requested custom variable-05.
Users Integer False The total number of users for the requested time period.
NewUsers Integer False The number of sessions marked as a user's first sessions.
PercentNewSessions Decimal False The percentage of sessions by users who had never visited the property before.
1dayUsers Integer False Total number of 1-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension to query this metric. For a given date, the returned value will be the total number of unique users for the 1-day period ending on the given date.
7dayUsers Integer False Total number of 7-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension to query this metric. For a given date, the returned value will be the total number of unique users for the 7-day period ending on the given date.
14dayUsers Integer False Total number of 14-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension to query this metric. For a given date, the returned value will be the total number of unique users for the 14-day period ending on the given date.
28dayUsers Integer False Total number of 28-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension to query this metric. For a given date, the returned value will be the total number of unique users for the 28-day period ending on the given date.
30dayUsers Integer False Total number of 30-day active users for each day in the requested time period. At least one of ga:nthDay, ga:date, or ga:day must be specified as a dimension to query this metric. For a given date, the returned value will be the total number of unique users for the 30-day period ending on the given date.
Sessions Integer False The total number of sessions.
Bounces Integer False The total number of single page (or single interaction hit) sessions for the property.
BounceRate Decimal False The percentage of single-page session (i.e., session in which the person left the property from the first page).
SessionDuration String False Total duration (in seconds) of users' sessions.
AvgSessionDuration String False The average duration (in seconds) of users' sessions.
OrganicSearches Integer False The number of organic searches happened in a session. This metric is search engine agnostic.
Impressions Integer False Total number of campaign impressions.
AdClicks Integer False Total number of times users have clicked on an ad to reach the property.
AdCost Decimal False Derived cost for the advertising campaign. Its currency is the one you set in the AdWords account.
CPM Decimal False Cost per thousand impressions.
CPC Decimal False Cost to advertiser per click.
CTR Decimal False Click-through-rate for the ad. This is equal to the number of clicks divided by the number of impressions for the ad (e.g., how many times users clicked on one of the ads where that ad appeared).
CostPerTransaction Decimal False The cost per transaction for the property.
CostPerGoalConversion Decimal False The cost per goal conversion for the property.
CostPerConversion Decimal False The cost per conversion (including ecommerce and goal conversions) for the property.
RPC Decimal False RPC or revenue-per-click, the average revenue (from ecommerce sales and/or goal value) you received for each click on one of the search ads.
ROAS Decimal False Return On Ad Spend (ROAS) is the total transaction revenue and goal value divided by derived advertising cost.
Goal1Starts Integer False The total number of starts for the requested goal number.
Goal2Starts Integer False The total number of starts for the requested goal number.
Goal3Starts Integer False The total number of starts for the requested goal number.
Goal4Starts Integer False The total number of starts for the requested goal number.
Goal5Starts Integer False The total number of starts for the requested goal number.
Goal6Starts Integer False The total number of starts for the requested goal number.
Goal7Starts Integer False The total number of starts for the requested goal number.
Goal8Starts Integer False The total number of starts for the requested goal number.
Goal9Starts Integer False The total number of starts for the requested goal number.
Goal10Starts Integer False The total number of starts for the requested goal number.
Goal11Starts Integer False The total number of starts for the requested goal number.
Goal12Starts Integer False The total number of starts for the requested goal number.
Goal13Starts Integer False The total number of starts for the requested goal number.
Goal14Starts Integer False The total number of starts for the requested goal number.
Goal15Starts Integer False The total number of starts for the requested goal number.
Goal16Starts Integer False The total number of starts for the requested goal number.
Goal17Starts Integer False The total number of starts for the requested goal number.
Goal18Starts Integer False The total number of starts for the requested goal number.
Goal19Starts Integer False The total number of starts for the requested goal number.
Goal20Starts Integer False The total number of starts for the requested goal number.
GoalStartsAll Integer False Total number of starts for all goals defined in the profile.
Goal1Completions Integer False The total number of completions for the requested goal number.
Goal2Completions Integer False The total number of completions for the requested goal number.
Goal3Completions Integer False The total number of completions for the requested goal number.
Goal4Completions Integer False The total number of completions for the requested goal number.
Goal5Completions Integer False The total number of completions for the requested goal number.
Goal6Completions Integer False The total number of completions for the requested goal number.
Goal7Completions Integer False The total number of completions for the requested goal number.
Goal8Completions Integer False The total number of completions for the requested goal number.
Goal9Completions Integer False The total number of completions for the requested goal number.
Goal10Completions Integer False The total number of completions for the requested goal number.
Goal11Completions Integer False The total number of completions for the requested goal number.
Goal12Completions Integer False The total number of completions for the requested goal number.
Goal13Completions Integer False The total number of completions for the requested goal number.
Goal14Completions Integer False The total number of completions for the requested goal number.
Goal15Completions Integer False The total number of completions for the requested goal number.
Goal16Completions Integer False The total number of completions for the requested goal number.
Goal17Completions Integer False The total number of completions for the requested goal number.
Goal18Completions Integer False The total number of completions for the requested goal number.
Goal19Completions Integer False The total number of completions for the requested goal number.
Goal20Completions Integer False The total number of completions for the requested goal number.
GoalCompletionsAll Integer False Total number of completions for all goals defined in the profile.
Goal1Value Decimal False The total numeric value for the requested goal number.
Goal2Value Decimal False The total numeric value for the requested goal number.
Goal3Value Decimal False The total numeric value for the requested goal number.
Goal4Value Decimal False The total numeric value for the requested goal number.
Goal5Value Decimal False The total numeric value for the requested goal number.
Goal6Value Decimal False The total numeric value for the requested goal number.
Goal7Value Decimal False The total numeric value for the requested goal number.
Goal8Value Decimal False The total numeric value for the requested goal number.
Goal9Value Decimal False The total numeric value for the requested goal number.
Goal10Value Decimal False The total numeric value for the requested goal number.
Goal11Value Decimal False The total numeric value for the requested goal number.
Goal12Value Decimal False The total numeric value for the requested goal number.
Goal13Value Decimal False The total numeric value for the requested goal number.
Goal14Value Decimal False The total numeric value for the requested goal number.
Goal15Value Decimal False The total numeric value for the requested goal number.
Goal16Value Decimal False The total numeric value for the requested goal number.
Goal17Value Decimal False The total numeric value for the requested goal number.
Goal18Value Decimal False The total numeric value for the requested goal number.
Goal19Value Decimal False The total numeric value for the requested goal number.
Goal20Value Decimal False The total numeric value for the requested goal number.
GoalValueAll Decimal False Total numeric value for all goals defined in the profile.
GoalValuePerSession Decimal False The average goal value of a session.
Goal1ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal2ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal3ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal4ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal5ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal6ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal7ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal8ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal9ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal10ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal11ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal12ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal13ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal14ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal15ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal16ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal17ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal18ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal19ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
Goal20ConversionRate Decimal False Percentage of sessions resulting in a conversion to the requested goal number.
GoalConversionRateAll Decimal False The percentage of sessions which resulted in a conversion to at least one of the goals.
Goal1Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal2Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal3Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal4Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal5Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal6Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal7Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal8Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal9Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal10Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal11Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal12Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal13Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal14Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal15Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal16Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal17Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal18Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal19Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
Goal20Abandons Integer False The number of times users started conversion activity on the requested goal number without actually completing it.
GoalAbandonsAll Integer False The overall number of times users started goals without actually completing them.
Goal1AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal2AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal3AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal4AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal5AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal6AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal7AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal8AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal9AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal10AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal11AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal12AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal13AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal14AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal15AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal16AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal17AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal18AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal19AbandonRate Decimal False The rate at which the requested goal number was abandoned.
Goal20AbandonRate Decimal False The rate at which the requested goal number was abandoned.
GoalAbandonRateAll Decimal False Goal abandonment rate.
PageValue Decimal False The average value of this page or set of pages, which is equal to (ga:transactionRevenue + ga:goalValueAll) / ga:uniquePageviews.
Entrances Integer False The number of entrances to the property measured as the first pageview in a session, typically used with landingPagePath.
EntranceRate Decimal False The percentage of pageviews in which this page was the entrance.
Pageviews Integer False The total number of pageviews for the property.
PageviewsPerSession Float False The average number of pages viewed during a session, including repeated views of a single page.
ContentGroupUniqueViews1 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews2 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews3 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews4 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews5 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews6 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews7 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews8 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews9 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews10 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews11 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews12 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews13 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews14 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews15 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews16 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews17 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews18 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews19 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
ContentGroupUniqueViews20 Integer False The number of unique content group views. Content group views in different sessions are counted as unique content group views. Both the pagePath and pageTitle are used to determine content group view uniqueness.
UniquePageviews Integer False Unique Pageviews is the number of sessions during which the specified page was viewed at least once. A unique pageview is counted for each page URL + page title combination.
TimeOnPage String False Time (in seconds) users spent on a particular page, calculated by subtracting the initial view time for a particular page from the initial view time for a subsequent page. This metric does not apply to exit pages of the property.
AvgTimeOnPage String False The average time users spent viewing this page or a set of pages.
Exits Integer False The number of exits from the property.
ExitRate Decimal False The percentage of exits from the property that occurred out of the total pageviews.
SearchResultViews Integer False The number of times a search result page was viewed.
SearchUniques Integer False Total number of unique keywords from internal searches within a session. For example, if
AvgSearchResultViews Float False The average number of times people viewed a page as a result of a search.
SearchSessions Integer False The total number of sessions that included an internal search.
PercentSessionsWithSearch Decimal False The percentage of sessions with search.
SearchDepth Integer False The total number of subsequent page views made after a use of the site's internal search feature.
AvgSearchDepth Float False The average number of pages people viewed after performing a search.
SearchRefinements Integer False The total number of times a refinement (transition) occurs between internal keywords search within a session. For example, if the sequence of keywords is
PercentSearchRefinements Decimal False The percentage of the number of times a refinement (i.e., transition) occurs between internal keywords search within a session.
SearchDuration String False The session duration when the site's internal search feature is used.
AvgSearchDuration String False The average time (in seconds) users, after searching, spent on the property.
SearchExits Integer False The number of exits on the site that occurred following a search result from the site's internal search feature.
SearchExitRate Decimal False The percentage of searches that resulted in an immediate exit from the property.
SearchGoal1ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal2ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal3ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal4ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal5ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal6ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal7ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal8ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal9ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal10ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal11ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal12ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal13ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal14ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal15ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal16ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal17ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal18ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal19ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoal20ConversionRate Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to the requested goal number.
SearchGoalConversionRateAll Decimal False The percentage of search sessions (i.e., sessions that included at least one search) which resulted in a conversion to at least one of the goals.
GoalValueAllPerSearch Decimal False The average goal value of a search.
PageLoadTime Integer False Total time (in milliseconds), from pageview initiation (e.g., a click on a page link) to page load completion in the browser, the pages in the sample set take to load.
PageLoadSample Integer False The sample set (or count) of pageviews used to calculate the average page load time.
AvgPageLoadTime Float False The average time (in seconds) pages from the sample set take to load, from initiation of the pageview (e.g., a click on a page link) to load completion in the browser.
DomainLookupTime Integer False The total time (in milliseconds) all samples spent in DNS lookup for this page.
AvgDomainLookupTime Float False The average time (in seconds) spent in DNS lookup for this page.
PageDownloadTime Integer False The total time (in milliseconds) to download this page among all samples.
AvgPageDownloadTime Float False The average time (in seconds) to download this page.
RedirectionTime Integer False The total time (in milliseconds) all samples spent in redirects before fetching this page. If there are no redirects, this is 0.
AvgRedirectionTime Float False The average time (in seconds) spent in redirects before fetching this page. If there are no redirects, this is 0.
ServerConnectionTime Integer False Total time (in milliseconds) all samples spent in establishing a TCP connection to this page.
AvgServerConnectionTime Float False The average time (in seconds) spent in establishing a TCP connection to this page.
ServerResponseTime Integer False The total time (in milliseconds) the site's server takes to respond to users' requests among all samples; this includes the network time from users' locations to the server.
AvgServerResponseTime Float False The average time (in seconds) the site's server takes to respond to users' requests; this includes the network time from users' locations to the server.
SpeedMetricsSample Integer False The sample set (or count) of pageviews used to calculate the averages of site speed metrics. This metric is used in all site speed average calculations, including avgDomainLookupTime, avgPageDownloadTime, avgRedirectionTime, avgServerConnectionTime, and avgServerResponseTime.
DomInteractiveTime Integer False The time (in milliseconds), including the network time from users' locations to the site's server, the browser takes to parse the document (DOMInteractive). At this time, users can interact with the Document Object Model even though it is not fully loaded.
AvgDomInteractiveTime Float False The average time (in seconds), including the network time from users' locations to the site's server, the browser takes to parse the document and execute deferred and parser-inserted scripts.
DomContentLoadedTime Integer False The time (in milliseconds), including the network time from users' locations to the site's server, the browser takes to parse the document and execute deferred and parser-inserted scripts (DOMContentLoaded). When parsing of the document is finished, the Document Object Model (DOM) is ready, but the referenced style sheets, images, and subframes may not be finished loading. This is often the starting point of Javascript framework execution, e.g., JQuery's onready() callback.
AvgDomContentLoadedTime Float False The average time (in seconds) the browser takes to parse the document.
DomLatencyMetricsSample Integer False Sample set (or count) of pageviews used to calculate the averages for site speed DOM metrics. This metric is used to calculate ga:avgDomContentLoadedTime and ga:avgDomInteractiveTime.
Screenviews Integer False The total number of screenviews.
UniqueScreenviews Integer False The number of unique screen views. Screen views in different sessions are counted as separate screen views.
ScreenviewsPerSession Float False The average number of screenviews per session.
TimeOnScreen String False The time spent viewing the current screen.
AvgScreenviewDuration String False Average time (in seconds) users spent on a screen.
TotalEvents Integer False The total number of events for the profile, across all categories.
UniqueDimensionCombinations Integer False Unique Dimension Combinations counts the number of unique dimension-value combinations for each dimension in a report. This lets you build combined (concatenated) dimensions post-processing, which allows for more flexible reporting without having to update your tracking implementation or use additional custom-dimension slots. For more information, see https://support.google.com/analytics/answer/7084499.
UniqueEvents Integer False The number of unique events. Events in different sessions are counted as separate events.
EventValue Integer False Total value of events for the profile.
AvgEventValue Float False The average value of an event.
SessionsWithEvent Integer False The total number of sessions with events.
EventsPerSessionWithEvent Float False The average number of events per session with event.
Transactions Integer False The total number of transactions.
TransactionsPerSession Decimal False The average number of transactions in a session.
TransactionRevenue Decimal False The total sale revenue (excluding shipping and tax) of the transaction.
RevenuePerTransaction Decimal False The average revenue of an ecommerce transaction.
TransactionRevenuePerSession Decimal False Average transaction revenue for a session.
TransactionShipping Decimal False The total cost of shipping.
TransactionTax Decimal False Total tax for the transaction.
TotalValue Decimal False Total value for the property (including total revenue and total goal value).
ItemQuantity Integer False Total number of items purchased. For example, if users purchase 2 frisbees and 5 tennis balls, this will be 7.
UniquePurchases Integer False The number of product sets purchased. For example, if users purchase 2 frisbees and 5 tennis balls from the site, this will be 2.
RevenuePerItem Decimal False The average revenue per item.
ItemRevenue Decimal False The total revenue from purchased product items.
ItemsPerPurchase Float False The average quantity of this item (or group of items) sold per purchase.
LocalTransactionRevenue Decimal False Transaction revenue in local currency.
LocalTransactionShipping Decimal False Transaction shipping cost in local currency.
LocalTransactionTax Decimal False Transaction tax in local currency.
LocalItemRevenue Decimal False Product revenue in local currency.
SocialInteractions Integer False The total number of social interactions.
UniqueSocialInteractions Integer False The number of sessions during which the specified social action(s) occurred at least once. This is based on the the unique combination of socialInteractionNetwork, socialInteractionAction, and socialInteractionTarget.
SocialInteractionsPerSession Float False The number of social interactions per session.
UserTimingValue Integer False Total number of milliseconds for user timing.
UserTimingSample Integer False The number of hits sent for a particular userTimingCategory, userTimingLabel, or userTimingVariable.
AvgUserTimingValue Float False The average elapsed time.
Exceptions Integer False The number of exceptions sent to Google Analytics.
ExceptionsPerScreenview Decimal False The number of exceptions thrown divided by the number of screenviews.
FatalExceptions Integer False The number of exceptions where isFatal is set to true.
FatalExceptionsPerScreenview Decimal False The number of fatal exceptions thrown divided by the number of screenviews.
DcmFloodlightQuantity Integer False The number of DCM Floodlight conversions (Analytics 360 only).
DcmFloodlightRevenue Decimal False DCM Floodlight revenue (Analytics 360 only).
AdsenseRevenue Decimal False The total revenue from AdSense ads.
AdsenseAdUnitsViewed Integer False The number of AdSense ad units viewed (requires integration with AdSense). An ad unit is a set of ads displayed as a result of one piece of the AdSense ad code. For details, see https://support.google.com/adsense/answer/32715?hl=en.
AdsenseAdsViewed Integer False The number of AdSense ads viewed (requires integration with AdSense). Multiple ads can be displayed within an ad Unit.
AdsenseAdsClicks Integer False The number of times AdSense ads on the site were clicked (requires integration with AdSense).
AdsensePageImpressions Integer False The number of pageviews during which an AdSense ad was displayed (requires integration with AdSense). A page impression can have multiple ad Units.
AdsenseCTR Decimal False The percentage of page impressions resulted in a click on an AdSense ad (requires integration with AdSense).
AdsenseECPM Decimal False The estimated cost per thousand page impressions (requires integration with AdSense). It is the AdSense Revenue per 1,000 page impressions.
AdsenseExits Integer False The number of sessions ended due to a user clicking on an AdSense ad (requires integration with AdSense).
AdsenseViewableImpressionPercent Decimal False The percentage of viewable impressions (requires integration with AdSense).
AdsenseCoverage Decimal False The percentage of ad requests that returned at least one ad (requires integration with AdSense).
TotalPublisherImpressions Integer False An ad impression is reported whenever an individual ad is displayed on the website. For example, if a page with two ad units is viewed once, we'll display two impressions.
TotalPublisherCoverage Decimal False Coverage is the percentage of ad requests that returned at least one ad. Generally, coverage can help you identify sites where the publisher account (AdSense, AdX, DFP) isn't able to provide targeted ads. (Ad Impressions / Total Ad Requests) * 100
TotalPublisherMonetizedPageviews Integer False This measures the total number of pageviews on the property that were shown with an ad from one of the linked publisher accounts (AdSense, AdX, DFP). Note that a single page can have multiple ad units.
TotalPublisherImpressionsPerSession Float False The ratio of linked publisher account (AdSense, AdX, DFP) ad impressions to Analytics sessions (Ad Impressions / Analytics Sessions).
TotalPublisherViewableImpressionsPercent Decimal False The percentage of viewable ad impressions. An impression is considered a viewable impression when it has appeared within users' browsers and has the opportunity to be seen.
TotalPublisherClicks Integer False The number of times ads from a linked publisher account (AdSense, AdX, DFP) were clicked on the site.
TotalPublisherCTR Decimal False The percentage of pageviews that resulted in a click on a linked publisher account (AdSense, AdX, DFP) ad.
TotalPublisherRevenue Decimal False The total estimated revenue from all linked publisher account (AdSense, AdX, DFP) ads.
TotalPublisherRevenuePer1000Sessions Decimal False The total estimated revenue from all linked publisher accounts (AdSense, AdX, DFP) per 1,000 Analytics sessions.
TotalPublisherECPM Decimal False The effective cost per thousand pageviews. It is the total estimated revenue from all linked publisher accounts (AdSense, AdX, DFP) per 1,000 pageviews.
AdxImpressions Integer False An Ad Exchange ad impression is reported whenever an individual ad is displayed on the website. For example, if a page with two ad units is viewed once, we'll display two impressions.
AdxCoverage Decimal False Coverage is the percentage of ad requests that returned at least one ad. Generally, coverage can help identify sites where the Ad Exchange account isn't able to provide targeted ads. (Ad Impressions / Total Ad Requests) * 100
AdxMonetizedPageviews Integer False This measures the total number of pageviews on the property that were shown with an ad from the linked Ad Exchange account. Note that a single page can have multiple ad units.
AdxImpressionsPerSession Float False The ratio of Ad Exchange ad impressions to Analytics sessions (Ad Impressions / Analytics Sessions).
AdxViewableImpressionsPercent Decimal False The percentage of viewable ad impressions. An impression is considered a viewable impression when it has appeared within users' browsers and has the opportunity to be seen.
AdxClicks Integer False The number of times AdX ads were clicked on the site.
AdxCTR Decimal False The percentage of pageviews that resulted in a click on an Ad Exchange ad.
AdxRevenue Decimal False The total estimated revenue from Ad Exchange ads.
AdxRevenuePer1000Sessions Decimal False The total estimated revenue from Ad Exchange ads per 1,000 Analytics sessions. Note that this metric is based on sessions to the site, not on ad impressions.
AdxECPM Decimal False The effective cost per thousand pageviews. It is the Ad Exchange revenue per 1,000 pageviews.
DfpImpressions Integer False A DFP ad impression is reported whenever an individual ad is displayed on the website. For example, if a page with two ad units is viewed once, we'll display two impressions (DFP linking enabled and Hide DFP Revenue not enabled).
DfpCoverage Decimal False Coverage is the percentage of ad requests that returned at least one ad. Generally, coverage can help identify sites where the DFP account isn't able to provide targeted ads. (Ad Impressions / Total Ad Requests) * 100 (DFP linking enabled and Hide DFP Revenue not enabled).
DfpMonetizedPageviews Integer False This measures the total number of pageviews on the property that were shown with an ad from the linked DFP account. Note that a single page can have multiple ad units (DFP linking enabled and Hide DFP Revenue not enabled).
DfpImpressionsPerSession Float False The ratio of DFP ad impressions to Analytics sessions (Ad Impressions / Analytics Sessions) (DFP linking enabled and Hide DFP Revenue not enabled).
DfpViewableImpressionsPercent Decimal False The percentage of viewable ad impressions. An impression is considered a viewable impression when it has appeared within users' browsers and has the opportunity to be seen (DFP linking enabled and Hide DFP Revenue not enabled).
DfpClicks Integer False The number of times DFP ads were clicked on the site (DFP linking enabled and Hide DFP Revenue not enabled).
DfpCTR Decimal False The percentage of pageviews that resulted in a click on an DFP ad (DFP linking enabled and Hide DFP Revenue not enabled).
DfpRevenue Decimal False DFP revenue is an estimate of the total ad revenue based on served impressions (DFP linking enabled and Hide DFP Revenue not enabled).
DfpRevenuePer1000Sessions Decimal False The total estimated revenue from DFP ads per 1,000 Analytics sessions. Note that this metric is based on sessions to the site, not on ad impressions (DFP linking enabled and Hide DFP Revenue not enabled).
DfpECPM Decimal False The effective cost per thousand pageviews. It is the DFP revenue per 1,000 pageviews (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillImpressions Integer False Backfill Impressions is the sum of all AdSense or Ad Exchance ad impressions served as backfill through DFP. An ad impression is reported whenever an individual ad is displayed on the website. For example, if a page with two ad units is viewed once, we'll display two impressions (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillCoverage Decimal False Backfill Coverage is the percentage of backfill ad requests that returned at least one ad. Generally, coverage can help identify sites where the publisher account isn't able to provide targeted ads. (Ad Impressions / Total Ad Requests) * 100. If both AdSense and Ad Exchange are providing backfill ads, this metric is the weighted average of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillMonetizedPageviews Integer False This measures the total number of pageviews on the property that were shown with at least one ad from the linked backfill account(s). Note that a single monetized pageview can include multiple ad impressions (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillImpressionsPerSession Float False The ratio of backfill ad impressions to Analytics sessions (Ad Impressions / Analytics Sessions). If both AdSense and Ad Exchange are providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillViewableImpressionsPercent Decimal False The percentage of backfill ad impressions that were viewable. An impression is considered a viewable impression when it has appeared within the users' browsers and had the opportunity to be seen. If AdSense and Ad Exchange are both providing backfill ads, this metric is the weighted average of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillClicks Integer False The number of times backfill ads were clicked on the site. If AdSense and Ad Exchange are both providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillCTR Decimal False The percentage of backfill impressions that resulted in a click on an ad. If AdSense and Ad Exchange are both providing backfill ads, this metric is the weighted average of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillRevenue Decimal False The total estimated revenue from backfill ads. If AdSense and Ad Exchange are both providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillRevenuePer1000Sessions Decimal False The total estimated revenue from backfill ads per 1,000 Analytics sessions. Note that this metric is based on sessions to the site and not ad impressions. If both AdSense and Ad Exchange are providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).
BackfillECPM Decimal False The effective cost per thousand pageviews. It is the DFP Backfill Revenue per 1,000 pageviews. If both AdSense and Ad Exchange are providing backfill ads, this metric is the sum of the two backfill accounts (DFP linking enabled and Hide DFP Revenue not enabled).
BuyToDetailRate Decimal False Unique purchases divided by views of product detail pages (Enhanced Ecommerce).
CartToDetailRate Decimal False Product adds divided by views of product details (Enhanced Ecommerce).
CohortActiveUsers Integer False This metric is relevant in the context of ga:cohortNthDay/ga:cohortNthWeek/ga:cohortNthMonth. It indicates the number of users in the cohort who are active in the time window corresponding to the cohort nth day/week/month. For example, for ga:cohortNthWeek = 1, number of users (in the cohort) who are active in week 1. If a request doesn't have any of ga:cohortNthDay/ga:cohortNthWeek/ga:cohortNthMonth, this metric will have the same value as ga:cohortTotalUsers.
CohortAppviewsPerUser Float False App views per user for a cohort.
CohortAppviewsPerUserWithLifetimeCriteria Float False App views per user for the acquisition dimension for a cohort.
CohortGoalCompletionsPerUser Float False Goal completions per user for the acquisition dimension for a cohort.
CohortGoalCompletionsPerUserWithLifetimeCriteria Float False Goal completions per user for a cohort.
CohortPageviewsPerUser Float False Pageviews per user for a cohort.
CohortPageviewsPerUserWithLifetimeCriteria Float False Pageviews per user for the acquisition dimension for a cohort.
CohortRetentionRate Decimal False Cohort retention rate.
CohortRevenuePerUser Decimal False Revenue per user for a cohort.
CohortRevenuePerUserWithLifetimeCriteria Decimal False Revenue per user for the acquisition dimension for a cohort.
CohortSessionDurationPerUser String False Session duration per user for a cohort.
CohortSessionDurationPerUserWithLifetimeCriteria String False Session duration per user for the acquisition dimension for a cohort.
CohortSessionsPerUser Float False Sessions per user for a cohort.
CohortSessionsPerUserWithLifetimeCriteria Float False Sessions per user for the acquisition dimension for a cohort.
CohortTotalUsers Integer False Number of users belonging to the cohort, also known as cohort size.
CohortTotalUsersWithLifetimeCriteria Integer False This is relevant in the context of a request which has the dimensions ga:acquisitionTrafficChannel/ga:acquisitionSource/ga:acquisitionMedium/ga:acquisitionCampaign. It represents the number of users in the cohorts who are acquired through the current channel/source/medium/campaign. For example, for ga:acquisitionTrafficChannel=Direct, it represents the number users in the cohort, who were acquired directly. If none of these mentioned dimensions are present, then its value is equal to ga:cohortTotalUsers.
DbmCPA Decimal False DBM Revenue eCPA (Analytics 360 only, requires integration with DBM).
DbmCPC Decimal False DBM Revenue eCPC (Analytics 360 only, requires integration with DBM).
DbmCPM Decimal False DBM Revenue eCPM (Analytics 360 only, requires integration with DBM).
DbmCTR Decimal False DBM CTR (Analytics 360 only, requires integration with DBM).
DbmClicks Integer False DBM Total Clicks (Analytics 360 only, requires integration with DBM).
DbmConversions Integer False DBM Total Conversions (Analytics 360 only, requires integration with DBM).
DbmCost Decimal False DBM Cost (Analytics 360 only, requires integration with DBM).
DbmImpressions Integer False DBM Total Impressions (Analytics 360 only, requires integration with DBM).
DbmROAS Decimal False DBM ROAS (Analytics 360 only, requires integration with DBM).
DcmCPC Decimal False DCM Cost Per Click (Analytics 360 only).
DcmCTR Decimal False DCM Click Through Rate (Analytics 360 only).
DcmClicks Integer False DCM Total Clicks (Analytics 360 only).
DcmCost Decimal False DCM Total Cost (Analytics 360 only).
DcmImpressions Integer False DCM Total Impressions (Analytics 360 only).
DcmROAS Decimal False DCM Return On Ad Spend (ROAS) (Analytics 360 only).
DcmRPC Decimal False DCM Revenue Per Click (Analytics 360 only).
DsCPC Decimal False DS Cost to advertiser per click (Analytics 360 only, requires integration with DS).
DsCTR Decimal False DS Click Through Rate (Analytics 360 only, requires integration with DS).
DsClicks Integer False DS Clicks (Analytics 360 only, requires integration with DS).
DsCost Decimal False DS Cost (Analytics 360 only, requires integration with DS).
DsImpressions Integer False DS Impressions (Analytics 360 only, requires integration with DS).
DsProfit Decimal False DS Profit (Analytics 360 only, requires integration with DS).
DsReturnOnAdSpend Decimal False DS Return On Ad Spend (Analytics 360 only, requires integration with DS).
DsRevenuePerClick Decimal False DS Revenue Per Click (Analytics 360 only, requires integration with DS).
Hits Integer False Total number of hits for the view (profile). This metric sums all hit types, including pageview, custom event, ecommerce, and other types. Because this metric is based on the view (profile), not on the property, it is not the same as the property's hit volume.
InternalPromotionCTR Decimal False The rate at which users clicked through to view the internal promotion (ga:internalPromotionClicks / ga:internalPromotionViews) - (Enhanced Ecommerce).
InternalPromotionClicks Integer False The number of clicks on an internal promotion (Enhanced Ecommerce).
InternalPromotionViews Integer False The number of views of an internal promotion (Enhanced Ecommerce).
LocalProductRefundAmount Decimal False Refund amount in local currency for a given product (Enhanced Ecommerce).
LocalRefundAmount Decimal False Total refund amount in local currency for the transaction (Enhanced Ecommerce).
ProductAddsToCart Integer False Number of times the product was added to the shopping cart (Enhanced Ecommerce).
ProductCheckouts Integer False Number of times the product was included in the check-out process (Enhanced Ecommerce).
ProductDetailViews Integer False Number of times users viewed the product-detail page (Enhanced Ecommerce).
ProductListCTR Decimal False The rate at which users clicked through on the product in a product list (ga:productListClicks / ga:productListViews) - (Enhanced Ecommerce).
ProductListClicks Integer False Number of times users clicked the product when it appeared in the product list (Enhanced Ecommerce).
ProductListViews Integer False Number of times the product appeared in a product list (Enhanced Ecommerce).
ProductRefundAmount Decimal False Total refund amount associated with the product (Enhanced Ecommerce).
ProductRefunds Integer False Number of times a refund was issued for the product (Enhanced Ecommerce).
ProductRemovesFromCart Integer False Number of times the product was removed from the shopping cart (Enhanced Ecommerce).
ProductRevenuePerPurchase Decimal False Average product revenue per purchase (commonly used with Product Coupon Code) (ga:itemRevenue / ga:uniquePurchases) - (Enhanced Ecommerce).
QuantityAddedToCart Integer False Number of product units added to the shopping cart (Enhanced Ecommerce).
QuantityCheckedOut Integer False Number of product units included in check out (Enhanced Ecommerce).
QuantityRefunded Integer False Number of product units refunded (Enhanced Ecommerce).
QuantityRemovedFromCart Integer False Number of product units removed from a shopping cart (Enhanced Ecommerce).
RefundAmount Decimal False Currency amount refunded for a transaction (Enhanced Ecommerce).
RevenuePerUser Decimal False The total sale revenue (excluding shipping and tax) of the transaction divided by the total number of users.
SessionsPerUser Float False The total number of sessions divided by the total number of users.
TotalRefunds Integer False Number of refunds that have been issued (Enhanced Ecommerce).
TransactionsPerUser Float False Total number of transactions divided by total number of users.
Metric1 Integer False The value of the requested custom metric-01.
Metric2 Integer False The value of the requested custom metric-02.
Metric3 Integer False The value of the requested custom metric-03.
Metric4 Integer False The value of the requested custom metric-04.
Metric5 Integer False The value of the requested custom metric-05.
Metric6 Integer False The value of the requested custom metric-06.
Metric7 Integer False The value of the requested custom metric-07.
Metric8 Integer False The value of the requested custom metric-08.
Metric9 Integer False The value of the requested custom metric-09.
Metric10 Integer False The value of the requested custom metric-10.
Metric11 Integer False The value of the requested custom metric-11.
Metric12 Integer False The value of the requested custom metric-12.
Metric13 Integer False The value of the requested custom metric-13.
Metric14 Integer False The value of the requested custom metric-14.
Metric15 Integer False The value of the requested custom metric-15.
Metric16 Integer False The value of the requested custom metric-16.
Metric17 Integer False The value of the requested custom metric-17.
Metric18 Integer False The value of the requested custom metric-18.
Metric19 Integer False The value of the requested custom metric-19.
Metric20 Integer False The value of the requested custom metric-20.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



GoalCompletions

Retrieves Goal Completion data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses Date instead of the default GoalCompletionLocation dimension:

SELECT Date, GoalStartsAll, GoalCompletionsAll, GoalValueAll, GoalValuePerSession, GoalConversionRateAll, GoalAbandonsAll, GoalAbandonRateAll FROM GoalCompletions
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will find Goal Completions for a specific Goal Completion Location:
SELECT GoalCompletionLocation, GoalCompletionsAll FROM GoalCompletions WHERE GoalCompletionLocation = '/mypath'
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM GoalCompletion WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT GoalCompletionLocation, GoalStartsAll, GoalCompletionsAll, GoalValueAll, GoalValuePerSession, GoalConversionRateAll, GoalAbandonsAll, GoalAbandonRateAll FROM GoalCompletions
Columns

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.
GoalCompletionLocation String True True The page path or screen name that matched any destination-type goal completion.
GoalStartsAll Integer False True The total number of starts for all goals defined for your profile.
GoalCompletionsAll Integer False True The total number of completions for all goals defined for your profile.
GoalValueAll Double False True The total numeric value for all goals defined for your profile.
GoalValuePerSession Double False True The average goal value of a session on your property.
GoalConversionRateAll Double False True The percentage of sessions that resulted in a conversion to at least one of your goals.
GoalAbandonsAll Integer False True The overall number of times users started goals without actually completing them.
GoalAbandonRateAll Double False True The rate at which goals were abandoned.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



SiteContent

Retrieves internal Site Content data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses PageTitle instead of the default PagePath dimension:

SELECT PageTitle, PageViews, UniquePageviews, AvgTimeOnPage, Entrances, BounceRate, EntranceRate, Exits, PageValue, TimeOnPage FROM SiteContent
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will return the Page Paths in order of most Entrances to least:
SELECT PagePath, Entrances FROM SiteContent ORDER BY Entrances DESC
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM SiteContent WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT PagePath, PageViews, UniquePageviews, AvgTimeOnPage, Entrances, BounceRate, EntranceRate, Exits, PageValue, TimeOnPage, ExitRate FROM SiteContent
Columns

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.
Browser String True The names of browsers used by users to your website. For example, Internet Explorer or Firefox.
PagePath String True True A page on your website specified by path and/or query parameters. Use in conjunction with host name to get the full URL of the page.
PageTitle String True The title of a page. Keep in mind that multiple pages might have the same PageTitle.
PageViews Integer False True The total number of page views for your property.
UniquePageviews Integer False True The number of different (unique) pages within a session. This takes into both the PagePath and PageTitle to determine uniqueness.
AvgTimeOnPage Double False True The average amount of time users spent viewing this page or a set of pages.
Entrances Integer False True The number of entrances to your property, measured as the first page view in a session. Typically used with LandingPagePath.
BounceRate Double False True The percentage of single-page sessions.
EntranceRate Double False True The percentage of page views in which this page was the entrance.
Exits Integer False True The number of exits from your property.
PageValue Double False True The average value of this page or set of pages. Page Value is the sum of TransactionRevenue and GoalValueAll, columns in the Ecommerce table, divided by UniquePageviews (for the page or set of pages).
TimeOnPage Double False True How long a user spent on a particular page in seconds. Calculated by subtracting the initial view time for a particular page from the initial view time for a subsequent page. Thus, this metric does not apply to exit pages for your property.
ExitRate Double False True The percentage of exits from your property that occurred out of the total page views.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



SiteSearch

Retrieves internal Site Search data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses SearchStartPage instead of the default SearchKeyword dimension:

SELECT SearchStartPage, SearchSessions, PercentSessionsWithSearch, SearchUniques, SearchResultViews, AvgSearchResultViews, SearchExits, PercentSearchRefinements, SearchDuration, AvgSearchDuration, AvgSearchDepth FROM SiteSearch
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will return the number of sessions for a 'software' Search Category:
SELECT SearchCategory, SearchSessions FROM SiteSearch WHERE SearchCategory = 'software'
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM SiteSearch WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
Because there are more than 10 Metrics available for the SiteSearch table, a query that selects all columns only returns the default Metrics for this table (see columns marked as default Metrics below). If you need to select other Metrics, select them explicitly instead of using '*'. The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or set in the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT SearchKeyword, SearchSessions, PercentSessionsWithSearch, SearchUniques, SearchResultViews, AvgSearchResultViews, SearchExits, PercentSearchRefinements, SearchDuration, AvgSearchDepth FROM SiteSearch
Columns

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.
SearchKeyword String True True Search terms used by users within your property.
SearchCategory String True The categories used for the internal search if you have this enabled for your profile. For example, product categories, such as electronics, furniture, or clothing.
SearchStartPage String True A page where the user initiated an internal search on your property.
SearchSessions Integer False True The total number of sessions that included an internal search.
PercentSessionsWithSearch Double False True The percentage of sessions with search.
SearchUniques Integer False True The total number of unique keywords from internal searches within a session.
SearchResultViews Integer False True The number of times a search result page was viewed after performing a search.
AvgSearchResultViews Double False True The average number of times people viewed a search results page after performing a search.
SearchExits Integer False True The number of exits on your site that occurred following a search result from your internal search feature.
SearchExitRate Double False The percentage of searches that resulted in an immediate exit from your property.
SearchRefinements Integer False The total number of times a refinement (transition) occurs between internal search keywords within a session.
PercentSearchRefinements Double False True The percentage of number of times a refinement (i.e., transition) occurs between internal search keywords within a session.
SearchDuration Double False True The session duration on your property where a use of your internal search feature occurred.
AvgSearchDuration Double False The average amount of time people spent on your property after searching.
SearchDepth Integer False The average number of subsequent page views made on your property after a use of your internal search feature.
AvgSearchDepth Double False True The average number of pages people viewed after performing a search on your property.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



SiteSpeed

Retrieves internal Site Speed data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses PagePath instead of the default Browser dimension:

SELECT PagePath, AvgPageLoadTime, AvgRedirectionTime, AvgDomainLookupTime, AvgServerConnectionTime, AvgServerResponseTime, AvgPageDownloadTime FROM SiteSpeed
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will return Page Title for all pages with an average load time of more than 1.5 on mobile devices:
SELECT DeviceCategory, PageTitle, AvgPageLoadTime FROM SiteSpeed WHERE AvgPageLoadTime > 1.5 AND DeviceCategory='mobile'
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM SiteSpeed WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
Because there are more than 10 Metrics available for the SiteSpeed table, a query that selects all columns only returns the default Metrics for this table (see columns marked as default Metrics below). If you need to select other Metrics, select them explicitly instead of using '*'. The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT Browser, AvgPageLoadTime, AvgRedirectionTime, AvgDomainLookupTime, AvgServerConnectionTime, AvgServerResponseTime, AvgPageDownloadTime FROM SiteSpeed
Columns

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.
Browser String True True The names of browsers used by users to your website. For example, Internet Explorer or Firefox.
DeviceCategory String True The type of device: desktop, tablet, or mobile.
PagePath String True A page on your website specified by path and/or query parameters. Use in conjunction with host name to get the full URL of the page.
PageTitle String True The title of a page. Keep in mind that multiple pages might have the same PageTitle.
AvgPageLoadTime Double False True The average amount of time in seconds it takes for pages from the sample set to load, from initiation of the page view (e.g., a click on a page link) to load completion in the browser.
AvgRedirectionTime Double False True The average amount of time in seconds spent in redirects before fetching this page. If there are no redirects, the value for this metric is expected to be 0.
AvgDomainLookupTime Double False True The average amount of time in seconds spent in DNS lookup for this page.
AvgServerConnectionTime Double False True The average amount of time in seconds spent in establishing the TCP connection for this page.
AvgServerResponseTime Double False True The average amount of time in seconds your server takes to respond to a user request, including the network time from the location of the user to your server.
AvgPageDownloadTime Double False True The average amount of time in seconds to download this page.
PageLoadTime Integer False The amount of time (in milliseconds) it takes for pages from the sample set to load from initiation of the page view (e.g., a click on a page link) to load completion in the browser.
PageLoadSample Integer False The sample set, or count of page views used to calculate the average page load time.
DomainLookupTime Integer False The total amount of time (in milliseconds) spent in DNS lookup for this page among all samples.
PageDownloadTime Integer False The total amount of time (in milliseconds) to download this page among all samples.
RedirectionTime Integer False The total amount of time (in milliseconds) spent in redirects before fetching this page among all samples. If there are no redirects, the value for this metric is expected to be 0.
ServerConnectionTime Integer False The total amount of time (in milliseconds) spent in establishing the TCP connection for this page among all samples.
ServerResponseTime Integer False The total amount of time (in milliseconds) your server takes to respond to a user request among all samples, including the network time from the location of the user to your server.
SpeedMetricsSample Integer False The sample set, or count, of page views used to calculate the averages for site speed metrics. This metric is used in all site speed average calculations.
DomInteractiveTime Integer False The time the browser takes (in milliseconds) to parse the document (DOMInteractive), including the network time from the location of the user to your server. At this time, the user can interact with the Document Object Model even though it is not fully loaded.
DomContentLoadedTime Integer False The time the browser takes (in milliseconds) to parse the document and execute deferred and parser-inserted scripts (DOMContentLoaded), including the network time from the location of the user to your server. Parsing of the document is finished and the Document Object Model is ready, but referenced style sheets, images, and subframes may not be finished loading. This event is often the starting point for JavaScript framework execution; e.g., JQuery's onready() callback.
DomLatencyMetricsSample Integer False The sample set, or count, of page views used to calculate the averages for site speed DOM metrics. This metric is used in the AvgDomContentLoadedTime and AvgDomInteractiveTime calculations.
AvgDomInteractiveTime Double False The average time in seconds, including the network time from the location of the user to your server, that it takes the browser to parse the document and execute deferred and parser-inserted scripts.
AvgDomContentLoadedTime Double False The average time in seconds it takes the browser to parse the document.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Profile Integer Profile ID or website URL to retrieve data from.

Pseudo-Columns

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
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.



Traffic

Retrieves all Traffic data.

Table Specific Information

Select

Google Analytics only allows up to 10 Metrics and 7 Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns will be selected for tables with more than 10 Metrics. The default Dimensions will be used unless you explicitly select other dimension columns. The following query uses Date instead of the default Source and Medium dimensions:

SELECT Date, Sessions, PercentNewSessions, NewUsers, BounceRate, PageviewsPerSession, AvgSessionDuration, GoalConversionRateAll, Transactions, RevenuePerTransaction, TransactionRevenue FROM Traffic
Filters can also be used in the WHERE clause. Dimension fields support the =, !=, LIKE, and NOT LIKE operators. Metric fields support =, !=, >, >=, <, and <= operators. This query will return the number of Sessions using Google Chrome:
SELECT Browser, Sessions FROM Traffic WHERE Browser LIKE '%Chrome%'
All reports in Google Analytics must cover a specific date range. The default behavior is to pull the last month of data if the StartDate and EndDate inputs are left unset. To override this behavior, the values can be set directly in the query. For example:
SELECT * FROM Traffic WHERE StartDate = '90daysAgo' AND EndDate = 'Today'
The default dimension for the table will be used unless another dimension is specified in the select columns, the DefaultFilter, or the Dimensions column in the WHERE clause. See Retrieving Google Analytics Data for more information about SELECT * queries. The following queries return the same results:
SELECT Source, Medium, Sessions, Users, PercentNewSessions, NewUsers, BounceRate, PageviewsPerSession, AvgSessionDuration, GoalConversionRateAll, Transactions, TransactionRevenue FROM Traffic
Columns

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.
Language String True The language provided by the HTTP Request for the browser. Values are given as an ISO-639 code.
Country String True The country of users, derived from IP addresses.
City String True The cities of property users, derived from IP addresses.
Browser String True The names of browsers used by users to your website. For example, Internet Explorer or Firefox.
OperatingSystem String True The operating system used by your users. For example, Windows, Linux , Macintosh, iPhone, iPod.
DeviceCategory String True The type of device: desktop, tablet, or mobile.
ChannelGrouping String True The channel grouping the data is returned for.
Source String True True The source of referrals to your property
Medium String True True The type of referrals to your property.
UserType String True A boolean indicating if a user is new or returning.
LandingPagePath String True The first page in a user session or landing page.
Campaign String True When using manual campaign tracking, this value is the value of the utm_campaign campaign tracking parameter. When using AdWords autotagging, this value is the name(s) of the online ad campaign that you use for your property. Otherwise, this value is: not set.
SocialNetwork String True Name of the social network. This can be related to the referring social network for traffic sources or to the social network for social data hub activities.
Sessions Integer False True Counts the total number of sessions.
Users Integer False True Total number of users to your property for the requested time period.
PercentNewSessions Double False True The percentage of sessions by people who had never visited your property before.
NewUsers Integer False True The number of users whose visit to your property was marked as a first-time session.
BounceRate Double False True The percentage of single-page session.
PageviewsPerSession Double False True The average number of pages viewed during a session on your property.
AvgSessionDuration Double False True The average duration of user sessions represented in total seconds.
GoalConversionRateAll Double False True The percentage of sessions that resulted in a conversion to at least one of your goals.
Transactions Integer False True The total number of transactions.
RevenuePerTransaction Decimal False The average revenue for an e-commerce transaction.
TransactionRevenue Decimal False True The total sale revenue provided in the transaction, excluding shipping and tax.
TransactionRevenuePerSession Decimal False Average transaction revenue for a session on your property.
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.
CohortTypes String Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates Date Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates Date Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts String Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes String Comma separated list of samples space sizes counts when the response data is sampled.
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.
Profile Integer Profile ID or website URL to retrieve data from.