Matillion Data Model for Zendesk
Version - 21.0.7817

Note: If you're using Matillion ETL, we advise you update to the latest version to ensure that your instance is reflective of the information displayed in the data model. This note does not apply to the Data Productivity Cloud.



Connection String OptionsBack To Top

  1. Auth Scheme
  2. URL
  3. User
  4. Password
  5. Initiate OAuth
  6. OAuth Client Id
  7. OAuth Client Secret
  8. OAuth Access Token
  9. Api Token
  10. OAuth Settings Location
  11. Callback URL
  12. OAuth Verifier
  13. OAuth Refresh Token
  14. OAuth Expires In
  15. OAuth Token Timestamp
  16. SSL Server Cert
  17. Firewall Type
  18. Firewall Server
  19. Firewall Port
  20. Firewall User
  21. Firewall Password
  22. Proxy Auto Detect
  23. Proxy Server
  24. Proxy Port
  25. Proxy Auth Scheme
  26. Proxy User
  27. Proxy Password
  28. Proxy SSL Type
  29. Proxy Exceptions
  30. Logfile
  31. Verbosity
  32. Log Modules
  33. Max Log File Size
  34. Max Log File Count
  35. Location
  36. Browsable Schemas
  37. Tables
  38. Views
  39. Auto Cache
  40. Cache Driver
  41. Cache Connection
  42. Cache Location
  43. Cache Tolerance
  44. Offline
  45. Cache Metadata
  46. Connection Life Time
  47. Connect On Open
  48. Max Rows
  49. Other
  50. Pagesize
  51. Pool Idle Timeout
  52. Pool Max Size
  53. Pool Min Size
  54. Pool Wait Time
  55. Pseudo Columns
  56. Readonly
  57. RTK
  58. Support Enhanced SQL
  59. Timeout
  60. Use Connection Pooling
  61. Use Incremental API

Auth Scheme

Data Type

string

Default Value

"Basic"

Remarks



URL

Data Type

string

Default Value

""

Remarks

The URL is your Zendesk Support URL; for example, https://{subdomain}.zendesk.com.



User

Data Type

string

Default Value

""

Remarks

Together with Password, this field is used to authenticate against the Zendesk server.



Password

Data Type

string

Default Value

""

Remarks

The User and Password are together used to authenticate with the server.



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.



OAuth Client Id

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.



OAuth Client Secret

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.



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



Api Token

Data Type

string

Default Value

""

Remarks

API token of the currently authenticated user.



OAuth Settings Location

Data Type

string

Default Value

"%APPDATA%\\CData\\Zendesk 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\\Zendesk 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



Callback URL

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.



OAuth Verifier

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



OAuth Refresh Token

Data Type

string

Default Value

""

Remarks

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



OAuth Expires In

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.



OAuth Token Timestamp

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.



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



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 Zendesk 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 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 Port

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.



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



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.



Proxy Auto Detect

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.



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 Port

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.



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:

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.



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



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

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.



Proxy Exceptions

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.



Log Modules

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.



Max Log File Size

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.



Max Log File Count

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

If left unspecified, the default location is "%APPDATA%\\CData\\Zendesk 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



Browsable Schemas

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.



Auto Cache

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



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 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:zendesk:CacheLocation='c:/Temp/cachedir';URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
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:zendesk:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:zendesk:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:zendesk:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;

  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Zendesk installation directory.
SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:zendesk:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:zendesk:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
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:zendesk:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;



Cache Connection

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:



Cache Location

Data Type

string

Default Value

"%APPDATA%\\CData\\Zendesk 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\\Zendesk 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



Cache Tolerance

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.



Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Zendesk 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



Connection Life Time

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.



Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to Zendesk 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 Zendesk 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).



Max Rows

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

100

Remarks

Note that most of the tables support 100 as the maximum value.



Pool Idle Timeout

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.



Pool Max Size

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.



Pool Min Size

Data Type

int

Default Value

1

Remarks

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



Pool Wait Time

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.



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



Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.



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.



Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to Zendesk 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 Zendesk 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.



Use Connection Pooling

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.



Use Incremental API

Data Type

bool

Default Value

false

Remarks

Set this property to true, to make use of the Zendesk Incremental API. This property has effect only on the Tickets table and disables all server side criteria.





TablesBack To Top

  1. AccountSettings
  2. Automations
  3. Brands
  4. GroupMemberships
  5. Groups
  6. Holidays
  7. JiraLinks
  8. Macros
  9. OrganizationFields
  10. OrganizationMemberships
  11. Organizations
  12. OrganizationSubscriptions
  13. PostComments
  14. Posts
  15. SatisfactionRatings
  16. Schedules
  17. Sessions
  18. SharingAgreements
  19. SupportAddresses
  20. SuspendedTickets
  21. TicketFields
  22. TicketForms
  23. Tickets
  24. Topics
  25. Triggers
  26. UserFields
  27. UserIdentities
  28. Users
  29. Views

AccountSettings

Query and update Account Settings in Zendesk.

Table Specific Information
Select

The driver executes all filters on this table client side.

Columns

Name Type ReadOnly References Description
BrandingHeaderColor String False

HEX of the header color.

BrandingPageBackgroundColor String True

HEX of the page background color.

BrandingTabBackgroundColor String True

HEX of tab background color.

BrandingTextColor String True

HEX of the text color, usually matched to contrast well with header_color.

BrandingHeaderLogoUrl String True

The URL for the custom header logo.

BrandingFaviconUrl String True

The URL for the custom favicon.

AppsUse Boolean True

The account can use apps.

AppsCreatePrivate Boolean True

The account can create private apps.

TicketsCommentsPublicByDefault Boolean True

Comments from agents are public by default.

TicketsIsFirstCommentPrivateEnabled Boolean True

Allow first comment on tickets to be private.

TicketsListNewestCommentsFirst Boolean True

When viewing a ticket, show the newest comments and events first.

TicketsCollaboration Boolean True

CCs may be added to a ticket.

TicketsPrivateAttachments Boolean True

Users must login to access attachments.

TicketsEmailAttachments Boolean True

Attachments should be sent as real attachments when under the size limit.

TicketsAgentCollision Boolean True

Clients should provide an indicator when a ticket is being viewed by another agent.

TicketsMaximumPersonalViewsToList Integer True

Maximum number of personal Views clients should display in menus.

TicketsTagging Boolean True

Tickets may be tagged.

TicketsMarkdownTicketComments Boolean True

Whether agent comments should be processed with Markdown.

TicketsEmojiAutocompletion Boolean True

Whether agent comments should allow for Emoji rendering.

TicketsAgentTicketDeletion Boolean False

Whether agents can delete tickets.

ChatEnabled Boolean True

Chat is enabled.

ChatMaximumRequests Integer True

The maximum number of chat requests an agent may handle at one time.

ChatWelcomeMessage String True

The message automatically sent to end-users when they begin chatting with an agent.

TwitterShortenUrl String True

Possible values: always, optional, never.

GSuiteHasGoogleApps Boolean True

Whether has google apps.

GSuiteHasGoogleAppsAdmin Boolean False

Account has at least one G Suite admin.

VoiceEnabled Boolean True

Whether Voice is enabled.

VoiceMaintenance Boolean True

.

VoiceLogging Boolean True

.

VoiceOutboundEnabled Boolean True

.

VoiceAgentConfirmationWhenForwarding Boolean True

.

VoiceAgentWrapUpAfterCalls Boolean True

.

VoiceMaximumQueueSize Integer True

.

VoiceMaximumQueueWaitTime Integer True

.

VoiceOnlyDuringBusinessHours Boolean True

