Google Analytics Data Model

Connection String Options

  1. Auto Cache
  2. Cache Connection
  3. Cache Driver
  4. Cache Location
  5. Cache Metadata
  6. Cache Query Result
  7. Connect On Open
  8. Default Filter
  9. Firewall Password
  10. Firewall Port
  11. Firewall Server
  12. Firewall Type
  13. Firewall User
  14. Initiate OAuth
  15. Location
  16. Logfile
  17. Max Log File Size
  18. OAuth Access Token
  19. OAuth Client Id
  20. OAuth Client Secret
  21. OAuth JWT Cert
  22. OAuth JWT Cert Password
  23. OAuth JWT Cert Subject
  24. OAuth JWT Cert Type
  25. OAuth JWT Issuer
  26. OAuth JWT Subject
  27. OAuth Refresh Token
  28. OAuth Settings Location
  29. Offline
  30. Other
  31. Pagesize
  32. Pool Idle Timeout
  33. Pool Max Size
  34. Pool Wait Time
  35. Profile
  36. Proxy Auth Scheme
  37. Proxy Auto Detect
  38. Proxy Password
  39. Proxy Port
  40. Proxy Server
  41. Proxy SSL Type
  42. Proxy User
  43. Pseudo Columns
  44. RTK
  45. Sampling Level
  46. SSL Server Cert
  47. Support Enhanced SQL
  48. Tables
  49. Timeout
  50. Use Connection Pooling
  51. Verbosity
  52. Views

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. With CacheQueryResult set, the driver updates the cache when you execute a SELECT query and returns the live results from the Google Analytics data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query Google Analytics in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Traffic#CACHE]

 

 

Setting the Caching Database

 

When AutoCache is set, 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

 

 

  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.

    When this property is set, the driver builds a temporary, in-memory dataset that caches the results of the queries you execute. Result sets for subsequent queries are extracted from this dataset, if possible.

    This property is useful in BI, analytics, and other tools that generate queries for you. In these tools, explicit cache queries with the #CACHE syntax may not be an option.

  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the Google Analytics metadata. Metadata then needs to be retrieved only once instead of every connection.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Cache Connection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies 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 CacheProvider and CacheConnection. Below 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. Below is the syntax of the JDBC URL:

jdbc:sqlite:dataSource
  • Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

 

 

MySQL

 

The installation includes the CData JDBC Driver for MySQL. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below are typical connection properties:

 

 

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The username provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.
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
Below are typical SQL Server connection properties:
  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Port: The port SQL Server is running on.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.

    To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.

  • User: The username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

Below 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
Below are typical connection properties:
  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • Password: The password provided for authentication with the Oracle database.
  • User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL

 

Below 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
Below are typical connection properties:
  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • Username: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
  • Password: The password provided for authentication with the PostgreSQL database.

 

 

Cache Driver

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 would like to use to cache data.

Note that you must also add the CacheDriver JAR 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 is shipped in the JDK. You can find the JAR, 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

 

Below 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

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

jdbc:googleanalytics:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;Profile=myProfile;
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Google Analytics 2017 installation directory.
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

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:googleanalytics:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;Profile=myProfile;
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:googleanalytics:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';InitiateOAuth=GETANDREFRESH;Profile=myProfile;

 

 

Cache Location

Data Type

string

Default Value

""

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 to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the Google Analytics catalog in CacheLocation.

 

 

Cache Metadata

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

 

 

  • When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metdata will change often.
  • When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Connect On Open

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

 

Default Filter

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'

 

 

Firewall Password

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.

 

Firewall Port

Data Type

string

Default Value

""

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.

 

Firewall Server

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.

 

Firewall Type

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.

 

 

Firewall User

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 type specified in FirewallType.

 

Initiate OAuth

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.

 

 

Location

Data Type

string

Default Value

""

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 Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files used in your application must be deployed with other assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

""

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. There is no limit by default. Values lower than 100kB will use 100kB as the value instead.

 

OAuth Access Token

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 username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Client Id

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration, you will receive a client Id, sometimes also called a consumer key, and a client secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth Client Secret

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration you will receive a client Id and a client secret, sometimes also called a consumer secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth JWT Cert

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:

 

 

   
MY A certificate store holding personal certificates with their associated private keys.
CA Certifying authority certificates.
ROOT Root certificates.
SPC Software publisher certificates.

 

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

 

OAuth JWT Cert Password

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.

 

OAuth JWT Cert Subject

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.

 

   
Field Meaning
CN Common Name. This is commonly a host name like www.server.com.
O Organization
OU Organizational Unit
L Locality
S State
C Country
E Email Address

 

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

 

OAuth JWT Cert Type

Data Type

string

Default Value

""

Remarks

This property can take one of the following values:

 

   
USER - default For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB The certificate store is a string that contains a certificate in XML format.

 

 

OAuth JWT Issuer

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.

 

OAuth JWT Subject

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.

 

OAuth Refresh Token

Data Type

string

Default Value