.

VoiceRecordingsPublic Boolean True

.

VocieUkMobileForwarding Boolean True

.

UsersTagging Boolean True

Users may be tagged.

UsersTimeZoneSelection Boolean True

Whether user can view time zone for profile.

UsersLanguageSelection Boolean True

Whether to display language drop down for a user.

UsersAgentCreatedWelcomeEmails Boolean True

Whether a user created by an agent receives a welcome email.

UsersEndUserPhoneNumberValidation Boolean False

Whether a user's phone number is validated.

GooddataAdvancedAnalytics_Enabled Boolean True

GoodData Advanced Analytics is enabled.

BrandsDefaultBrandId Long False

The id of the brand that is assigned to tickets by default.

BrandsRequireBrandOnNewTickets Boolean True

Require agents to select a brand before saving tickets.

StatisticsForum Boolean True

Allow users to view forum statistics.

StatisticsSearch Boolean True

Allow users to view search statistics.

BillingBackend String True

Backend Billing system either internal or zuora.

ActiveFeaturesOnHoldStatus Boolean True

Account can use status hold.

ActiveFeaturesUserTagging Boolean True

Enable user tags.

ActiveFeaturesTicketTagging Boolean True

Allow tagging tickets.

ActiveFeaturesTopicSuggestion Boolean True

Allow topic suggestions in tickets.

ActiveFeaturesVoice Boolean True

Voice support.

ActiveFeaturesFacebookLogin Boolean True

Facebook login.

ActiveFeaturesGoogleLogin Boolean True

Google login.

ActiveFeaturesTwitterLogin Boolean True

Twitter login.

ActiveFeaturesForumAnalytics Boolean True

Forum and search analytics.

ActiveFeaturesBusinessHours Boolean False

Business hours.

ActiveFeaturesAgentForwarding Boolean True

Agent forwarding.

ActiveFeaturesChat Boolean True

Chat.

ActiveFeaturesChatAboutMyTicket Boolean True

Chat about my ticket.

ActiveFeaturesCustomerSatisfaction Boolean False

Customer satisfaction.

ActiveFeaturesSatisfactionPrediction Boolean False

Satisfaction Prediction.

ActiveFeaturesCsatReasonCode Boolean True

Csat reason code.

ActiveFeaturesScreencasts Boolean True

.

ActiveFeaturesMarkdown Boolean True

Markdown in ticket comments.

ActiveFeaturesLanguageDetection Boolean True

Language detection.

ActiveFeaturesBccArchiving Boolean True

Account has a bcc_archive_address set.

ActiveFeaturesAllowCcs Boolean True

Allow ccs.

ActiveFeaturesAdvancedAnalytics Boolean True

Advanced analytics.

ActiveFeaturesInsights Boolean True

Insights.

ActiveFeaturesSandbox Boolean True

Account has a sandbox.

ActiveFeaturesSuspendedTicketNotification Boolean True

Suspended ticket notification.

ActiveFeaturesTwitter Boolean True

Account monitors at least one Twitter handle.

ActiveFeaturesFacebook Boolean True

Account is actively linked to at least one Facebook page.

ActiveFeaturesFeedbackTabs Boolean True

Feedback tab has been configured before.

ActiveFeaturesDynamicContents Boolean True

Account has at least one dynamic content.

ActiveFeaturesLightAgents Boolean True

Account has at least one light agent.

ActiveFeaturesTicketForms Boolean True

Ticket forms.

ActiveFeaturesUserOrgFields Boolean True

User org fields.

ActiveFeaturesIsAbusive Boolean True

Account exceeded trial limits.

ActiveFeaturesRichContentInEmails Boolean True

Account supports incoming HTML email.

ApiAcceptedApiAgreement Boolean False

Account has accepted the API agreement.

ApiPasswordAccess Boolean False

Allow the account to use the API with username/password.

ApiTokenAccess Boolean False

Allow the account to use the API with API tokens.

TicketFormsInstructions String False

.

RawTicketFormsInstructions String True

.

LotusPrefer Boolean True

Prefers the current version of Zendesk Support rather than Zendesk Classic.

RulesMacroMostUsed Boolean False

Display the most-used macros in the Apply macro list. Defaults to true.

RulesMacroOrder String False

Default macro display order. Possible values are alphabetical or position.

LimitsAttachmentSize Integer True

The maximum ticket attachment file size (in bytes).

MetricsAccountSize String True

An account size category computed from the number of billable agents.



Automations

Create, update, delete, and query Automations in Zendesk.

Table Specific Information
Select
The following queries are processed server side, while other filters are processed client side within the driver.
SELECT * FROM Automations WHERE Id = '123'



SELECT * FROM Automations Order By Position 



SELECT * FROM Automations Order By CreatedAt  



SELECT * FROM Automations Order By UpdatedAt

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when created.

Title String False

The title of the automation.

Active Boolean False

Whether the automation is active.

Position Integer False

The position of the automation.

ConditionsAll String False

An object that describes the conditions under which the automation will execute.

ConditionsAny String False

An object that describes the conditions under which the automation will execute.

Actions String False

An object describing what the automation will do.

CreatedAt Datetime True

The time the automation was created.

UpdatedAt Datetime True

The time of the last update of the automation.



Brands

Create, delete, update, and query Brands in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Brands



SELECT * FROM Brands WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long False

Automatically assigned when the brand is created.

Name String False

The name of the brand.

CreatedAt Datetime False

The time the brand was created.

UpdatedAt Datetime False

The time of the last update of the brand.

BrandUrl String False

The url of the brand.

HasHelpCenter Boolean False

If the brand has a Help Center.

HelpCenterState String False

The state of the Help Center: enabled, disabled, or restricted.

Active Boolean False

If the brand is set as active.

Default Boolean False

Is the brand the default brand for this account.

LogoId Long False

The id of logo image for this brand.

LogoUrl String False

The url of logo image for this brand.

LogoFileName String False

The name of logo image for this brand.

LogoContentUrl String False

The content url of logo image for this brand.

LogoMappedContentUrl String False

The mapped content url of logo image for this brand.

LogoContentType String False

The content type of logo image for this brand.

LogoSize Integer False

The size of logo image for this brand.

TicketFormIds String False

The ids of ticket forms that are available for use by a brand.

HostMapping String False

The hostmapping to this brand, if any (only admins view this key).

Subdomain String False

The subdomain of the brand.

SignatureTemplate String False

The signature template for a brand.

Url String False

The API url of this brand.



GroupMemberships

Create, delete, and query Group Memberships in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM GroupMemberships



SELECT * FROM GroupMemberships WHERE Id = '123'



SELECT * FROM GroupMemberships WHERE UserId = '123'



SELECT * FROM GroupMemberships WHERE GroupId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the ticket is created.

UserId Long False

Users.Id

The id of an agent.

GroupId Long False

Groups.Id

The id of a group.

Default Boolean False

If true, tickets assigned directly to the agent will assume this membership's group.

CreatedAt Datetime True

The time the membership was created.

UpdatedAt Datetime True

The time of the last update of the membership.

Url String True

The API url of this record.



Groups

Create, update, delete, and query Groups in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Groups



SELECT * FROM Groups WHERE Id = '123'



SELECT * FROM Groups WHERE UserId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the ticket is created.

Name String False

The name of the group.

CreatedAt Datetime True

The time the group was created.

UpdatedAt Datetime True

The time of the last update of the group.

Deleted Boolean True

Deleted groups get marked as such.

Url String True

The API url of this group.

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
UserId Long

The user id used to query groups



Holidays

Create, update, delete, and query Schedules in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Holidays



SELECT * FROM Holidays WHERE ScheduleId = '123'



SELECT * FROM Holidays WHERE ScheduleId = '123' AND Id = '456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned upon creation.

ScheduleId Long False

Schedules.Id

Id of the schedule the holiday belongs to.

Name String False

Name of the holiday.

StartDate Date False

Time when the holiday starts.

EndDate Date False

Time when the holiday ends.



JiraLinks

View and create links between your Jira and Zendesk instances.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM JiraLinks

SELECT * FROM JiraLinks WHERE Id = 123

SELECT * FROM JiraLinks WHERE TicketId = 123

SELECT * FROM JiraLinks WHERE IssueId = 123

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

Automatically assigned when the link is created.

TicketId Integer False

Tickets.Id

The id of the Zendesk ticket.

IssueId Integer False

The id of the Jira issue.

IssueKey String False

The key for the Jira issue.

CreatedAt Datetime True

The time at which the link was created.

UpdatedAt Datetime True

The time at which the link was last updated.



Macros

Create, update, delete, and query Macros in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Macros



SELECT * FROM Macros WHERE Id = '123'



SELECT * FROM Macros WHERE Active = true



SELECT * FROM Macros Order By CreatedAt



SELECT * FROM Macros Order By UpdateddAt

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long False

Automatically assigned when created.

Title String False

The title of the macro.

Actions String False

An object describing what the macro will do.

Active Boolean False

Useful for determining if the macro should be displayed.Only active macros if true, inactive macros if false.

Description String False

The description of the macro.

Position Integer False

The position of the macro.

Restrictions String False

Who may access this macro. Will be null when everyone in the account can access it.

CreatedAt Datetime False

The time the macro was created.

UpdatedAt Datetime False

The time of the last update of the macro.

Access String False

Only macros with given access. Possible values are personal, shared, or account.

Category String False

Only macros within given category.

GroupId Integer False

Groups.Id

Only macros belonging to given group.

OnlyViewable Boolean False

Only macros that can be applied to tickets if true, All macros the current user can manage if false. Defaults to false.

Attachments String False

An array of macro attachment IDs to be associated with the macro, used in Insertion



OrganizationFields

Create, update, delete, and query Organization Fields in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM OrganizationFields



SELECT * FROM OrganizationFields WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned upon creation.

Key String False

A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders. After a field is created, you cannot change its key.

Type String False

Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea. After a field is created, you cannot change its type.

Title String False

The title of the custom field.

RawTitle String False

The dynamic content placeholder, if present, or the title value, if not.

Description String False

User-defined description of this field s purpose.

RawDescription String False

The dynamic content placeholder, if present, or the description value, if not.

Position Integer False

Ordering of the field relative to other fields.

Active Boolean False

If true, this field is available for use.

System Boolean True

If true, only active and position values of this field can be changed.

RegexpForValidation String False

Regular expression field only. The validation pattern for a field value to be deemed valid..

CreatedAt Datetime True

The time the ticket field was created.

UpdatedAt Datetime True

The time of the last update of the ticket field.

Tag String False

Optional for custom field of type checkbox; not presented otherwise.

CustomFieldOptions String False

Required and presented for a custom field of type dropdown.

Url String True

The URL for this resource.



OrganizationMemberships

Create, delete, and query Organization Memberships in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM OrganizationMemberships



SELECT * FROM OrganizationMemberships WHERE Id = '123'



SELECT * FROM OrganizationMemberships WHERE UserId = '123'



SELECT * FROM OrganizationMemberships WHERE OrganizationId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the membership is created.

OrganizationId Long False

Organizations.Id

The ID of the organization associated with this user, in this membership.

UserId Long False

Users.Id

The ID of the user for whom this memberships belongs.

Default Boolean False

Denotes whether this is the default organization membership for the user. If false, returns null.

CreatedAt Datetime True

When this record was created.

UpdatedAt Datetime True

When this record last got updated.

Url String True

The url of this resource.



Organizations

Create, delete, update, and query Organizations in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Organizations



SELECT * FROM Organizations WHERE Id = '123'



SELECT * FROM Organizations WHERE Id IN ('123','456')



SELECT * FROM Organizations WHERE UserId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the ticket is created.

Name String False

A unique name for the organization.

GroupId Long False

Groups.Id

New tickets from users in this organization are automatically put in this group.

ExternalId Long False

A unique external id to associate organizations to an external record.

CreatedAt Datetime True

The time the organization was created.

UpdatedAt Datetime True

The time of the last update of the organization.

DomainNames String False

An array of domain names associated with this organization.

Details String False

Any details obout the organization, such as the address.

Notes String False

Any notes you have about the organization.

SharedTickets Boolean False

End users in this organization are able to see tickets of each other.

SharedComments Boolean False

End users in this organization are able to see comments on tickets of each other.

Tags String False

The tags of the organization.

Url String True

The URL for this resource.

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
UserId Long

The user id used to query organizations



OrganizationSubscriptions

Create, delete, and query Organization Subscriptions in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM OrganizationSubscriptions



SELECT * FROM OrganizationSubscriptions WHERE Id = '123'



SELECT * FROM OrganizationSubscriptions WHERE UserId = '123'



SELECT * FROM OrganizationSubscriptions WHERE OrganizationId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Organization subscription id.

OrganizationId Long False

Organizations.Id

.

UserId Long False

.

CreatedAt Datetime True

.

Url String True

The url of this resource.



PostComments

Query, Insert, Update and Delete PostComments in Zendesk.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the comment is created.

Url String True

The API url of the comment.

HtmlUrl String True

The community url of the comment.

Body String False

The comment made by the author.

AuthorId Long True

The id of the author of the comment. *Writable on create by Help Center managers.

PostId Long True

Posts.Id

The id of the post on which the comment was made.

Official Boolean False

Whether the comment is marked as official.

VoteSum Integer True

The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.

VoteCount Integer True

The total number of upvotes and downvotes.

CreatedAt Datetime True

The time the post was created.

UpdatedAt Datetime True

The time of the last update of the post.

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
FilterBy String

May be planned, not_planned, completed, answered or none.



Posts

Query, Insert, Update and Delete Posts in Zendesk.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the post is created.

Url String True

The API url of the post.

HtmlUrl String True

The community url of the post.

Title String False

The title of the post.

Details String False

The details of the post.

AuthorId Integer True

The id of the author of the post. *Writable on create by Help Center managers.

Pinned Boolean False

When true, pins the post to the top of its topic.

Featured Boolean False

Whether the post is featured.

Closed Boolean False

Whether further comments are allowed.

Status String False

The status of the post. Possible values:

VoteSum Integer True

The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.

VoteCount Integer True

The total number of upvotes and downvotes.

CommentCount Integer True

The number of comments on the post.

FollowerCount Integer True

The number of followers of the post.

TopicId Long False

Topics.Id

The id of the topic that the post belongs to.

CreatedAt Datetime True

The time the post was created.

UpdatedAt Datetime True

The time of the last update of the post.

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
FilterBy String

May be planned, not_planned, completed, answered or none.



SatisfactionRatings

Create and query Requests in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM SatisfactionRatings



SELECT * FROM SatisfactionRatings WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type ReadOnly References Description
Id [KEY] Long False

Automatically assigned upon creation.

TicketId Integer False

Tickets.Id

The id of ticket being rated.

Score String False

The rating: offered, unoffered, good or bad. When used in a filter it takes one of values: offered, unoffered, received, received_with_comment, received_without_comment, good, good_with_comment, good_without_comment, bad, bad_with_comment, bad_without_comment.

Comment String False