""

Remarks

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

 

OAuth Settings Location

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 a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to 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.

 

Other

Data Type

string

Default Value

""

Remarks

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

Caching Configuration

 

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

 

Integration and Formatting

 

   
ConvertDateTimeToGMT Whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.
ClientCulture This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
Culture This setting can be used to specify culture settings that determine how the driver interprets certain data types that are passed into the driver. For example, setting Culture='de-DE' will output German formats even on an American machine.

 

 

Pagesize

Data Type

string

Default Value

"10000"

Remarks

The Pagesize property affects the maximum number of results to return per page from Google Analytics when executing a query. A higher value will return more results per page, but may also cause a timeout exception. 10000 is the maximum number of results that may be returned per page from Google.

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

The allowed idle time from when the connection is free to when the connection is released and returned to the pool. The default is 60 seconds.

 

Pool Max Size

Data Type

string

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.

 

Pool Wait Time

Data Type

string

Default Value

""

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.

 

Profile

Data Type

string

Default Value

""

Remarks

This value can be retrieved from the Profiles table or will be retrieved automatically if this value is not set.

 

Proxy Auth Scheme

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:

  • BASIC: The driver performs HTTP BASIC authentication.
  • DIGEST: The driver performs HTTP DIGEST authentication.
  • NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Password

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.

 

Proxy Port

Data Type

string

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.

 

Proxy Server

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.

 

Proxy SSL Type

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:

 

   
AUTO Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS The connection is always SSL enabled.
NEVER The connection is not SSL enabled.
TUNNEL The connection is through a tunneling proxy: The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

 

 

Proxy User

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 username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

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

 

RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

Sampling Level

Data Type

string

Default Value

"DEFAULT"

Remarks

Allowed Values:

 

   
DEFAULT Returns response with a sample size that balances speed and accuracy.
FASTER Returns a fast response with a smaller sample size.
HIGHER_PRECISION Returns a more accurate response using a large sample size, but this may result in the response being slower.

 

 

SSL Server Cert

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 will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

false

Remarks

When SupportEnhancedSQL is set to 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 is set to 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.

 

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.

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

 

Use Connection Pooling

Data Type

string

Default Value

"false"

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

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 described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the HTTP requests.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

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.




 

Tables

  1. Accounts
  2. Profiles
  3. Segments
  4. 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.

 

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
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

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

 

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
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

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.

 

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
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 

 

WebProperties

Lists Web Properties to which the user has access.

 

Table Specific Information

 

 

Select

 

The Web Properties table exposes all web properties that the user has access to. The AccountId field is available for filtering in the WHERE clause. For example:

  SELECT * FROM WebProperties WHERE AccountId='123456'
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

 

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.

 

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
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

 

 




 

Views

  1. AdSense
  2. AdWords
  3. Ecommerce
  4. Events
  5. GoalCompletions
  6. SiteContent
  7. SiteSearch
  8. SiteSpeed
  9. 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
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM AdSense
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 Double False True   The total sale revenue provided in the transaction, excluding shipping and tax.
AdsenseRevenue Double 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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
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'
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM AdWords
SELECT Keyword, 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 Double 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 Double False True   Cost to advertiser per click.
RPC Double 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 Double False True   Returns on Investment is overall transaction profit divided by derived advertising cost.
Margin Double 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 Double False     The average revenue for an e-commerce transaction.
TransactionRevenue Double False     The total sale revenue provided in the transaction, excluding shipping and tax.
TransactionRevenuePerSession Double 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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
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
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM Ecommerce
SELECT Date, Sessions, Users, Transactions, TransactionRevenue, TransactionShipping, TransactionTax, RevenuePerTransaction 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.
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 Double False True   The total sale revenue provided in the transaction, excluding shipping and tax.
TransactionShipping Double False True   The total cost of shipping.
TransactionTax Double False True   The total amount of tax.
RevenuePerTransaction Double 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 Double 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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
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
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM Events
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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
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'
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM GoalCompletions
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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
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
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM SiteContent
SELECT PagePath, PageViews, UniquePageviews, AvgTimeOnPage, Entrances, BounceRate, EntranceRate, Exits, PageValue, TimeOnPage 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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
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'
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM SiteSearch
SELECT SearchKeyword, SearchSessions, PercentSessionsWithSearch, SearchUniques, SearchResultViews, AvgSearchResultViews, SearchExits, PercentSearchRefinements, SearchDuration, AvgSearchDuration, 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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
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'
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM SiteSpeed
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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
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, TransactionRevenuePerSession 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%'
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 the note on Establishing a Connection for a limitation with some tools. The following queries return the same results:
SELECT * FROM Traffic
SELECT Source, Medium, Sessions, 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 Double False     The average revenue for an e-commerce transaction.
TransactionRevenue Double False True   The total sale revenue provided in the transaction, excluding shipping and tax.
TransactionRevenuePerSession Double 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.

 

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
Rows@Next String Identifier for the next page of results. Do not set this value manually.
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.