The comment received with this rating, if available.

Reason String False

The reason for a bad rating given by the requester in a follow-up question. Satisfaction reasons must be enabled.

AssigneeId Long False

Users.Id

The id of agent assigned to at the time of rating.

GroupId Long False

Groups.Id

The id of group assigned to at the time of rating.

RequesterId Long False

Users.Id

The id of ticket requester submitting the rating.

CreatedAt Datetime False

The time the satisfaction rating got created.

UpdatedAt Datetime False

The time the satisfaction rating got updated.

Url String False

The API url of this rating.

StartTime Datetime False

Time of the oldest satisfaction rating

EndTime Datetime False

Time of the most recent satisfaction rating



Schedules

Create, update, delete and query Schedules in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Schedules



SELECT * FROM Schedules WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned upon creation.

Name String False

Name of the schedule.

TimeZone String False

Time zone of the schedule.

Intervals String False

Array of intervals for the schedule.

CreatedAt Datetime True

Time the schedule was created.

UpdatedAt Datetime True

Time the schedule was last updated.



Sessions

Query and delete Sessions in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Sessions



SELECT * FROM Sessions WHERE Userid = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the session is created.

UserId Long True

Users.Id

The id of the user.

AuthenticatedAt Datetime True

When the session was created.

LastSeenAt Datetime True

The last approximate time this session was seen. This does not update on every request.

Url String True

The API URL of this session.



SharingAgreements

Create, update, delete, and query SharingAgreements in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM SharingAgreements



SELECT * FROM SharingAgreements WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned upon creation.

Name String True

Name of this sharing agreement.

Type String True

Can be one of the following: 'inbound', 'outbound'.

Status String False

Can be one of the following: 'accepted', 'declined', 'pending', 'inactive'.

PartnerName String True

Can be one of the following: 'jira', null.

RemoteSubdomain String False

Subdomain of the remote account or null if not associated with an account.

CreatedAt Datetime True

The time the record was created.



SupportAddresses

Create, update, delete, and query Support Addresses in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM SupportAddresses



SELECT * FROM SupportAddresses WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when created.

Name String False

The name for the address.

Email String False

The email address (not updateable).

CreatedAt Datetime True

The time the brand was created.

UpdatedAt Datetime True

The time of the last update of the brand.

Default Boolean False

Whether the address is the account's default support address.

BrandId Long False

Brands.Id

The id of the brand.

ForwardingStatus String True

Possible values: unknown, waiting, verified, or failed.

SpfStatus String True

Possible values: unknown, verified, failed.



SuspendedTickets

Query and delete Suspended Tickets in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM SuspendedTickets



SELECT * FROM SuspendedTickets WHERE Id = '123'



SELECT * FROM SuspendedTickets Order By AuthorEmail



SELECT * FROM SuspendedTickets Order By Cause



SELECT * FROM SuspendedTickets Order By Subject



SELECT * FROM SuspendedTickets Order By CreatedAt

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the ticket is created.

TicketId Integer True

Tickets.Id

The ticket ID this suspended email is associated with, if available.

MessageId String True

The ID of the email, if available.

BrandId Long True

Brands.Id

The id of the brand this ticket is associated with - only applicable for enterprise accounts.

Recipient String True

The original recipient e-mail address of the ticket.

Subject String True

The value of the subject field for this ticket.

Content String True

The content that was flagged.

AuthorId Long True

The id of author.

AuthorName String True

The name of author.

AuthorEmail String True

The email of author.

Cause String True

Why the ticket was suspended.

CreatedAt Datetime True

When this record was created.

UpdatedAt Datetime True

When this record last got updated.

ViaChannel String True

.

ViaSourceFromId Long True

.

ViaSourceFromTitle String True

.

ViaSourceTo String True

.

ViaSourceRel String True

.

Url String True

The API url of this ticket.



TicketFields

Create, update, delete, and query TicketFields in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM TicketFields



SELECT * FROM TicketFields WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the ticket is created.

Type String False

The type of the ticket field: checkbox, date, decimal, integer, regexp, tagger, text, or textarea. Type is not editable once created.

Title String False

The title of the ticket field.

RawTitle String False

The dynamic content placeholder, if present, or the 'title' value, if not.

Description String False

The description of the purpose of this ticket field, shown to users.

RawDescription String False

The dynamic content placeholder, if present, or the 'description' value, if not.

Position Integer False

A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields.

Active Boolean False

Whether this field is available.

Required Boolean False

Whether this field is available.

CollapsedForAgents Boolean False

If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only.

RegexpForValidation String False

Regular expression field only. The validation pattern for a field value to be deemed valid.

TitleInPortal String False

The title of the ticket field when shown to end users.

RawTitleInPortal String False

The dynamic content placeholder, if present, or the 'title_in_portal' value, if not.

VisibleInPortal Boolean False

Whether this field is available to end users.

EditableInPortal Boolean False

Whether this field is editable by end users.

Tag String False

A tag value to set for checkbox fields when checked.

CreatedAt Datetime True

The time the ticket field was created.

UpdatedAt Datetime True

The time of the last update of the ticket field.

SystemFieldOptions String True

Presented for a ticket field of type 'tickettype', 'priority' or 'status'.

CustomFieldOptions String False

Required and presented for a ticket field of type 'tagger'.

Removable Boolean True

If this field is not a system basic field that must be present for all tickets on the account.

Url String True

The URL for this resource.



TicketForms

Create, update, delete, and query Ticket Forms in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM TicketForms



SELECT * FROM TicketForms WHERE Id = '123'



SELECT * FROM TicketForms WHERE Id IN ('123', '456')



SELECT * FROM TicketForms WHERE Active = true



SELECT * FROM TicketForms WHERE EndUserVisible = true



SELECT * FROM TicketForms WHERE FallbackToDefault = true



SELECT * FROM TicketForms WHERE AssociatedToBrand = true

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Ticket form id.

Name String False

The name of the form.

RawName String False

The dynamic content placeholder, if present, or the 'name' value, if not.

DisplayName String False

The name of the form that is displayed to an end user.

RawDisplayName String False

The dynamic content placeholder, if present, or the 'display_name' value, if not.

Position Integer False

The position of this form among other forms in the account, i.e. dropdown.

Active Boolean False

If the form is set as active.

EndUserVisible Boolean False

Is the form visible to the end user.

Default Boolean False

Is the form the default form for this account.

TicketFieldIds String False

Ids of all ticket fields which are in this ticket form.

InAllBrands Boolean False

Is the form available for use in all brands on this account.

RestrictedBrandIds String False

Ids of all brands that this ticket form is restricted to.

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
FallbackToDefault Boolean

If true, returns default ticket form when the criteria defined by the parameters results in a set without active and end user visible ticket forms.

AssociatedToBrand Boolean

Only ticket forms of current brand (defined by url) if true.



Tickets

Create, update, delete, and query Tickets.

Table Specific Information
Select
The following queries are processed server side.
SELECT * FROM Tickets



SELECT * FROM Tickets WHERE Id = '123'



SELECT * FROM Tickets WHERE Id IN ('123', '456')



SELECT * FROM Tickets WHERE UserId = '123'



SELECT * FROM Tickets WHERE OrganizationId = '123'



SELECT * FROM Tickets WHERE ViewId = '123'

The following ticket property keywords (columns/pseudo-columns) from the Search API are supported in the WHERE clause: created (CreatedAt), updated (UpdatedAt), due_date (DueAt), assignee, submitter, requester, via, subject, description, status, priority, ticket_type (Type), group, tags, commenter, cc, has_attachment. The supported search operators are: =, <, >, <=, >=. For example:

SELECT * FROM Tickets WHERE CreatedAt='2017-02-15'



SELECT * FROM Tickets WHERE CreatedAt>'2017-02-15 10:15:00 AM' AND Status='open'

Other filters are processed client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Integer False

Automatically assigned when the ticket is created.

Subject String False

The value of the subject field for this ticket. When used in WHERE clause: The text in the ticket's subject

RawSubject String False

The dynamic content placeholder, if present, or the subject value, if not.

Description String False

The first comment on the ticket. When used in WHERE clause: The text in the ticket's description and comments

Type String False

The type of this ticket. Possible values: problem, incident, question or task.

Priority String False

The urgency with which the ticket should be addressed. Possible values: urgent, high, normal, low.

Status String False

The state of the ticket. Possible values: new, open, pending, hold, solved, closed.

Recipient String False

The original recipient e-mail address of the ticket.

HasIncidents Boolean False

Is true of this ticket has been marked as a problem, false otherwise.

DueAt Datetime False

If this is a ticket of type task it has a due date. Due date format uses ISO 8601 format.

RequesterId String False

Users.Id

The user who requested this ticket.

SubmitterId String False

Users.Id

The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket.

AssigneeId String False

Users.Id

The agent currently assigned to the ticket.

OrganizationId String False

Organizations.Id

The organization of the requester. You can only specify the ID of an organization associated with the requester.

GroupId Long False

Groups.Id

The group this ticket is assigned to. When used in WHERE clause: The assigned agent's group name.

CollaboratorIds String False

The ids of users currently cc-ed on the ticket.

FollowerIds String False

Agents currently following the ticket.

ForumTopicId String False

Topics.Id

The topic this ticket originated from, if any.

ProblemId String False

Tickets.Id

For tickets of type incident, the ID of the problem the incident is linked to.

ExternalId String False

An id you can use to link Zendesk Support tickets to local records.

FollowupIds String False

Closed tickets only. The ids of the followups created from this ticket.

ViaFollowupSourceId String False

POST requests only. The id of a closed ticket when creating a follow-up ticket..

MacroIds String False

POST requests only. List of macro IDs to be recorded in the ticket audit.

TicketFormId String False

TicketForms.Id

Enterprise only. The id of the ticket form to render for the ticket.

BrandId Long False

Brands.Id

Enterprise only. The id of the brand this ticket is associated with.

Tags String False

The array of tags applied to this ticket.

ViaChannel String False

This tells you how the ticket or event was created. Examples: web, mobile, rule, system.

ViaSource String False

The ticket's source.

CustomFields String False

Custom fields for the ticket.The values of custom field are set and get dynamically

SatisfactionRating String False

The satisfaction rating of the ticket, if it exists, or the state of satisfaction, 'offered' or 'unoffered'.

SharingAgreementIds String False

The ids of the sharing agreements used for this ticket.

AllowChannelback Boolean False

Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket.

IsPublic Boolean False

Is true if any comments are public, false otherwise.

CreatedAt Datetime False

When this record was created.

UpdatedAt Datetime False

When this record last got updated.

Url String False

The API url of this ticket.

View_Id String False

Views.Id

The view that tickets belong to.

User_Id String False

Users.Id

The user that tickets belong to.

Assignee String False

The assigned agent or other entity. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number

GroupName String False

The assigned agent's group name.

Requester String False

The ticket requester. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.

Submitter String False

The ticket submitter. This may be different than the requester if the ticket was submitted by an agent on behalf of the requester. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number. .

Brand String False

Search for a specific Brand on a ticket.

Via String False

The ticket's source, which can be any of the following:mail, api, phone, etc.

Solved Datetime False

The date the ticket was set to solved.

Commenter String False

People who have added comments to tickets. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.

Cc String False

People who have been CC'd on tickets. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.

HasAttachment Boolean False

Search for all tickets with or without attachments using 'true' or 'false'.

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
Comment String

Used to create a comment on the ticket, when creating or updating a ticket..

IsPublicComment Boolean

Used when creating a comment on the ticket. Set this to true to add a public comment and false to add an internal note.



Topics

Query, Insert, Update and Delete Topics in Zendesk.

Columns

Name Type ReadOnly References Description
Id [KEY] Long False

Automatically assigned when the topic is created.

Url String False

The API url of the topic.

HtmlUrl String False

The community url of the topic.

Name String False

The name of the topic.

Description String False

The description of the topic. By default an empty string.

Position Integer False

The position of the topic relative to other topics in the community.

FollowerCount Integer False

The number of users following the topic.

ManageableBy String False

The set of users who can manage this topic.

The allowed values are staff, managers.

UserSegmentId Long False

The id of the user segment to which this topic belongs.

CreatedAt Datetime False

When the topic was created.

UpdatedAt Datetime False

When the topic was last updated.



Triggers

Create, update, delete, and query Triggers in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Triggers



SELECT * FROM Triggers WHERE Id = '123'



SELECT * FROM Triggers WHERE Active=true



SELECT * FROM Triggers Order By Position



SELECT * FROM Triggers Order By CreatedAt



SELECT * FROM Triggers Order By UpdatedAt

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when created.

Title String False

The title of the trigger.

Active Boolean False

Whether the trigger is active.

Position Integer False

Position of the trigger, determines the order they will execute in.

ConditionsAll String False

An object that describes the conditions under which the trigger will execute.

ConditionsAny String False

An object that describes the conditions under which the trigger will execute.

Actions String False

An object describing what the trigger will do.

Description String False

The description of the trigger.

CreatedAt Datetime True

The time the trigger was created.

UpdatedAt Datetime True

The time of the last update of the trigger.



UserFields

Create, update, delete, and query User Fields.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM UserFields



SELECT * FROM UserFields WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned upon creation.

Key String False

A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders.After a field is created, you cannot change its key.

Type String False

Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea.After a field is created, you cannot change its type

Title String False

The title of the custom field.

RawTitle String False

The dynamic content placeholder, if present, or the title value, if not.

Description String False

User-defined description of this field's purpose.

RawDescription String False

The dynamic content placeholder, if present, or the description value, if not.

Position Integer False

Ordering of the field relative to other fields.

Active Boolean False

If true, this field is available for use.

System Boolean True

If true, only active and position values of this field can be changed.

RegexpForValidation String False

Regular expression field only. The validation pattern for a field value to be deemed valid.

CreatedAt Datetime True

The time the ticket field was created.

UpdatedAt Datetime True

The time of the last update of the ticket field.

Tag String False

Optional for custom field of type checkbox; not presented otherwise.

CustomFieldOptions String False

Required and presented for a custom field of type dropdown.

Url String True

The URL for this resource.



UserIdentities

Create, update, delete, and query User Identities.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM UserIdentities



SELECT * FROM UserIdentities WHERE UserId = '123'



SELECT * FROM UserIdentities WHERE UserId = '123' AND Id='345'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned on creation.

UserId Long False

Users.Id

The id of the user.

Type String False

One of email, twitter, facebook, google, or phone_number.

Value String False

The identifier for this identity, such as an email address.

Verified Boolean False

If the identity has been verified.

Primary Boolean True

If the identity is the primary identity. Writable only when creating, not when updating.

CreatedAt Datetime True

The time the ticket field was created.

UpdatedAt Datetime True

The time of the last update of the ticket field.

UndeliverableCount Integer True

The time of the last update of the ticket field.

DeliverableState String True

The time of the last update of the ticket field.

Url String True

The URL for this resource.



Users

Create, update, delete, and query Users in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Users



SELECT * FROM Users WHERE Id = '123'



SELECT * FROM Users WHERE Id IN ('123', '456')



SELECT * FROM Users WHERE GroupId = '123'



SELECT * FROM Users WHERE OrganizationId = '123'



SELECT * FROM Users WHERE Role = 'agent'



SELECT * FROM Users WHERE PermissionSet = 'roleid'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.


Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Automatically assigned when the ticket is created.

Email String False

The primary email address of the user. Writeable on create only. On update, a secondary email is added.

Name String False

The name of the user.

Role String False

The role of the user. Possible values are end-user, agent, or admin.

Active Boolean True

False if the user has been deleted.

OrganizationId Long False

Organizations.Id

The id of the organization the user is associated with.

Alias String False

An alias displayed to end users.

Verified Boolean False

If the identity of the user has been verified or not.

ChatOnly Boolean True

Whether or not the user is a chat-only agent.

CreatedAt Datetime True

The time the user was created.

UpdatedAt Datetime True

The time the user was last updated.

CustomRoleId Long False

A custom role if the user is an agent on the Enterprise plan.

RoleType String True

The role id of the user. 0 for custom agents, 1 for light agent and 2 for chat agent.

DefaultGroupId Long False

The id of the default group of the user. Can only be set on create, not on update.

Details String False

Any details you want to store about the user, such as an address.

ExternalId Long False

A unique identifier from another system.

LastLoginAt Datetime True

The last time the user signed in to Zendesk Support.

Locale String True

The locale of the user.

LocaleId Long False

The language identifier of the user.

Moderator Boolean False

Designates whether the user has forum moderation capabilities.

Notes String False

Any notes you want to store about the user.

OnlyPrivateComments Boolean False

True if the user can only create private comments.

Phone String False

The primary phone number of the user.

Photo String True

photo attachment.

PhotoThumbnails String True

photo thumbnails.

PhotoInline Boolean True

If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.

RestrictedAgent Boolean False

If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.

Shared Boolean True

If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only.

SharedAgent Boolean True

If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only.

Signature String False

The signature of the user. Only agents and admins can have signatures.

Suspended Boolean False

If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal.

Tags String False

The tags of the user. Only present if your account has user tagging enabled.

TicketRestriction String False

Specifies which tickets the user has access to. Possible values are: organization, groups, assigned, requested, null.

TimeZone String False

The time zone of the user.

TwoFactorAuthEnabled Boolean True

If two factor authentication is enabled.

Url String False

The API url of the user.

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
GroupName String

Organization String

The name of the organization the user is associated with.

GroupId String

The name of the group the user belongs to.

PermissionSet String

Used for custom roles in the Enterprise plan. You can only filter by one role id per request.



Views

Query and delete Views in Zendesk.

Table Specific Information
Select

The following queries are processed server side while other filters are processed client side by the driver. Allowed for agents.

SELECT * FROM Views



SELECT * FROM Views WHERE Id = '123'



SELECT * FROM Views WHERE GroupId = '123'



SELECT * FROM Views WHERE Access = 'Shared'



SELECT * FROM Views WHERE Active = true



SELECT * FROM Views Order By CreatedAt



SELECT * FROM Views Order By UpdatedAt

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type ReadOnly References Description
Id [KEY] Long False

Automatically assigned when the ticket is created.

Title String False

The title of the view.

Active Boolean False

Useful for determining if the view should be displayed.

SlaId Long False

SlaPolicies.Id

If the view is for an SLA, shows the id.

RestrictionId Long False

The id of the restricion (who may access this account. Will be null when everyone in the account can access it).

RestrictionType String False

The type of the restricion (who may access this account. Will be null when everyone in the account can access it).

RestrictionIds String False

The numeric IDs of a single or more groups. Recommended for 'Group' type.

Position Integer False

The position of the view.

ExecutionGroupBy String False

Execution is an object describing how the view should be executed.

ExecutionGroupOrder String False

Execution is an object describing how the view should be executed.

ExecutionSortBy String False

Execution is an object describing how the view should be executed.

ExecutionSortOrder String False

Execution is an object describing how the view should be executed.

ExecutionGroup String False

Execution is an object describing how the view should be executed.

ExecutionSort String False

Execution is an object describing how the view should be executed.

ExecutionColumns String False

Execution is an object describing how the view should be executed.

ExecutionFields String False

Execution is an object describing how the view should be executed.

ExecutionCustomFields String False

Execution is an object describing how the view should be executed.

ConditionsAll String False

Logical AND. Tickets must fulfill all of the conditions to be considered matching.Conditions is an object describing how the view is constructed.

ConditionsAny String False

Logical OR. Tickets may satisfy any of the conditions to be considered matching.Conditions is an object describing how the view is constructed.

CreatedAt Datetime False

The time the view was created.

UpdatedAt Datetime False

The time of the last update of the view.

Access String False

Only views with given access. May be personal, shared, or account

GroupId Integer False

Groups.Id

The group id the view belongs to. Used to query the table





ViewsBack To Top

  1. ActivityStream
  2. AppLocations
  3. Attachments
  4. Collaborators
  5. CustomAgentRoles
  6. JobStatus
  7. Locales
  8. MonitoredTwitterHandles
  9. Requests
  10. Requests_Collaborators
  11. SlaPolicies
  12. TicketAudits
  13. TicketComments
  14. TicketMetricEvents
  15. TicketMetrics
  16. Tickets_Collaborators
  17. Tickets_Followers
  18. Tickets_Followups
  19. Tickets_Macros
  20. Tickets_SatisfactionRatings
  21. Tickets_SharingAgreements
  22. Tickets_Tags
  23. Tickets_Viasources
  24. UserRelatedInformation

ActivityStream

Query ActivityStreams in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM ActivityStream



SELECT * FROM ActivityStream WHERE Id = '123'



SELECT * FROM ActivityStream WHERE Since = '2017-02-15 10:15:25'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned upon creation.
Title String Description of this activity.
Verb String The type of activity. Can be tickets.assignment, tickets.comment, or tickets.priority_increase.
UserId Long

Users.Id

The user this activity pertains to.
ActorId Long

Users.Id

The user this activity pertains to.
CreatedAt Datetime When this locale was created.
UpdatedAt Datetime When this locale last got updated.
Url String The API url of this activity.



AppLocations

Query AppLocations in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM AppLocations



SELECT * FROM AppLocations WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Internal location ID.
Name String The unique location key.
ProductCode Integer Internal product ID.
HostApplication String The unique host application key.
Orderable Boolean True if reordering has any effect.



Attachments

Show ticket attachments in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Attachments



SELECT * FROM Attachments WHERE TicketId ='123'

 

SELECT * FROM Attachments WHERE AttachmentId ='123' 

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type References Description
AttachmentId [KEY] Long Automatically assigned when the ticket is created.
TicketId Integer

Tickets.Id

The id of the ticket the comment belongs to.
CommentId Long

TicketComments.Id

The id of the comment the attachment belongs to.
FileName String The name of the form.
ContentUrl String A full URL where the attachment image file can be downloaded.
ContentType String The content type of the image.
Size Integer The size of the image file in bytes.
Inline Boolean If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.



Collaborators

Query Collaborators in Zendesk.

Table Specific Information
Select

The following queries are processed server side while other filters are processed client side within the driver:

SELECT * FROM Collaborators



SELECT * FROM Collaborators WHERE TicketId = '123' 

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned when the ticket is created.
TicketId Integer

Tickets.Id

The id of the ticket.
Email String The primary email address of the collaborator. Writeable on create only. On update, a secondary email is added.
Name String The name of the collaborator.
Role String The role of the collaborator. Possible values are end-collaborator, agent, or admin.
Active Boolean False if the collaborator has been deleted.
OrganizationId Long

Organizations.Id

The id of the organization the collaborator is associated with.
Alias String An alias displayed to end users.
Verified Boolean If the identity of the collaborator has been verified or not.
ChatOnly Boolean Whether or not the collaborator is a chat-only agent.
CreatedAt Datetime The time the collaborator was created.
UpdatedAt Date The time the collaborator was last updated.
CustomRoleId Long

CustomAgentRoles.Id

A custom role if the collaborator is an agent on the Enterprise plan.
RoleType String The role id of the collaborator. 0 for custom agents, 1 for light agent and 2 for chat agent.
DefaultGroupId Long

Groups.Id

The id of the default group of the collaborator. Can only be set on create, not on update.
Details String Any details you want to store about the collaborator, such as an address.
ExternalId String A unique identifier from another system.
LastLoginAt Datetime The last time the collaborator signed in to Zendesk Support.
Locale String The locale of the collaborator.
LocaleId Long

Locales.Id

The language identifier of the collaborator.
Moderator Boolean Designates whether the collaborator has forum moderation capabilities.
Notes String Any notes you want to store about the collaborator.
OnlyPrivateComments Boolean True if the collaborator can only create private comments.
Phone String The primary phone number of the collaborator.
PhotoId Long Automatically assigned when the attachment is created.
PhotoFileName String The name of the image file.
PhotoContentUrl String A full URL where the attachment image file can be downloaded.
PhotoContentType String The content type of the image. Example value: image/png.
PhotoSize Integer The size of the image file in bytes.
PhotoThumbnailsId Long .
PhotoThumbnailsFileName String .
PhotoThumbnailsContentUrl String .
PhotoThumbnailsContentType String .
PhotoThumbnailsSize Integer .
PhotoInline Boolean If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.
RestrictedAgent Boolean If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
Shared Boolean If the collaborator is shared from a different Zendesk Support instance. Ticket sharing accounts only.
SharedAgent Boolean If the collaborator is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only.
Signature String The signature of the collaborator. Only agents and admins can have signatures.
Suspended Boolean If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end collaborator portal.
Tags String The tags of the collaborator. Only present if your account has collaborator tagging enabled.
TicketRestriction String Specifies which tickets the collaborator has access to. Possible values are: organization, groups, assigned, requested, null.
TimeZone String The time zone of the collaborator.
TwoFactorAuthEnabled Boolean If two factor authentication is enabled.
Url String The API url of the collaborator.



CustomAgentRoles

Query CustomAgentRoles in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM CustomAgentRoles

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned upon creation.
Name String .
Description String .
CreatedAt Datetime .
UpdatedAt Datetime .
ConfigurationChatAccess Boolean .
ConfigurationEndUserProfile String .
ConfigurationForumAccess String .
ConfigurationForumAccessRestrictedContent Boolean .
ConfigurationMacroAccess String .
ConfigurationManageBusinessRules Boolean .
ConfigurationManageDynamicContent Boolean .
ConfigurationManageExtensionsAndChannels Boolean .
ConfigurationManageFacebook Boolean .
ConfigurationOrganizationEditing Boolean .
ConfigurationReportAccess String .
ConfigurationTicketAccess String .
ConfigurationTicketCommentAccess String .
ConfigurationTicketDeletion Boolean .
ConfigurationTicketMerge Boolean .
ConfigurationTicketTagEditing Boolean .
ConfigurationTwitterSearchAccess Boolean .
ConfigurationViewAccess String .
ConfigurationUserViewAccess String .



JobStatus

A status record is created when somebody kicks off a job such as updating multiple tickets. You can access the job status data for an hour after a particular job is created, after which the data is no longer available.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM JobStatus



SELECT * FROM JobStatus WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] String Automatically assigned when the job is queued.
Total Integer The total number of tasks this job is batching through.
Progress Integer Number of tasks that have already been completed.
Status String The current status. One of the following: queued, working, failed, completed, killed.
Message String Message from the job worker, if any.
Results String Result data from processed tasks.
Url String The URL to poll for status updates.



Locales

Query Locales in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Locales

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned.
Name String Name of the locale.
Locale String The locale.
CreatedAt Datetime When this locale was created.
UpdatedAt Datetime When this locale last got updated.
Url String The API url of the locale.



MonitoredTwitterHandles

Query Monitored Twitter handles in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM MonitoredTwitterHandles



SELECT * FROM MonitoredTwitterHandles WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned upon creation.
ScreenName String Name of the locale.
TwitterUserId Long The country's code.
CreatedAt Datetime The time the handle was created.
UpdatedAt Datetime The time of the last update of the handle.
AvatarUrl String The profile image url of the handle.
Name String The profile name of the handle.
AllowReply Boolean The profile image url of the handle.
CanReply Boolean If replies are allowed for this handle.
BrandId Long

Brands.Id

What brand the handle is associated with.



Requests

Query Requests in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM Requests



SELECT * FROM Requests WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned when creating requests.
Subject String The value of the subject field for this request if the subject field is visible to end users; a truncated version of the description otherwise.
Description String The first comment on the request.
Status String The state of the request, new, open, pending, hold, solved, closed.
Priority String The priority of the request, low, normal, high, urgent.
Type String The type of the request, question, incident, problem, task.
OrganizationId Long

Organizations.Id

The organization of the requester.
RequesterId Long

Users.Id

The id of the requester.
AssigneeId Long

Users.Id

The id of the assignee if the field is visible to end users.
GroupId Long

Groups.Id

The id of the assigned group if the field is visible to end users.
CollaboratorIds String Who are currently CC'ed on the ticket.
ViaChannel String This tells you how the ticket or event was created. Examples: web, mobile, rule, system.
ViaSource String For some channels a source object gives more information about how or why the ticket or event was created.
IsPublic Boolean Is true if any comments are public, false otherwise.
DueAt Date When the task is due (only applies if the request is of type 'task').
CanBeSolvedByMe Boolean If true, end user can mark request as solved.
Solved Boolean Whether or not request is solved (an end user can set this if 'can_be_solved_by_me', above, is true for that user).
TicketFormId Long

TicketForms.Id

The numeric id of the ticket form associated with this request if the form is visible to end users - only applicable for enterprise accounts.
Recipient String The original recipient e-mail address of the request.
FollowupSourceId Long

Tickets.Id

The id of the original ticket if this request is a follow-up ticket.
CreatedAt Datetime The time the request was created.
UpdatedAt Datetime The time of the last update of the request.
Url String The API url of this request.



Requests_Collaborators

The Collaborator ids of users currently CC'ed on the ticket.

Columns

Name Type References Description
Id Long

Requests.Id

Automatically assigned when creating requests.
CollaboratorId Long

Collaborators.Id

The id of users currently CC'ed on the ticket



SlaPolicies

Query SlaPolicies in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM SlaPolicies



SELECT * FROM SlaPolicies WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned.
Title String The title of the SLA policy.
Description String The description of the SLA policy.
CreatedAt Datetime When this locale was created.
UpdatedAt Datetime When this locale last got updated.
Position Integer Position of the SLA policy, determines the order they will be matched. If not specified, SLA Policy is added as the last position.
FilterAll String An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
FilterAny String An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
PolicyMetrics String An object that describes the metric targets for each value of the priority field.



TicketAudits

Query TicketAudits in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM TicketAudits



SELECT * FROM TicketAudits WHERE TicketId = '123'



SELECT * FROM TicketAudits WHERE TicketId = '123' AND Id = '456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned when creating audits.
TicketId Integer

Tickets.Id

The ID of the associated ticket.
AuthorId Long

Users.Id

The user who created the audit.
CreatedAt Datetime The time the audit was created.
Metadata String Metadata for the audit, custom and system data.
ViaChannel String This object explains how this audit was created. This does not update on every request.
ViaSource String This object explains how this audit was created. This does not update on every request.
Events String The user who created the audit.



TicketComments

Query TicketComments belonging to a specified ticket in Zendesk.

Table Specific Information
Select

The Ticket Id is required to query this view. The following queries are processed server side.

SELECT * FROM TicketComments



SELECT * FROM TicketComments WHERE TicketId='123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned when the ticket is created.
TicketId Integer

Tickets.Id

The id of the ticket the comment belongs to.
AuthorId Long

Users.Id

The id of the comment author.
Type String Comment or VoiceComment.
Body String The comment string.
CreatedAt Datetime The time the comment was created.
HtmlBody String The comment formatted as HTML.
PlainBody String The comment as plain text.
IsPublic Boolean True if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it.
ViaChannel String This tells you how the ticket or event was created. Examples: 'web', 'mobile', 'rule', 'system'.
ViaSource String .
MetadataCustom String .
MetadataSystemClient String .
MetadataSystemIpAddres String .
MetadataSystemLatitude String .
MetadataSystemLongitude String .
MetadataSystemLocation String .



TicketMetricEvents

Query TicketMetricEvents in Zendesk.

Table Specific Information
Select

To query all ticket metric events, use the following query:


SELECT * FROM TicketMetricEvents

To query ticket metric events, starting from a given time, use the following example:


SELECT * FROM TicketMetricEvents WHERE StartTime = '2017-02-05'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned when the record is created.
TicketId Integer

Tickets.Id

Id of the associated ticket.
Metric String One of the following: agent_work_time, pausable_update_time, periodic_update_time, reply_time, requester_wait_time, or resolution_time.
InstanceId Long The instance of the metric associated with the event.
Type String When this locale last got updated.
Time Datetime The time the event occurred.
Sla String Available if type is apply_sla. The SLA policy and target being enforced on the ticket and metric in question, if any.
Status String Available if type is update_status. Minutes since the metric has been open. See status.
Deleted Boolean Available if type is breach. In general, you can ignore any breach event when deleted is true.



TicketMetrics

Query TicketMetrics in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM TicketMetrics



SELECT * FROM TicketMetrics WHERE Id = '123'



SELECT * FROM TicketMetrics WHERE TicketId = '123' 



SELECT * FROM TIcketMetrics WHERE TicketId in (SELECT Id from Tickets)

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name Type References Description
Id [KEY] Long Automatically assigned.
TicketId Integer

Tickets.Id

The ID of the associated ticket.
GroupStations Integer Number of groups this ticket passed through.
AssigneeStations Integer Number of assignees this ticket had.
Reopens Integer Total number of times the ticket was reopened.
Replies Integer Total number of times ticket was replied to.
AssigneeUpdatedAt Datetime When the assignee last updated the ticket.
RequesterUpdatedAt Datetime When the requester last updated the ticket.
StatusUpdatedAt Datetime When the status was last updated.
InitiallyAssignedAt Datetime When the ticket was initially assigned.
AssignedAt Datetime When the ticket was last assigned.
SolvedAt Datetime When the ticket was solved.
LatestCommentAddedAt Datetime When the latest comment was added.
FirstResolutionTimeCalendar Int Number of minutes to the first resolution time inside and out of business hours.
FirstResolutionTimeBusiness Int Number of minutes to the first resolution time inside and out of business hours.
ReplyTimeCalendar Int Number of minutes to the first reply inside and out of business hours.
ReplyTimeBusiness Int Number of minutes to the first reply inside and out of business hours.
FullResolutionTimeCalendar Int Number of minutes to the full resolution inside and out of business hours.
FullResolutionTimeBusiness Int Number of minutes to the full resolution inside and out of business hours.
AgentWaitTimeCalendar Int Number of minutes the agent spent waiting inside and out of business hours.
AgentWaitTimeBusiness Int Number of minutes the agent spent waiting inside and out of business hours.
RequesterWaitTimeCalendar Int Number of minutes the requester spent waiting inside and out of business hours.
RequesterWaitTimeBusiness Int Number of minutes the requester spent waiting inside and out of business hours.
CreatedAt Datetime When this record was created.
UpdatedAt Datetime When this record last got updated.
Url String The API url of this ticket metric.



Tickets_Collaborators

The Collaborator id of users currently CC'ed on the ticket.

Columns

Name Type References Description
Id Integer

Tickets.Id

Automatically assigned when the ticket is created.
CollaboratorId Long

Collaborators.Id

The ids of users currently cc-ed on the ticket.



Tickets_Followers

The ids of agents currently following the ticket

Columns

Name Type References Description
Id Integer

Tickets.Id

Automatically assigned when the ticket is created.
FollowerId Long

Users.Id

Agents currently following the ticket.



Tickets_Followups

The ids of the followups created from ticket.

Columns

Name Type References Description
Id Integer

Tickets.Id

Automatically assigned when the ticket is created.
FollowupId Long

Tickets.Id

Closed tickets only. The ids of the followups created from this ticket.



Tickets_Macros

List of macros to be recorded in the ticket audit.

Columns

Name Type References Description
Id Integer

Tickets.Id

Automatically assigned when the ticket is created.
MacroId Long

Macros.Id

POST requests only. List of macro IDs to be recorded in the ticket audit.



Tickets_SatisfactionRatings

The satisfaction rating of the ticket, if it exists, or the state of satisfaction.

Columns

Name Type References Description
Id Integer

Tickets.Id

Automatically assigned when the ticket is created.
SatisfactionRatingComment String Comment of satisfaction rating for the ticket.
SatisfactionRatingId Long

SatisfactionRatings.Id

Id of satisfaction rating for the ticket..
SatisfactionRatingScore String Score of satisfaction rating for the ticket..



Tickets_SharingAgreements

The sharing agreements used for ticket.

Columns

Name Type References Description
Id Integer

Tickets.Id

Automatically assigned when the ticket is created.
SharingAgreementId Long

SharingAgreements.Id

The ids of the sharing agreements used for this ticket.



Tickets_Tags

The tags applied to the ticket

Columns

Name Type References Description
Id Integer

Tickets.Id

Automatically assigned when the ticket is created.
Tag String The array of tags applied to this ticket.



Tickets_Viasources

List ViaSources for the Ticket.

Columns

Name Type References Description
Id Integer

Tickets.Id

Automatically assigned when the ticket is created.
ViaSourceFrom String The ticket's source via from.
ViaSourceRel String The ticket's source via relation.
ViaSourceTo String The ticket's source via to.



UserRelatedInformation

Query UserRelatedInformation in Zendesk.

Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.
SELECT * FROM UserRelatedInformation



SELECT * FROM UserRelatedInformation WHERE UserId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type References Description
UserId Long

Users.id

The id of the user.
AssignedTickets Integer Count of assigned tickets.
RequestedTickets Integer Count of requested tickets.
CcdTickets Integer Count of collaborated tickets.
OrganizationSubscriptions Integer Count of organization subscriptions.
Topics Integer Count of topics (Web portal only).
TopicComments Integer Count of comments on topics (Web portal only).
Votes Integer Count of votes (Web portal only).
Subscriptions Integer Count of subscriptions (Web portal only).
EntrySubscriptions Integer Count of entry subscriptions (Web portal only).
ForumSubscriptions Integer Count of forum subscriptions (Web portal only).