Connection String OptionsBack To Top

AuthScheme
APIIntegrationType
UseLegacyAuthentication
User
Password
Subdomain
InitiateOAuth
OAuthClientId
OAuthClientSecret
OAuthAccessToken
OAuthSettingsLocation
CallbackURL
Scope
OAuthGrantType
OAuthVerifier
OAuthRefreshToken
OAuthExpiresIn
OAuthTokenTimestamp
SSLServerCert
FirewallType
FirewallServer
FirewallPort
FirewallUser
FirewallPassword
ProxyAutoDetect
ProxyServer
ProxyPort
ProxyAuthScheme
ProxyUser
ProxyPassword
ProxySSLType
ProxyExceptions
Logfile
Verbosity
LogModules
MaxLogFileSize
MaxLogFileCount
Location
BrowsableSchemas
Tables
Views
Schema
AutoCache
CacheDriver
CacheConnection
CacheLocation
CacheTolerance
Offline
CacheMetadata
AccountId
BatchSize
ConnectionLifeTime
ConnectOnOpen
DisplayChildDataExtensions
Instance
ListDataExtensions
MaxRows
Other
Pagesize
PoolIdleTimeout
PoolMaxSize
PoolMinSize
PoolWaitTime
PseudoColumns
QueryAllAccounts
Readonly
RTK
SupportEnhancedSQL
Timeout
TimeZone
UseConnectionPooling

AuthScheme

Data Type

string

Default Value

"Auto"

Remarks

Auto: Lets the driver decide automatically based on the other connection properties you have set.
OAuth: Set to this to perform OAuth authentication.
Basic: Set this to use BASIC user / password authentication.

When an app is created on SF Marketing Cloud, you are given an option of Web-API and Server-to-Server. This acts to determine the grant type for the OAuth flow. Use the following options to select your authentication grant type:

Server-to-Server: This is used when applications request an access token to access their own resources, not on behalf of a user. This indicates OAuthGrantType = Client.
Web-App: This is used by confidential and public clients to exchange an authorization code for an access token. This indicates OAuthGrantType = Code.

Optionally set OAuthGrantType directly instead of setting this property. Using OAuthGrantType may be desireable in cases where multiple products are being used to keep everything consistent since APIIntegrationType is specific to Salesforce Marketing Cloud.

UseLegacyAuthentication

Data Type

bool

Default Value

false

Remarks

To connect to Salesforce Marketing Cloud where you have installed a package with legacy functionality you must set this property to TRUE.

User

Data Type

string

Default Value

Remarks

Together with Password, this field is used to authenticate against the Salesforce Marketing Cloud server.

Password

Data Type

string

Default Value

Remarks

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

Subdomain

Data Type

string

Default Value

Remarks

The subdomain can be obtained as follows:

Log in to Marketing Cloud.
Navigate to the Setup page, then select: Apps -> Installed Packages
Select the package with the API integration component you want to use.
Subdomain will be specified in the Authentication Base URI. Example: https://SUBDOMAIN.auth.marketingcloudapis.com/

Note: This property must be specified if UseLegacyAuthentication is set to FALSE or if Instance is greater than s10.

InitiateOAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
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.
REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

Data Type

string

Default Value

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

Data Type

string

Default Value

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

Data Type

string

Default Value

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

Data Type

string

Default Value

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

CallbackURL

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.

Scope

Data Type

string

Default Value

Remarks

Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages.

OAuthGrantType

Data Type

string

Default Value

Remarks

When an app on is created on Salesforce Marketing Cloud, you are given an option of Web-API or Server-to-Server. Use the following options to select your authentication grant type:

Server-to-Server: This is used when applications request an access token to access their own resources, not on behalf of a user. This indicates OAuthGrantType = Client.
Web-App: This is used by confidential and public clients to exchange an authorization code for an access token. This indicates OAuthGrantType = Code.

APIIntegrationType may alternatively be specified to indicate the GrantType.

OAuthVerifier

Data Type

string

Default Value

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See Establishing a Connection to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

Data Type

string

Default Value

Remarks

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

OAuthExpiresIn

Data Type

string

Default Value

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

Data Type

string

Default Value

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSLServerCert

Data Type

string

Default Value

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

FirewallType

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the driver opens a connection to Salesforce Marketing Cloud and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Data Type

string

Default Value

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

Data Type

int

Default Value

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

Data Type

string

Default Value

Remarks

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

FirewallPassword

Data Type

string

Default Value

Remarks

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

ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

NOTE: When this property is set to True, the proxy used is determined as follows:

A search from the JVM properties (http.proxy, https.proxy, socksProxy, etc.) is performed.
In the case that the JVM properties don't exist, a search from java.home/lib/net.properties is performed.
In the case that java.net.useSystemProxies is set to True, a search from the SystemProxy is performed.
In Windows only, an attempt is made to retrieve these properties from the Internet Options in the registry.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Data Type

string

Default Value

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

Data Type

int

Default Value

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The driver performs HTTP BASIC authentication.
DIGEST: The driver performs HTTP DIGEST authentication.
NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

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

ProxyUser

Data Type

string

Default Value

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain

domain\user

ProxyPassword

Data Type

string

Default Value

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


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

ProxyExceptions

Data Type

string

Default Value

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logfile

Data Type

string

Default Value

Remarks

Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to:

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

LogModules

Data Type

string

Default Value

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.

Adjust the maximum number of logfiles generated with MaxLogFileCount.

MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.

Location

Data Type

string

Default Value

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

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

Note: Given that this driver supports multiple schemas, the structure for Salesforce Marketing Cloud custom schema files is as follows:

Each schema is given a folder corresponding to that schema name.
These schema folders are contained in a parent folder.
The parent folder should be set as the Location, not an individual schema's folder.

If left unspecified, the default location is "%APPDATA%\\CData\\SFMarketingCloud Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

BrowsableSchemas

Data Type

string

Default Value

Remarks

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

Tables

Data Type

string

Default Value

Remarks

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

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Data Type

string

Default Value

Remarks

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

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Schema

Data Type

string

Default Value

"SOAP"

Remarks

Set this property to REST to use the Salesforce Marketing Cloud 1.x REST API or SOAP to use the Salesforce Marketing Cloud SOAP API.

AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data.

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:

CacheLocation: Specifies the path to the file store.
CacheDriver and CacheConnection: Specifies a driver to a database and the connection string.

CacheDriver

Data Type

string

Default Value

Remarks

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

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

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

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

Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:

jdbc:sfmarketingcloud:CacheLocation='c:/Temp/cachedir';User=myUser;Password=myPassword;

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:sfmarketingcloud:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';User=myUser;Password=myPassword;

SQLite

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

jdbc:sfmarketingcloud:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';User=myUser;Password=myPassword;

MySQL

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

  jdbc:sfmarketingcloud:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=myUser;Password=myPassword;

SQL Server

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

jdbc:sfmarketingcloud:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';User=myUser;Password=myPassword;

Oracle

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

jdbc:sfmarketingcloud:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';User=myUser;Password=myPassword;

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:sfmarketingcloud:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';User=myUser;Password=myPassword;

CacheConnection

Data Type

string

Default Value

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]

For example, to cache to an in-memory database, use the following:

jdbc:derby:memory

SQLite

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

jdbc:sqlite:dataSource

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

MySQL

The installation includes the CData JDBC Driver for MySQL. 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:

Server: The IP address or domain name of the server you want to connect to.
Port: The port that the server is running on.
User: The user name provided for authentication to the database.
Password: The password provided for authentication to the database.
Database: The name of the database.

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]

For example:

jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true

The following are typical SQL Server connection properties:

Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
Port: The port SQL Server is running on.
Database: The name of the SQL Server database.
Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
User Id: The user name provided for authentication with SQL Server. This property is only needed if you are not using integrated security.
Password: The password provided for authentication with SQL Server. This property is only needed if you are not using integrated security.

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:

Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
Password: The password provided for authentication with the Oracle database.
User Id: The user Id provided for authentication with the Oracle database.

PostgreSQL

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:

Host: The address of the server hosting the PostgreSQL database.
Port: The port used to connect to the server hosting the PostgreSQL database.
Database: The name of the database.
User name: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
Password: The password provided for authentication with the PostgreSQL database.

CacheLocation

Data Type

string

Default Value

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

CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.

Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Salesforce Marketing Cloud catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

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

AccountId

Data Type

string

Default Value

Remarks

Use this property to switch between business units. If you don't specify account_id, the returned access token is in the context of the business unit that created the integration. The specified AccountId will be used only during the OAuth flow. It is not supported for legacy packages.

BatchSize

Data Type

int

Default Value

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.

ConnectionLifeTime

Data Type

int

Default Value

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.

ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

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

DisplayChildDataExtensions

Data Type

bool

Default Value

false

Remarks

Use this property to list child accounts data extension objects. By default, only parent and shared data extensions are displayed.

Instance

Data Type

string

Default Value

"s7"

Remarks

The Salesforce Marketing Cloud instance used by default is s7. To determine your instance, follow the steps below:

Log in to Marketing Cloud.
Click the name of your account.
Copy the MID value for your account.
In a separate browser tab or window, navigate to https://trust.marketingcloud.com.
Enter the copied MID value in the text field and click Go.

Note: If the instance is greater than s10, then Subdomain must be specified.

ListDataExtensions

Data Type

bool

Default Value

true

Remarks

A boolean determining if data extensions should be listed as tables or not.

MaxRows

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

Data Type

string

Default Value

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Caching Configuration


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

Integration and Formatting


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

Pagesize

Data Type

int

Default Value

500

Remarks

The Pagesize property affects the maximum number of results to return per page from Salesforce Marketing Cloud. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PoolIdleTimeout

Data Type

int

Default Value

Remarks

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

PoolMaxSize

Data Type

int

Default Value

100

Remarks

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

PoolMinSize

Data Type

int

Default Value

Remarks

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

PoolWaitTime

Data Type

int

Default Value

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

PseudoColumns

Data Type

string

Default Value

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

QueryAllAccounts

Data Type

bool

Default Value

false

Remarks

Use this property to query all accounts, including parent and all children, regarding an event. Available only for SOAP schema.

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.

SupportEnhancedSQL

Data Type

bool

Default Value

true

Remarks

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

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.

TimeZone

Data Type

string

Default Value

"-06:00"

Remarks

If you have contacted your Marketing Cloud representative to disable the "Incoming Date Normalization" feature, you must specify the Account timezone instead of server timezone.

UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

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

TablesBack To Top

Account
AccountUser
BusinessUnit
ContentArea
DataExtension
Email
EmailSendDefinition
FileTrigger
FilterDefinition
ImportDefinition
List
Portfolio
ProgramManifestTemplate
QueryDefinition
ReplyMailManagementConfiguration
Send
SendClassification
SenderProfile
SMSTriggeredSend
Subscriber
SuppressionListDefinition
TriggeredSendDefinition

Account

A Marketing Cloud account.

Table-Specific Information

Select

The driver uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The driver processes other filters 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 search criteria that refer to other columns will cause an error.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Account



SELECT * FROM Account WHERE Id = 123



SELECT * FROM Account WHERE Id IN (123, 456)



SELECT * FROM Account WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier of the account.
AccountType	String	False	Type of Marketing Cloud account. The allowed values are BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, PRO_CONNECT_CLIENT.
ParentID	Int	False	Specifies the ID number of the parent account for Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 account children and business units.
BrandID	Int	False	Specifies brand tags to use on an account.
PrivateLabelID	Int	False	Specifies the private label for an account.
ReportingParentID	Int	False	Reserved for future use.
Name	String	False	Name of the account.
Email	String	False	Default email address the account. Indicates if subscriber information can be used for email sends.
FromName	String	False	Specifies the default email message From Name. Deprecated for email send definitions and triggered send definitions.
BusinessName	String	False	Business name of an account's owner.
Phone	String	False	Specifies a phone number.
Address	String	False	The address used to communicate with a Person.
Fax	String	False	Fax number of the account's owner.
City	String	False	City of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages.
State	String	False	Specifies the geographical state of the account's owner.
Zip	String	False	Specifies the zip code of the account's owner.
Country	String	False	Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages.
IsActive	Boolean	False	Specifies whether or not the account is active.
IsTestAccount	Bool	False	Specifies whether or not an account is a 'Test' account.
Client_ClientID1	Int	True	The Client Id of the client.
DBID	Int	False	Reserved for future use.
CustomerID	Long	False	Reserved for future use.
DeletedDate	Datetime	True	Date and time of an account's deletion.
EditionID	Int	False	Specifies the product edition of the account.
ModifiedDate	Datetime	False	Indicates the last time account information was modified.
CreatedDate	Datetime	False	Date and time of the account's creation.
ParentName	String	False	Specifies the name of the Parent account.
Subscription_SubscriptionID	String	True	Reserved for future use.
Subscription_HasPurchasedEmails	Bool	True	Reserved for future use.
Subscription_EmailsPurchased	Int	True	Specifies the number of emails purchased in a subscription.
Subscription_Period	String	True	Reserved for future use.
Subscription_AccountsPurchased	Int	True	Marketing Cloud Accounts purchased.
Subscription_LPAccountsPurchased	Int	True	Specifies the number of Lock and Publish account purchased.
Subscription_DOTOAccountsPurchased	Int	True	Specifies number of Marketing Cloud agency reseller accounts purchased.
Subscription_BUAccountsPurchased	Int	True	Defines the number of business units purchased for a subscription.
Subscription_AdvAccountsPurchased	Int	True	This property represents the number of advertising accounts purchased for the account.
Subscription_BeginDate	Datetime	True	Specifies the date a subscription begins.
Subscription_EndDate	Datetime	True	Specifies the end data of an activity.
Subscription_Notes	String	True	Deprecated.
PartnerKey	String	False	Unique identifier provided by partner for an account, accessible only via API.
Client_PartnerClientKey	String	True	The partner client key of the client.
InheritAddress	Bool	False	Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit.
UnsubscribeBehavior	Int	True	The behavior of the subscription when unsubscripbed.
Subscription_ContractNumber	String	True	Reserved for future use.
Subscription_ContractModifier	String	True	Reserved for future use.
IsTrialAccount	Bool	False	Reserved for future use.
Client_EnterpriseID	Long	True	Read-only identifier the enterprise of the client.
ParentAccount_ID	Int	False	Read-only identifier for the parent of the account.
ParentAccount_Name	String	True	Name of the parent of the account.
ParentAccount_ParentID	Int	True	Read-only identifier for the parent of the parent of this account.
ParentAccount_CustomerKey	String	True	The customer key of the parent account.
ParentAccount_AccountType	String	True	The account type of the parent account.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Locale_LocaleCode	String	True	The locale code of the locale.
TimeZone_ID	Int	True	Read-only identifier of the timezone.
TimeZone_Name	String	True	Name of the timezone.
Roles	String	False	Collection of roles defined for an account.
ContextualRoles	Int	True	The contextual roles of the account.
ObjectState	String	False	Reserved for future use.
LanguageLocale_LocaleCode	String	True	The locale code of the language layout.
IndustryCode	String	False	The code of the industry.
AccountState	Int	False	The state of the account.
SubscriptionRestrictionFlags	Long	False	Restriction flags of the subscription.

AccountUser

An individual user within an account. This table does not support deletes.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM AccountUser



SELECT * FROM AccountUser WHERE Id = 123



SELECT * FROM AccountUser WHERE Id IN (123, 456)



SELECT * FROM AccountUser WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
CreatedDate	Datetime	False	Date and time of the object's creation..
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID [KEY]	Int	False	The Id of the client.
AccountUserID	Int	False	Specifies the Marketing Cloud identifier of an account user.
UserID	String	False	The Id of the user.
Name	String	False	Name of the object or property.
Email	String	False	Default email address for object. Indicates if subscriber information can be used for email sends.
MustChangePassword	Bool	False	Indicates whether user must change password on next login.
ActiveFlag	Bool	False	Specifies the status of an account user.
ChallengePhrase	String	False	Specifies the challenge answer for login assistance.
ChallengeAnswer	String	False	Specifies the challenge answer for login assistance.
IsAPIUser	Bool	False	Indicates if a user can use the API. A value of true indicates the user's password remains the same until actively changed.
NotificationEmailAddress	String	False	Indicates email address to which to send notifications.
Client_PartnerClientKey	String	False	The partner client key of the partner.
Password	String	False	Specified the password of an account user.
Locale_LocaleCode	String	True	The locale code of the locale.
TimeZone_ID	Int	True	The id of the timezone.
TimeZone_Name	String	True	The name of the timezone.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
DefaultBusinessUnit	Int	False	Indicates business unit account user initially accesses.
LanguageLocale_LocaleCode	String	True	The locale code of the language locale.
Client_ModifiedBy	Int	False	Returns user ID for user who modified the object.

BusinessUnit

A unit within a larger Enterprise or Enterprise 2.0 account. This table supports queries and updates only.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM BusinessUnit



SELECT * FROM BusinessUnit WHERE Id = 123



SELECT * FROM BusinessUnit WHERE Id IN (123, 456)



SELECT * FROM BusinessUnit WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
AccountType	String	False	Type of Marketing Cloud account. Valid values are BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, PRO_CONNECT_CLIENT.
ParentID	Int	False	Specifies the ID number of the parent account.
BrandID	Int	False	Specifies brand tags to use on an account.
PrivateLabelID	Int	False	Specifies the private label for an account.
ReportingParentID	Int	False	Reserved for future use..
Name	String	False	Name of the object or property.
Email	String	False	Default email address for object.
FromName	String	False	Specifies the default email message From Name.
BusinessName	String	False	Business name of an account's owner.
Phone	String	False	Specifies a phone number.
Address	String	False	The address used to communicate with a Person.
Fax	String	False	Fax number of the account's owner.
City	String	False	City of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages.
State	String	False	Specifies the geographical state of the account's owner.
Zip	String	False	Specifies the zip code of the account's owner.
Country	String	False	Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages.
IsActive	Bool	False	Specifies whether or not the object is active.
IsTestAccount	Bool	False	Specifies whether or not an account is a 'Test' account.
Client_ID	Int	False	The Id of the client.
DBID	Int	False	Reserved for future use.
CustomerID	Long	False	The Id of the customer.
DeletedDate	Datetime	False	Date and time of an account's deletion (the value of this property must be set before the account can be deleted).
EditionID	Int	False	Specifies the product edition of the account.
IsTrialAccount	Bool	False	Reserved for future use.
Locale_LocaleCode	String	True	The locale code of the locale.
Client_EnterpriseID	Long	True	The enterprise Id of the client.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
CreatedDate	Datetime	False	Date and time of the object's creation.
Subscription_SubscriptionID	String	True	The subscription id of the subscription.
Subscription_HasPurchasedEmails	Bool	True	Reserved for future use..
Subscription_EmailsPurchased	Int	True	Specifies the number of emails purchased in a subscription..
Subscription_Period	String	True	Reserved for future use..
Subscription_AccountsPurchased	Int	True	Marketing Cloud Accounts purchased.
Subscription_LPAccountsPurchased	Int	True	Specifies the number of Lock and Publish account purchased.
Subscription_DOTOAccountsPurchased	Int	True	Specifies number of Marketing Cloud agency reseller accounts purchased.
Subscription_BUAccountsPurchased	Int	True	Defines the number of business units purchased for a subscription.
Subscription_AdvAccountsPurchased	Int	True	This property represents the number of advertising accounts purchased for the account.
Subscription_BeginDate	Datetime	True	Specifies the date a subscription begins..
Subscription_EndDate	Datetime	True	Specifies the end data of an activity..
Subscription_Notes	String	True	Deprecated..
Subscription_ContractNumber	String	True	Reserved for future use..
Subscription_ContractModifier	String	True	Reserved for future use..
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
Client_PartnerClientKey	String	True	Unique identifier provided by partner for an object, accessible only via API.
ParentName	String	False	Specifies the name of the Parent account.
ParentAccount_ID	Int	True	The Id of the parent account.
ParentAccount_Name	String	True	The name of the parent account.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Description	String	False	Describes and provides information regarding the object.
DefaultSendClassification_ObjectID	String	True	System-controlled, read-only text string identifier for object.
DefaultHomePage_ID	String	True	The Id of the default home page..
InheritAddress	Bool	False	Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit.
ContextualRoles	Int	True	The contextual roles of the business unit.
LanguageLocale_LocaleCode	String	True	The locale code of the language locale.

ContentArea

A ContentArea represents a defined section of reusable content.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ContentArea



SELECT * FROM ContentArea WHERE Id = 123



SELECT * FROM ContentArea WHERE Id IN (123, 456)



SELECT * FROM ContentArea WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
RowObjectID	String	False	Identifier for the row of an object.
ObjectID	String	False	System-controlled, text string identifier for object.
ID [KEY]	Int	False	Identifier for an object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_ID	Int	False	The Id of the client.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
CreatedDate	Datetime	False	Date and time of the object's creation.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.
Name	String	False	Name of the object or property.
Layout	String	False	Indicates layout type of content area.
IsDynamicContent	Bool	False	Indicates if specific content area contains dynamic content.
Content	String	False	Identifies content contained in a content area.
IsSurvey	Bool	False	Indicates whether a specific content area contains survey questions.
IsBlank	Bool	False	Indicates if specified content area contains no content.
Key	String	False	Specifies key associated with content area in HTML body.

DataExtension

Represents a data extension within an account.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtension



SELECT * FROM DataExtension WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Name	String	False	Name of the object or property.
CreatedDate	Datetime	False	Date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Int	False	The Id of the client.
Description	String	False	Describes and provides information regarding the object.
IsSendable	Bool	False	Indicates whether you can use a data extension as part of an audience for a message send.
IsTestable	Bool	False	Indicates whether a sendable data extension can be used within tests sends for a message.
SendableDataExtensionField_Name	String	False	The name of the sendable data extension field.
SendableSubscriberField_Name	String	False	The name of the sendablesubscriber field.
Template_CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
CategoryID	Long	False	Specifies the identifier of the folder.
Status	String	False	Defines status of the object.
IsPlatformObject	Bool	False	Indicated whether the object is a platform object.
DataRetentionPeriodLength	Int	False	Specifies the number of time units for which data will be retained.
DataRetentionPeriodUnitOfMeasure	Int	False	Specifies the units of time for which data will be retained.
RowBasedRetention	Bool	False	Indicates whether the data retention policy removes data by row or by entire data extension.
ResetRetentionPeriodOnImport	Bool	False	Indicates whether a data retention period should be reset after a successful import of new data.
DeleteAtEndOfRetentionPeriod	Bool	False	Indicates whether data should be deleted at the end of the retention period.
RetainUntil	String	False	Indicates the date that ends the retention period for a data extension.

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
Fields	String	A semi-colon separated list of names for the fields to add to this data entension.

Email

Represents an email in a Marketing Cloud account.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM Email



SELECT * FROM Email WHERE Id = 123



SELECT * FROM Email WHERE Id IN (123, 456)



SELECT * FROM Email WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Int	False	The Id of the client.
Name	String	False	Name of the object or property.
PreHeader	String	False	Contains text used in preheader of email message on mobile devices.
Folder	String	False	Specifies folder information (Retrieve only) - Deprecated.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.
HTMLBody	String	False	Contains HTML body of an email message.
TextBody	String	False	Contains raw text body of a message.
Subject	String	False	Defines the subject of an object.
IsActive	Bool	False	Specifies whether or not the object is active.
IsHTMLPaste	Bool	False	Indicates whether email message was created via pasted HTML.
ClonedFromID	Int	False	ID of email message from which the specified email message was created.
Status	String	False	Defines the status of an object.
EmailType	String	False	Defines the preferred email type.
CharacterSet	String	False	Indicates encoding used in an email message.
HasDynamicSubjectLine	Bool	False	Indicates whether email message contains a dynamic subject line.
ContentCheckStatus	String	False	Indicates whether content validation has completed for this email message.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
ContentAreas	String	False	Contains information on content areas included in an email message.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.

EmailSendDefinition

Record that contains the message information, sender profile, delivery profile, and audience information.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM EmailSendDefinition



SELECT * FROM EmailSendDefinition WHERE ObjectID = 123



SELECT * FROM EmailSendDefinition WHERE ObjectID IN (123, 456)



SELECT * FROM EmailSendDefinition WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
Client_ID	Int	True	The Id of the client.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
ObjectID	String	False	System-controlled, text string identifier for object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Name	String	False	Name of the object or property.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.
Description	String	False	Describes and provides information regarding the object.
SendClassification_CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
SenderProfile_CustomerKey	String	True	User-supplied unique identifier for an object within an object type
SenderProfile_FromName	String	True	Specifies the default email message From Name.
SenderProfile_FromAddress	String	True	Indicates From address associated with a object.
DeliveryProfile_SourceAddressType	String	True	Indicates the source IP address type used with the delivery profile.
DeliveryProfile_PrivateIP	String	True	Contains information on the private IP address associated with a delivery profile.
DeliveryProfile_DomainType	String	True	Defines the type of domain.
DeliveryProfile_PrivateDomain	String	True	Defines private domain to use as part of a delivery profile or send definition.
DeliveryProfile_HeaderSalutationSource	String	True	Defines source of header salutation for a delivery profile or send definition.
DeliveryProfile_FooterSalutationSource	String	True	Defines source of a footer salutation to use as part of a delivery profile or send definition (Default, ContentLibrary, or None).
SuppressTracking	Bool	False	Indicates whether the send definition suppresses tracking results for associated sends.
IsSendLogging	Bool	False	Indicates whether send logging is enabled for the specified send definition
Email_ID	Int	True	The Id of the email.
CCEmail	String	False	Carbon copy email address.
BccEmail	String	False	Indicates email addresses to receive blind carbon copy of a message.
AutoBccEmail	String	False	Defines blind carbon copy email address to which to send a message as part of an email send definition.
TestEmailAddr	String	False	Defines an email address to which to send a test message as part of an email send definition.
EmailSubject	String	False	Subject of the email.
DynamicEmailSubject	String	False	Contains content to be used in a dynamic subject line.
IsMultipart	Bool	False	Indicates whether the email is sent with Multipart/MIME enabled.
IsWrapped	Bool	False	Indicates whether an email send contains the links necessary to process tracking information for clicks.
SendLimit	Int	False	Indicates limit of messages to send as part of a send definition within a predefined send window.
DeduplicateByEmail	Bool	False	Indicates whether a send definition should de-duplicate multiple emails sent to the same email address.
ExclusionFilter	String	False	Contains a string of AMPscript that can evaluate to true or false, used to exclude email addresses from a send definition.
Additional	String	False	The ID for a send that customers use as a campaign ID.
IsPlatformObject	Bool	False	Indicated whether the object is a platform object.

FileTrigger

Reserved for future use. This table does not suport deletes.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM FileTrigger



SELECT * FROM FileTrigger WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_ID	Long	False	The Id of the client.
ExternalReference	String	False	Reserved for future use.
Name	String	False	Name of the object or property.
Description	String	False	Describes and provides information regarding the object.
Type	String	False	Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master.
Status	String	False	Defines status of the object.
StatusMessage	String	False	Describes the status of an API call.
RequestParameterDetail	String	False	Reserved for future use.
ResponseControlManifest	String	False	Reserved for future use.
FileName	String	False	Indicates name of file associated with the object.
LastPullDate	Datetime	False	Reserved for future use.
ScheduledDate	Datetime	False	Reserved for future use.
IsActive	Bool	False	Specifies whether or not the object is active.
CreatedDate	Datetime	False	Indicated the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_CreatedBy	Int	False	Returns user ID for user who created object
Client_ModifiedBy	Int	False	Returns user ID for user who modified object.

FilterDefinition

Defines an audience based on specified rules in a filter. This table does not support inserts.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM FilterDefinition



SELECT * FROM FilterDefinition WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
Client_ID	Int	True	The Id of the client.
Client_ClientPartnerKey	Int	True	User-defined partner key for an account.
Name	String	False	Name of the object or property.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
CreatedDate	Datetime	False	Indicated the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Description	String	False	Describes and provides information regarding the object.
DataSource_ID	Int	True	Read-only identifier for an object.
DataSource_ObjectID	String	True	System-controlled, read-only text string identifier for object.
DataSource_Name	Int	True	Name of the object or property.
DataSource_ListName	Int	True	The list name of the data source.
DataSource_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
DataSource_CreatedDate	Datetime	True	Read-only date and time of the object's creation.
DataSource_ModifiedDate	Datetime	True	Indicates the last time object information was modified.
DataFilter	String	False	Filter parts for a filter definition.

ImportDefinition

Defines a reusable pattern of import options. This table does not support inserts.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ImportDefinition



SELECT * FROM ImportDefinition WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM ImportDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM ImportDefinition WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
Client_ClientID1	Int	False	The client Id of the client.
Name	String	False	Name of the object or property.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Description	String	False	Describes and provides information regarding the object.
FileSpec	String	False	Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%).
AllowErrors	Bool	False	Specifies whether an import should continue after an error occurs.
FieldMappingType	String	False	Defines how fields are mapped within an import definition.
FileType	String	False	Specifies column delimiter of a file (CSV, TAB, or Other).
UpdateType	String	False	Indicates update type associated with an import definition.
MaxFileAge	Int	False	Specifies the age of the oldest file to be included in an import definition.
MaxFileAgeScheduleOffset	Int	False	Specifies an offset in hours to associate with a file age for accomodating timezone differences.
MaxImportFrequency	Int	False	Specifies the number of hours to wait before allowing a file to be imported again.
DestinationObject_ID	Int	False	Identifier for an object.
DestinationObject_ObjectID	String	False	System-controlled, text string identifier for object.
Notification_ResponseType	String	True	The response type of the notification.
Notification_ResponseAddress	String	False	The response address of the notification.
RetrieveFileTransferLocation_ObjectID	String	False	System-controlled, text string identifier for object.
Delimiter	String	False	Specifies the delimiter used as part of an import definition.
HeaderLines	Int	False	Specifies the number of lines in the file that are header lines that should not be processed.
EndOfLineRepresentation	String	False	Specifies the line-ending character(s) used in delimited files to be imported.
NullRepresentation	String	False	Defines character used to represent a null value during an import.
StandardQuotedStrings	Bool	False	Specifies whether standard quoted strings are used as part of an import definition.
DateFormattingLocale_LocaleCode	String	False	The locale code of the date formatting locale.

List

A marketing list of subscribers.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM List



SELECT * FROM List WHERE Id = 123



SELECT * FROM List WHERE Id IN (123, 456)



SELECT * FROM List WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
ObjectID	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Int	False	The Id of the client.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
ListName	String	False	Name of a specific list.
Description	String	False	Describes and provides information regarding the object.
Category	Int	False	ID of the folder that an item is located in.
Type	String	False	Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
ListClassification	String	True	Specifies the classification for a list.
AutomatedEmail_ID	Int	False	Identifier for an object.

Portfolio

Indicates a file within the Portfolio of a Marketing Cloud account.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM Portfolio



SELECT * FROM Portfolio WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM Portfolio WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM Portfolio WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
RowObjectID	String	False	Identifier for the row of an object.
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_ID	Int	False	The Id of the client.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.
FileName	String	False	Indicates name of file associated with the object.
DisplayName	String	False	Name to be displayed for an item within a Portfolio.
Description	String	False	Describes and provides information regarding the object.
TypeDescription	String	False	Describes type for a Portfolio object.
IsUploaded	Bool	False	Indicates whether the Portfolio object in question was uploaded.
IsActive	Bool	False	Specifies whether or not the object is active.
FileSizeKB	Int	False	Specifies file size of a Portfolio item.
ThumbSizeKB	Int	False	Indicates size of a thumbnail image associated with a Portfolio object.
FileWidthPX	Int	False	Specifies the width of a Portfolio image in pixels.
FileHeightPX	Int	False	Specifies height of image contained in Portfolio (value)
FileURL	String	False	Specifies the URL at which a Portfolio file is stored.
ThumbURL	String	False	Indicates URL of a thumbnail image associated with a Portfolio object.
CacheClearTime	Datetime	False	Reserved for future use.
CategoryType	String	False	Defines whether a folder within a Portfolio is shared to other account users or not. Valid values are shared_portfolio, media.
CreatedDate	Datetime	False	Indicated the date and time of the object's creation.
CreatedBy	Int	False	The Id of the user who created the Portfolio.
ModifiedBy	Int	False	The id of the user who modified the Portfolio.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
ModifiedByName	String	True	The name of the user who modified the Portfolio.

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
Source_URN	String	A URN (uniform resource name) of the location of the source.

ProgramManifestTemplate

Reserved for future use. This table does not support deletes or inserts.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ProgramManifestTemplate



SELECT * FROM ProgramManifestTemplate WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM ProgramManifestTemplate WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-123')



SELECT * FROM ProgramManifestTemplate WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, read-only text string identifier for object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_ID	Long	False	The Id of the client.
Name	String	False	Name of the object or property.
Description	String	False	Describes and provides information regarding the object.
Type	String	False	Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. Indicates the type of email to send to the address. Valid values include Text and HTML.
OperationType	String	False	Specifies metadata about the type of operation to perform.
Content	String	False	Identifies content contained in a content area.
IsActive	Bool	False	Specifies whether or not the object is active.
CreatedDate	Datetime	False	Read-only date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.

QueryDefinition

Represents a SQL query activity accessed and performed by the SOAP API. This table does not support updates or inserts.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM QueryDefinition



SELECT * FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM QueryDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 456)



SELECT * FROM QueryDefinition WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
Client_ID	Int	False	The Id of the client.
Name	String	False	Name of the object or property.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Description	String	False	Describes and provides information regarding the object.
QueryText	String	False	Specifies text associated with a query definition.
TargetType	String	False	Indicates target type for a query definition.
DataExtensionTarget_Name	String	False	Name of the object or property.
DataExtensionTarget_CustomerKey	String	False	User-supplied unique identifier for an object within an object type
DataExtensionTarget_Description	String	False	Describes and provides information regarding the object.
TargetUpdateType	String	False	Indicates the target update type for a query definition.
FileType	String	False	Specifies column delimiter of a file (CSV, TAB, or Other).
FileSpec	String	False	Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%).
Status	String	False	Defines status of object.
CreatedDate	Datetime	False	Indicated the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.

ReplyMailManagementConfiguration

Details configuration settings for the reply mail management in an account. This table does not support deletes.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ReplyMailManagementConfiguration



SELECT * FROM ReplyMailManagementConfiguration WHERE Id = 123



SELECT * FROM ReplyMailManagementConfiguration WHERE Id IN (123, 456)



SELECT * FROM ReplyMailManagementConfiguration WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
Client_ID	Int	True	The Id of the client.
EmailDisplayName	String	False	Specifies the From name associated with the From email address as part of reply mail management configuration.
ReplySubdomain	String	False	Specifies subdomain associated with a reply mail management subdomain.
EmailReplyAddress	String	False	Specifies forwarding address for inbound emails resulting from a send.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
DNSRedirectComplete	Bool	False	Specifies whether a reply domain's DNS has been redirected to the Marketing Cloud IP addresses.
DeleteAutoReplies	Bool	False	Specifies whether auto-replies to a send should be deleted instead of forwarded to the RMM-configured email address.
SupportUnsubscribes	Bool	False	Indicates whether a reply mail management configuration allows subscribers to unsubscribe.
SupportUnsubKeyword	Bool	False	Indicates whether a reply mail management configuration supports a unsubscribe keyword.
SupportUnsubscribeKeyword	Bool	False	Indicates whether a reply mail management configuration supports a unsubscribe keyword.
SupportRemoveKeyword	Bool	False	Indicates whether a reply mail management configuration supports a remove keyword.
SupportOptOutKeyword	Bool	False	Indicates whether a reply mail management configuration supports an opt-out keyword.
SupportLeaveKeyword	Bool	False	Indicates whether a reply mail management configuration supports a leave keyword.
SupportMisspelledKeywords	Bool	False	Indicates whether a reply mail management configuration supports misspelled keywords.
SendAutoReplies	Bool	False	Indicates whether automatic replies should be sent as part of a reply mail management configuration.
AutoReplySubject	String	False	Contains the subject of the email message sent as an automatic reply.
AutoReplyBody	String	False	Contains the content of the message sent as an automatic reply.
ForwardingAddress	String	False	Specifies forwarding address for inbound emails resulting from a send.
ConversationLifetimeDays	Int	False	The number of lifetime days for a conversation.
ConversationLifetimeCycles	Int	False	The number of lifetime cycles for a conversation.
AnonymousRuleSet_ObjectID	String	True	System-controlled, read-only text string identifier for object.
AnonymousRuleSet_Name	Int	True	Name of the object or property.
AnonymousRuleSet_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
AnonymousAckTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
AnonymousAckTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
AnonymousAckTriggeredSend_Name	String	True	Name of the object or property.
AnonymousAckTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
AnonymousForwardTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
AnonymousForwardTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
AnonymousForwardTriggeredSend_Name	String	True	Name of the object or property.
AnonymousForwardTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
ResponderConversationRuleSet_ObjectID	String	True	System-controlled, read-only text string identifier for object.
ResponderConversationRuleSet_Name	Int	True	Name of the object or property.
ResponderConversationRuleSet_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
ResponderConversationAckTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
ResponderConversationAckTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
ResponderConversationAckTriggeredSend_Name	String	True	Name of the object or property.
ResponderConversationAckTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
ResponderConversationForwardTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
ResponderConversationForwardTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
ResponderConversationForwardTriggeredSend_Name	String	True	Name of the object or property.
ResponderConversationForwardTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
InitiatorConversationRuleSet_ObjectID	String	True	System-controlled, read-only text string identifier for object.
InitiatorConversationRuleSet_Name	Int	True	Name of the object or property.
InitiatorConversationRuleSet_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
InitiatorConversationAckTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
InitiatorConversationAckTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
InitiatorConversationAckTriggeredSend_Name	String	True	Name of the object or property.
InitiatorConversationAckTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
InitiatorConversationForwardTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
InitiatorConversationForwardTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
InitiatorConversationForwardTriggeredSend_Name	String	True	Name of the object or property.
InitiatorConversationForwardTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
ConversationExpirationTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
ConversationExpirationTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
ConversationExpirationTriggeredSend_Name	String	True	Name of the object or property.
ConversationExpirationTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
MultiUseViolationTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
MultiUseViolationTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
MultiUseViolationTriggeredSend_Name	String	True	Name of the object or property.
MultiUseViolationTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
InboundAddressIsOneUse	Bool	False	Specified whether the inbound address is one use.

Send

Used to send email and retrieve aggregate data. This table does not support deletes or updates.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM Send



SELECT * FROM Send WHERE Id = 123



SELECT * FROM Send WHERE Id IN (123, 456)



SELECT * FROM Send WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Int	False	The Id of the client.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
Email_ID	Int	False	Identifier for an object.
Email_PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
SendDate	Datetime	False	Indicates the date on which a send occurred.
FromAddress	String	False	Indicates From address associated with a object.
FromName	String	False	Specifies the default email message From Name.
Duplicates	Int	False	Represent the number of duplicate email addresses associated with a send.
InvalidAddresses	Int	False	Specifies the number of invalid addresses associated with a send.
ExistingUndeliverables	Int	False	Indicates whether bounces occurred on previous send.
ExistingUnsubscribes	Int	False	Indicates whether unsubscriptions occurred on previous send.
HardBounces	Int	False	Indicates number of hard bounces associated with a send.
SoftBounces	Int	False	Indicates number of soft bounces associated with a specific send.
OtherBounces	Int	False	Specifies number of Other-type bounces in a send.
ForwardedEmails	Int	False	Number of emails forwarded for a send.
UniqueClicks	Int	False	Indicates number of unique clicks on message.
UniqueOpens	Int	False	Indicates number of unique opens resulting from a triggered send.
NumberSent	Int	False	Number of emails actually sent as part of an email send.
NumberDelivered	Int	False	Number of sent emails that did not bounce.
NumberTargeted	Int	False	Indicates the number of possible recipients for an email send.
NumberErrored	Int	False	Number of emails not sent as part of a send because an error occurred while trying to build the email.
NumberExcluded	Int	False	Indicates the number recipients excluded froman email send because of a held, unsubscribed, master unsubscribed, or global unsubscribed status.
Unsubscribes	Int	False	Indicates the number of unsubscribe events associated with a send.
MissingAddresses	Int	False	Specifies number of missing addresses encountered within a send.
Subject	String	False	Defines the status of an object.
PreviewURL	String	False	Indicates URL used to preview the message associated with a send.
SentDate	Datetime	False	Indicates date on which a send took place.
EmailName	String	False	Specifies the name of an email message associated with a send.
Status	String	False	The status of the object.
IsMultipart	Bool	False	Indicates whether the email is sent with Multipart/MIME enabled.
SendLimit	Int	False	Indicates limit of messages to send as part of a send definition within a predefined send window.
SendWindowOpen	Datetime	False	Defines the beginning of a send window for a send definition.
SendWindowClose	Datetime	False	Defines the end of a send window for a send definition.
IsAlwaysOn	Bool	False	Indicates whether the request can be performed while the system is is maintenance mode.
Additional	String	False	The ID for a send that customers use as a campaign ID.
BCCEmail	String	False	Indicates email addresses to receive blind carbon copy of a message.
EmailSendDefinition_ObjectID	String	False	System-controlled, text string identifier for object.
EmailSendDefinition_CustomerKey	String	False	The customer key of the email send definition.

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
List_Id	Int	The Id of the list to be sent.

SendClassification

Represents a send classification in a Marketing Cloud account.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SendClassification



SELECT * FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM SendClassification WHERE ObjectID IN ('nzxcaslkjd-123', 456)



SELECT * FROM SendClassification WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
SendClassificationType	String	False	Defines the type for the applicable send classification. Valid values include Operational and Marketing.
Name	String	False	Name of the object or property.
Description	String	False	Describes and provides information regarding the object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
SenderProfile_CustomerKey	String	False	The customer key of the sender profile.
SenderProfile_ObjectID	String	False	System-controlled, text string identifier for object.
DeliveryProfile_CustomerKey	String	False	The customer key of the delivery profile.
DeliveryProfile_ObjectID	String	False	System-controlled, text string identifier for object.
ArchiveEmail	Bool	False	Property definition.
Client_ID	Long	False	The Id of the client.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicats the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.

SenderProfile

The send profile used in conjunction with an email send definition.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SenderProfile



SELECT * FROM SenderProfile WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM SenderProfile WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM SenderProfile WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
Name	String	False	Name of the object or property.
Description	String	False	Describes and provides information regarding the object.
FromName	String	False	Specifies the default email message From Name.
FromAddress	String	False	Indicates From address associated with a object.
UseDefaultRMMRules	Bool	False	Indicates whether a sender profile uses the default RMM rules for that account.
AutoForwardToEmailAddress	String	True	Indicates the email address to use with automatically forwarded email messages.
AutoForwardToName	String	True	Indicates the To name to use on automatically forwarded email messages.
DirectForward	Bool	False	Indicates whether the direct forward feature has been enabled for a sender profile.
AutoForwardTriggeredSend_ObjectID	String	False	System-controlled, text string identifier for object.
AutoReply	Bool	False	Indicates the reply associated with an automatically forwarded email message.
AutoReplyTriggeredSend_ObjectID	String	False	System-controlled, text string identifier for object.
SenderHeaderEmailAddress	String	False	Specifies the email address to include in the sender header of a sender profile.
SenderHeaderName	String	False	Specifies name to include in the sender header of a sender profile.
DataRetentionPeriodLength	String	False	Specifies the number of time units for which data will be retained.
ReplyManagementRuleSet_ObjectID	String	False	System-controlled, text string identifier for object.
RMMRuleCollection_ObjectID	String	False	System-controlled, text string identifier for object.
Client_ID	Long	False	The Id of the client.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
ObjectID	String	False	System-controlled, text string identifier for object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_CreatedBy	Int	False	Returns user ID for user who created object
Client_ModifiedBy	Int	False	Returns user ID for user who modified object.

SMSTriggeredSend

Indicates a single instance of an SMS triggered send. This table does not support deletes or updates.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SMSTriggeredSend



SELECT * FROM SMSTriggeredSend WHERE ObjectID = 123



SELECT * FROM SMSTriggeredSend WHERE ObjectID IN (123, 456)



SELECT * FROM SMSTriggeredSend WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
Client_ID	Int	False	The Id of the client.
SmsSendId	String	False	Indicates ID for a specific SMS send.
SMSTriggeredSendDefinition_ObjectID	String	False	System-controlled, text string identifier for object.

Subscriber

A person subscribed to receive email or SMS communication.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM Subscriber



SELECT * FROM Subscriber WHERE Id = 123



SELECT * FROM Subscriber WHERE Id IN (123, 456)



SELECT * FROM Subscriber WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
Client_ID	Int	False	The Id of the client.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
EmailAddress	String	False	Contains the email address for a subscriber.
SubscriberKey	String	False	Identification of a specific subscriber.
UnsubscribedDate	Datetime	False	Represents date subscriber unsubscribed from a list.
Status	String	False	Defines status of object.
EmailTypePreference	String	False	The format in which email should be sent.

SuppressionListDefinition

A suppression list that can be associated with different contexts.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:


SELECT * FROM SuppressionListDefinition WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM SuppressionListDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM SuppressionListDefinition WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID	String	False	System-controlled, text string identifier for object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Name	String	False	Name of the object or property.
Description	String	False	Describes and provides information regarding the object.
Client_CreatedBy	Int	False	Returns user ID for user who created object
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
Client_ModifiedBy	Int	False	Returns user ID for user who modified object.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Category	Long	False	ID of the folder that an item is located in.
Client_ID	Int	False	The Id of the client.
Client_EnterpriseID	Long	False	The EnterpriseID of the client.
SubscriberCount	Long	False	Indicates the number of records on a suppression list.

TriggeredSendDefinition

To create or update a TriggeredSendDefinition where the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | View and SendEmailToList permissions.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM TriggeredSendDefinition



SELECT * FROM TriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM TriggeredSendDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM TriggeredSendDefinition WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Long	False	The Id of the client.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Email_ID	Int	False	Identifier for an object.
List_ID	Int	False	Identifier for an object.
Name	String	False	Name of the object or property.
Description	String	False	Describes and provides information regarding the object.
TriggeredSendType	String	False	Deprecated.
TriggeredSendStatus	String	False	Represents status of triggered send.
HeaderContentArea_ID	Int	False	Identifier for an object.
FooterContentArea_ID	Int	False	Identifier for an object.
SendClassification_ObjectID	String	False	System-controlled, text string identifier for object.
SendClassification_CustomerKey	String	False	The customer key of the send classification.
SenderProfile_CustomerKey	String	False	The customer key of the sender profile.
SenderProfile_ObjectID	String	False	System-controlled, text string identifier for object.
DeliveryProfile_CustomerKey	String	False	The customer key of the delivery profile.
DeliveryProfile_ObjectID	String	False	System-controlled, text string identifier for object.
PrivateDomain_ObjectID	String	False	System-controlled, text string identifier for object.
PrivateIP_ID	Int	True	Read-only identifier for an object.
AutoAddSubscribers	Bool	False	Indicates whether a triggered send recipient should be added to a subscriber list.
AutoUpdateSubscribers	Bool	False	Indicates if any subscriber information should be updated as part of a triggered send.
BatchInterval	Int	False	Deprecated.
FromName	String	False	Specifies the default email message From Name.
FromAddress	String	False	Indicates From address associated with a object.
BccEmail	String	False	Indicates email addresses to receive blind carbon copy of a message.
EmailSubject	String	False	Subject for an email send.
DynamicEmailSubject	String	False	Contains content to be used in a dynamic subject line.
IsMultipart	Bool	False	Indicates whether the email is sent with Multipart/MIME enabled.
IsWrapped	Bool	False	Indicates whether an email send contains the links necessary to process tracking information for clicks.
TestEmailAddr	String	False	Specified a test email address.
AllowedSlots	String	False	Reserved for future use.
NewSlotTrigger	Int	False	Deprecated.
SendLimit	Int	False	Indicates limit of messages to send as part of a send definition within a predefined send window.
SendWindowOpen	Datetime	False	Defines the beginning of a send window for a send definition.
SendWindowClose	Datetime	False	Defines the end of a send window for a send definition.
SuppressTracking	Bool	False	Indicates whether the send definition suppresses tracking results for associated sends.
Keyword	String	False	Reserved for future use.
List_PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
Email_PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
SendClassification_PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
PrivateDomain_PartnerKey	String	True	Unique identifier provided by partner for an object, accessible only via API.
PrivateIP_PartnerKey	String	True	Unique identifier provided by partner for an object, accessible only via API.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
IsPlatformObject	Bool	False	Indicated whether the object is a platform object.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.

ViewsBack To Top

Automation
BounceEvent
ClickEvent
DataExtensionField
DataExtensionTemplate
DataFolder
DoubleOptInMOKeyword
FileTriggerTypeLastPull
ForwardedEmailEvent
ForwardedEmailOptInEvent
HelpMOKeyword
ImportResultsSummary
LinkSend
ListSend
ListSubscriber
MessagingVendorKind
NotSentEvent
OpenEvent
PrivateIP
Publication
PublicationSubscriber
PublicKeyManagement
ResultItem
ResultMessage
Role
SendEmailMOKeyword
SendSMSMOKeyword
SendSummary
SentEvent
SMSMTEvent
SMSSharedKeyword
SMSTriggeredSendDefinition
SubscriberList
SubscriberSendResult
SuppressionListContext
SurveyEvent
Template
TimeZone
TriggeredSendSummary
UnsubEvent
UnsubscribeFromSMSPublicationMOKeyword

Automation

Defines an automation that exists within Automation Studio for an account.

View-Specific Information

Select

The driver uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but DateTime values: =, !=, <>, >, >=, <, <=, IN. For DateTime values, only > and < are supported. The driver processes other filters 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 search criteria that refer to other columns will cause an error.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Automation



SELECT * FROM Automation WHERE ObjectID = 123



SELECT * FROM Automation WHERE ObjectID IN (123, 456)



SELECT * FROM Automation WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
Name	String	Name of the object or property.
Description	String	Describes and provides information regarding the object.
Schedule_ID	Int	Read-only identifier for the schedule.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
Client_ID	Long	The Id of the client.
IsActive	Bool	Specifies whether or not the object is active.
CreatedDate	Datetime	Read-only date and time of the object's creation.
Client_CreatedBy	Int	Returns user ID for user who created object.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ModifiedBy	Int	Returns user ID for user who modified object..
Status	Int	Indicates status of automation.
Client_EnterpriseID	Long	Reserved for future use.

BounceEvent

Contains SMTP and other information pertaining to the specific event of an email message bounce.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM BounceEvent



SELECT * FROM BounceEvent WHERE Id = 123



SELECT * FROM BounceEvent WHERE Id IN (123, 456)



SELECT * FROM BounceEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
ObjectID	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API..
CreatedDate	Datetime	Read-only date and time of the object's creation..
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	Specifies Id of the client.
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
SMTPCode	String	Contains SMTP code related to a bounced email.
BounceCategory	String	Defines category for bounce associated with a bounced email.
SMTPReason	String	Contains SMTP reason associated with a bounced email.
BounceType	String	Defines type of bounce associated with a bounced email.
EventType	String	The type of tracking event.
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
BatchID	Int	Ties triggered send sent events to other events.

ClickEvent

Contains time and date information, as well as a URL ID and a URL, regarding a click on a link contained in a message.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ClickEvent



SELECT * FROM ClickEvent WHERE Id = 123



SELECT * FROM ClickEvent WHERE Id IN (123, 456)



SELECT * FROM ClickEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
ObjectID	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
EventType	String	The type of tracking event
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
BatchID	Int	Ties triggered send sent events to other events.
URLID	Int	Indicates URL ID associated with a click tracking event.
URL	String	Indicates URL included in an event or configuration.

DataExtensionField

Represents a field within a data extension.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtensionField



SELECT * FROM DataExtensionField WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CustomerKey	String	User-supplied unique identifier for an object within an object type, which corresponds to the external key assigned to an object in the user interface.
Name	String	Name of the object or property.
DefaultValue	String	The default value for a data extension field if no value is supplied.
MaxLength	Int	Maximum length of the data.
IsRequired	Bool	Indicates whether the property must have a value specified.
Ordinal	Int	Indicates position of object within an array
IsPrimaryKey	Bool	Designates whether a data extension field is used as a primary key for that data extension.
FieldType	String	Designates data type for a data extension field.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Scale	Int	Indicates numeric precision for decimal properties.
Client_ID	Int	The Id of the client.
DataExtension_CustomerKey	String	User-supplied unique identifier for an object within an object type.
StorageType	String	Indicates special storage properties for the field. Valid values are: Unspecified, Plain, Encrypted, or Obfuscated.

DataExtensionTemplate

Represents a data extension template within an account.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtensionTemplate



SELECT * FROM DataExtensionTemplate WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
Name	String	Name of the object or property.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
Description	String	Describes and provides information regarding the object.
IsSendable	Bool	Specifies whether the template is sendable.
IsTestable	Bool	Specifies whether the template is testable.
SendableCustomObjectField	String	Specifies a sendable custom object field.
SendableSubscriberField	String	Specifies a sendable subscriber field.
DataRetentionPeriodLength	String	Specifies until when should the data be retained.
DataRetentionPeriodUnitOfMeasure	Int	Specifies the unit of measure for the data rentention period.
RowBasedRetention	Bool	Specifies whether row based retention is enabled.
ResetRetentionPeriodOnImport	Bool	Specifies whether retention period should be reset on import.
DeleteAtEndOfRetentionPeriod	Bool	Specifies whether the data should be deleted at the end of the retention period.
RetainUntil	Datetime	Specified until when the data should be retained.

DataFolder

Represents a folder in a Marketing Cloud account

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataFolder



SELECT * FROM DataFolder WHERE Id = 123



SELECT * FROM DataFolder WHERE Id IN (123, 456)



SELECT * FROM DataFolder WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
Client_ID	Int	The Id of the client.
ParentFolder_ID	Int	Specifies the parent folder If for a data folder.
ParentFolder_CustomerKey	String	User-supplied unique identifier for an object within an object type.
ParentFolder_ObjectID	String	System-controlled, read-only text string identifier for object.
ParentFolder_Name	String	Name of the object or property.
ParentFolder_Description	String	Describes and provides information regarding the object.
ParentFolder_ContentType	String	Defines the type of content contained within a folder.
ParentFolder_IsActive	Bool	Specifies whether or not the object is active.
ParentFolder_IsEditable	Bool	Indicates if the property can be edited by the end-user in the profile center.
ParentFolder_AllowChildren	Bool	Specifies whether a data folder can have child data folders.
Name	String	Name of the object or property.
Description	String	Describes and provides information regarding the object.
ContentType	String	Defines the type of content contained within a folder.
IsActive	Bool	Specifies whether or not the object is active.
IsEditable	Bool	Indicates if the property can be edited by the end-user in the profile center.
AllowChildren	Bool	Specifies whether a data folder can have child data folders.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ModifiedBy	Int	Returns user ID for user who modified object.
ObjectID	String	System-controlled, read-only text string identifier for object.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
Client_EnterpriseID	Long	Reserved for future use.
Client_CreatedBy	Int	Returns user ID for user who created object

DoubleOptInMOKeyword

The DoubleOptInMOKeyword object defines an MO keyword, allowing a mobile user to subscribe to SMS messages using a double opt-in workflow.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM DoubleOptInMOKeyword



SELECT * FROM DoubleOptInMOKeyword WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
Client_ID	Int	The Id of the client.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
IsDefaultKeyword	Bool	Specifies if account defaults to this SMS keyword action if no other options are available.
DefaultPublication_ID	Int	Read-only identifier for an object.
InvalidPublicationMessage	String	Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list.
InvalidResponseMessage	String	Specifies message to send in case a subscriber sends in an invalid response.
MissingPublicationMessage	String	Reserved for future use.
NeedPublicationMessage	String	Specifies message to send in case a subscriber sends in an response that does not specify a publication list.
PromptMessage	String	Contains message sent to subscriber to prompt response as part of the double opt-in process.
SuccessMessage	String	Defines SMS message to send if triggered email send succeeds.
UnexpectedErrorMessage	String	Contains message to send to subscriber in case of unexpected error.
ValidPublications	String	Defines valid publication lists for use with a double opt-in event.
ValidResponses	String	Defines valid responses a subscriber can use as part of a double opt-in process.

FileTriggerTypeLastPull

Reserved for future use.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM FileTriggerTypeLastPull



SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

Columns


Name	Type	Description
Client_ID	Long	The Id of the client.
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
ExternalReference	String	Reserved for future use.
Type	String	Indicates type of specific list.
LastPullDate	Datetime	Reserved for future use.

ForwardedEmailEvent

Indicates a subscriber used the Forward To A Friend feature to send an email to another person.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ForwardedEmailEvent



SELECT * FROM ForwardedEmailEvent WHERE Id = 123



SELECT * FROM ForwardedEmailEvent WHERE Id IN (123, 456)



SELECT * FROM ForwardedEmailEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
ObjectID	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
EventType	String	The type of tracking event.
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
BatchID	Int	Ties triggered send sent events to other events.

ForwardedEmailOptInEvent

Specifies an opt-in event related to a Forward To A Friend event.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ForwardedEmailOptInEvent



SELECT * FROM ForwardedEmailOptInEvent WHERE Id = 123



SELECT * FROM ForwardedEmailOptInEvent WHERE Id IN (123, 456)



SELECT * FROM ForwardedEmailOptInEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
ObjectID	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
EventType	String	The type of tracking event.
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
BatchID	Int	Ties triggered send sent events to other events.
OptInSubscriberKey	String	Specifies the subscriber key of a subscriber opted in via forwarded email.

HelpMOKeyword

Defines actions associated with the HELP SMS keyword for an account.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM HelpMOKeyword



SELECT * FROM HelpMOKeyword WHERE Client_ID = 123



SELECT * FROM HelpMOKeyword WHERE Client_ID IN (123, 456)



SELECT * FROM HelpMOKeyword WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
Client_ID	Int	The Id of the client.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
IsDefaultKeyword	Bool	Specifies if account defaults to this SMS keyword action if no other options are available.
MoreChoicesPrompt	String	Text used to inform MO message sender of more available choices as part of a HELP keyword action.
DefaultHelpMessage	String	Contains default message to deliver for a HELP MO message.
MenuText	String	Defines text to use for outlining multiple response options in the response to a HELP MO request.
FriendlyName	String	Contains the friendly name for a HELP MO keyword.

ImportResultsSummary

A retrieve-only object that contains status and aggregate information on an individual import started from an ImportDefinition.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ImportResultsSummary



SELECT * FROM ImportResultsSummary WHERE Id = 123



SELECT * FROM ImportResultsSummary WHERE Id IN (123, 456)



SELECT * FROM ImportResultsSummary WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
ID	Int	Read-only identifier for an object.
Client_ID	Long	The Id of the client.
ImportDefinitionCustomerKey	String	Specifies customer key associated with import definition used in an import.
TaskResultID	Int	Indicates the task result ID associated with a summary of import results.
ImportStatus	String	Specifies import status associated with an import.
StartDate	String	Indicates the start date for the time period for which to retrieve import results.
EndDate	String	Specifies the end data of an activity.
DestinationID	String	Specifies the identifier of either the list or the data extension associated with a completed import.
NumberSuccessful	Int	Specifies number of successful record imports resulting from an import action.
NumberDuplicated	Int	Specifies number of duplicated records resulting from an import.
NumberErrors	Int	Indicates number of errors resulting from an import.
TotalRows	Int	Indicates the total number of rows included in the summary of an import.
ImportType	String	Specfies type of import performed.

LinkSend

Provides information about a link in a send.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM LinkSend



SELECT * FROM LinkSend WHERE Id = 123



SELECT * FROM LinkSend WHERE Id IN (123, 456)



SELECT * FROM LinkSend WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
SendID	Int	Contains identifier for a specific send.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
Client_ID	Int	The Id of the client.
Client_PartnerClientKey	String	User-defined partner key for an account.
Link_ID	Int	The Id of the link.
Link_PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
Link_TotalClicks	Int	Indicates total number of clicks on link in message.
Link_UniqueClicks	Int	Indicates number of unique clicks on message.
Link_URL	String	Indicates URL included in an event or configuration.
Link_Alias	String	Name of link contained in message.

ListSend

Specifies retrieve-only properties associated with the list(s) for a completed send.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ListSend



SELECT * FROM ListSend WHERE Id = 123



SELECT * FROM ListSend WHERE Id IN (123, 456)



SELECT * FROM ListSend WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
Client_ID	Int	The Id of the client.
SendID	Int	Contains identifier for a specific send.
List_ID	Int	Read-only identifier for an object.
List_ListName	String	The name of the list.
Duplicates	Int	Represent the number of duplicate email addresses associated with a send (exists only when a send occurs to multiple lists).
InvalidAddresses	Int	Specifies the number of invalid addresses associated with a send.
ExistingUndeliverables	Int	Indicates whether bounces occurred on previous send.
ExistingUnsubscribes	Int	Indicates whether unsubscriptions occurred on previous send.
HardBounces	Int	Indicates number of hard bounces associated with a send.
SoftBounces	Int	Indicates number of soft bounces associated with a specific send.
OtherBounces	Int	Specifies number of Other-type bounces in a send.
ForwardedEmails	Int	Number of emails forwarded for a send.
UniqueClicks	Int	Indicates number of unique clicks on message.
UniqueOpens	Int	Indicates number of unique opens resulting from a triggered send.
NumberSent	Int	Number of emails actually sent as part of an email send. This number reflects all of the sent messages and may include bounced messages.
NumberDelivered	Int	Number of sent emails that did not bounce.
Unsubscribes	Int	Indicates the number of unsubscribe events associated with a send.
MissingAddresses	Int	Specifies number of missing addresses encountered within a send.
PreviewURL	String	Indicates URL used to preview the message associated with a send.

ListSubscriber

Retrieves subscribers for a list or lists for a subscriber.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ListSubscriber



SELECT * FROM ListSubscriber WHERE Id = 123



SELECT * FROM ListSubscriber WHERE Id IN (123, 456)



SELECT * FROM ListSubscriber WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
ObjectID	String	System-controlled, read-only text string identifier for object.
SubscriberKey	String	Identification of a specific subscriber.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
Client_PartnerClientKey	String	User-defined partner key for an account.
ListID	Int	Defines identification for a list the subscriber resides on.
Status	String	Defines status of an object.
UnsubscribedDate	Datetime	The date the subscriber unsubscribed.

MessagingVendorKind

Contains the vendor details for an SMS (short message service) or voice messaging vendor. Deprecated.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM MessagingVendorKind



SELECT * FROM MessagingVendorKind WHERE Id = 123



SELECT * FROM MessagingVendorKind WHERE Id IN (123, 456)



SELECT * FROM MessagingVendorKind WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Identifier for an object.
Vendor	String	Deprecated.
Kind	String	Deprecated.
IsUsernameRequired	Bool	Deprecated.
IsPasswordRequired	Bool	Deprecated.
IsProfileRequired	Bool	Deprecated.
CreatedDate	Datetime	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.

NotSentEvent

Contains information on when email message failed to be sent.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM NotSentEvent



SELECT * FROM NotSentEvent WHERE SendID = 123



SELECT * FROM NotSentEvent WHERE SendID IN (123, 456)



SELECT * FROM NotSentEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
Client_ID	Int	The Id of the client.
EventType	String	The type of tracking event
BatchID	Int	Ties triggered send sent events to other events.
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
ListID	Int	Defines identification for a list the subscriber resides on.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
SubscriberID	Int	The Id of the subscriber.

OpenEvent

Contains information about the opening of a message send by a subscriber.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM OpenEvent



SELECT * FROM OpenEvent WHERE Id = 123



SELECT * FROM OpenEvent WHERE Id IN (123, 456)



SELECT * FROM OpenEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
ObjectID	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
EventType	String	The type of tracking event
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
BatchID	Int	Ties triggered send sent events to other events.

PrivateIP

The PrivateIP object contains information on private IP address to be used as part of messages sends.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM PrivateIP



SELECT * FROM PrivateIP WHERE Id = 123



SELECT * FROM PrivateIP WHERE Id IN (123, 456)



SELECT * FROM PrivateIP WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	Read-only date and time of the object's creation.
Client_ID	Int	The Id of the client.
Name	String	Name of the object or property.
Description	String	Describes and provides information regarding the object.
IsActive	Bool	Specifies whether or not the object is active.
OrdinalID	String	Defines position of object within an array of information.
IPAddress	String	Contains IP address to be used in for a private IP.
Client_PartnerClientKey	String	User-defined partner key for an account.

Publication

Reserved for future use.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM Publication



SELECT * FROM Publication WHERE Id = 123



SELECT * FROM Publication WHERE Id IN (123, 456)



SELECT * FROM Publication WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
Client_PartnerClientKey	String	User-defined partner key for an account.
Name	String	Name of the object or property.
Category	Int	ID of the folder that an item is located in.

PublicationSubscriber

Describes subscriber on a publication list.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM PublicationSubscriber



SELECT * FROM PublicationSubscriber WHERE Publication_ID = 123



SELECT * FROM PublicationSubscriber WHERE Publication_ID IN (123, 456)



SELECT * FROM PublicationSubscriber WHERE Publication_CreatedDate > '2017/01/25'

Columns


Name	Type	Description
Publication_ID	Int	Read-only identifier for an object.
Publication_PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
Publication_CreatedDate	Datetime	Read-only date and time of the object's creation.
Publication_ModifiedDate	Datetime	Indicates the last time object information was modified.
Publication_Client_ID	Int	Read-only identifier for an object.
Publication_Client_PartnerClientKey	String	Unique identifier provided by partner for an object, accessible only via API.
Client_ID	Int	The Id of the client.
Client_PartnerClientKey	String	User-defined partner key for an account.
Publication_Name	String	Name of the object or property.
Publication_Category	Int	The category of the publication.
Subscriber_ID	Int	Read-only identifier for an object.
Subscriber_SubscriberKey	String	Identification of a specific subscriber.
Subscriber_PrimarySMSAddress_AddressType	String	The address type of the subscriber.
Subscriber_PrimarySMSAddress_Address	String	The address of the subscriber.
Subscriber_PrimarySMSAddress_Carrier	String	The carrier of the subscriber.
Subscriber_PrimarySMSPublicationStatus	String	The primary SMS publication status of the subscriber.

PublicKeyManagement

Reserved for future use.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM PublicKeyManagement



SELECT * FROM PublicKeyManagement WHERE Id = 123



SELECT * FROM PublicKeyManagement WHERE Id IN (123, 456)



SELECT * FROM PublicKeyManagement WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
Client_ID	Long	The Id of the client.
Name	String	Name of the object or property.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
Key	String	Specifies key associated with content area in HTML body.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.

ResultItem

Contains results of asynchronous API call.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ResultItem



SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID = 123



SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID IN (123, 456)



SELECT * FROM ResultItem WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
AsyncAPIRequestQueueID	Int	The Id of the async API request queue.
RequestID	String	Unique ID of initial async API call.
ConversationID	String	Unique ID of initial async API call. All requests that should be processed as a single unit will have the same ConversationID.
CorrelationID	String	Identifies correlation of objects across several requests.
Client_ID	Int	The Id of the client.
CreatedDate	Datetime	Read-only date and time of the object's creation.
StatusCode	String	Status of async API request.
StatusMessage	String	Describes the status of an API call.
OrdinalID	Int	System-controlled, read-only text string identifier for object.
ErrorCode	Int	Identifies the error of an API request via a numeric code.
RequestType	String	Defines request as synchronous or asynchronous API.
RequestObjectType	String	Defines type of the Request object, such as email or triggered send.
ResultType	Int	Defines result as coming from synchronous or asynchronous API.
Client_PartnerClientKey	String	User-defined partner key for an account.

ResultMessage

Message containing results of async call.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM ResultMessage



SELECT * FROM ResultMessage WHERE RequestID = 123



SELECT * FROM ResultMessage WHERE RequestID IN (123, 456)



SELECT * FROM ResultMessage WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
RequestID	String	Unique ID of initial async API call.
ConversationID	String	Unique ID of initial async API call.
Client_ID	Int	The Id of the client.
CreatedDate	Datetime	Read-only date and time of the object's creation.
OverallStatusCode	String	Represents overall status of conversation via async API.
StatusCode	String	Status of async API request.
StatusMessage	String	Describes the status of an API call.
ErrorCode	Int	Identifies the error of an API request.
RequestType	String	Defines request as synchronous or asynchronous API.
ResultType	String	Defines result as coming from synchronous or asynchronous API.
ResultDetailXML	String	Contains details of operation result in XML format.
Client_PartnerClientKey	String	User-defined partner key for an account.

Role

Defines roles and permissions assigned to a user in an account.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM Account



SELECT * FROM Account WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM Account WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM Account WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
Name	String	Name of the object or property.
Description	String	Describes and provides information regarding the object.
IsPrivate	Bool	Indicates whether role is defined by Marketing Cloud or a client.
IsSystemDefined	Bool	Indicates whether role is defined by the application.
Client_EnterpriseID	Long	Reserved for future use.
Client_ID	Int	The Id of the client.
Client_CreatedBy	Int	Returns user ID for user who created object
CreatedDate	Datetime	Read-only date and time of the object's creation.
Client_ModifiedBy	Int	Returns user ID for user who modified object.
ModifiedDate	Datetime	Indicates the last time object information was modified.
PermissionSets	String	Indicates permission sets applied to a Role or PermissionSet object.
Permissions	String	Specifies an array of permissions.

SendEmailMOKeyword

Defines the action that sends a triggered email message to the email addresses defined in an MO message.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SendEmailMOKeyword



SELECT * FROM SendEmailMOKeyword WHERE Client_ID = 123



SELECT * FROM SendEmailMOKeyword WHERE Client_ID IN (123, 456)



SELECT * FROM SendEmailMOKeyword WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
Client_ID	Int	The Id of the client.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
NextState_CustomerKey	String	The customer key of the next state.
IsDefaultKeyword	Bool	Specifies if account defaults to this SMS keyword action if no other options are available.
SuccessMessage	String	Defines SMS message to send if triggered email send succeeds.
MissingEmailMessage	String	Defines message to send if MO message does not contain a valid email address.
FailureMessage	String	Defines message to deliver in case the email send fails.
TriggeredSend_CustomerKey	String	The customer key of the triggered send definition.

SendSMSMOKeyword

Defines actions to take when the specified MO keyword is received.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SendSMSMOKeyword



SELECT * FROM SendSMSMOKeyword WHERE Client_ID = 123



SELECT * FROM SendSMSMOKeyword WHERE Client_ID IN (123, 456)



SELECT * FROM SendSMSMOKeyword WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
Client_ID	Int	The Id of the client.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
NextMOKeyword_CustomerKey	String	Defines the customer key of the next MO keyword to use in an SMS conversation.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
IsDefaultKeyword	Bool	Specifies if account defaults to this SMS keyword action if no other options are available.
Message	String	Contains contents of results message.
ScriptErrorMessage	String	Defines message to deliver to subscriber in case of an error in the SMS conversation.

SendSummary

A retrieve only object that contains summary information about a specific send event.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SendSummary



SELECT * FROM SendSummary WHERE Client_ID = 123



SELECT * FROM SendSummary WHERE Client_ID IN (123, 456)



SELECT * FROM SendSummary WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
Client_ID	Int	The Id of the client.
AccountID	Int	Identifier for account.
SendID	Int	Contains identifier for a specific send.
DeliveredTime	String	Indicates the time a message was delivered.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
AccountName	String	Name of account.
AccountEmail	String	Specifies email address attached to account.
IsTestAccount	Bool	Specifies whether or not an account is a 'Test' account.
TotalSent	Int	Indicates total number of messages sent as part of a send.
Transactional	Int	Indicates number of transactional messages included in a send.
NonTransactional	Int	Specifies number of marketing (non-transactional) messages included as part of a send.

SentEvent

Contains tracking data related to a send, including information on individual subscribers.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SentEvent



SELECT * FROM SentEvent WHERE Id = 123



SELECT * FROM SentEvent WHERE Id IN (123, 456)



SELECT * FROM SentEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
Client_ID	Int	The Id of the client.
EventType	String	The type of tracking event
BatchID	Int	Ties triggered send sent events to other events.
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
ListID	Int	Defines identification for a list the subscriber resides on.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
SubscriberID	Int	The Id of the subscriber.

SMSMTEvent

Contains information on a specific SMS message sent to a subscriber.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SMSMTEvent



SELECT * FROM SMSMTEvent WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM SMSMTEvent WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM SMSMTEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
EventDate	Datetime	Date when a tracking event occurred.
Client_ID	Long	The Id of the client.
MOCode	String	Specifies the MO code associated with a specific MO or MT tracking event.
SMSTriggeredSend_SMSSendId	String	Indicates ID for a specific SMS send.
SMSTriggeredSend_SMSTriggeredSendDefinition_ObjectID	String	System-controlled, read-only text string identifier for object.
SMSTriggeredSend_SMSTriggeredSendDefinition_CustomerKey	String	User-supplied unique identifier for an object within an object type.
Subscriber_ID	Int	Read-only identifier for an object.
Subscriber_SubscriberKey	String	Identification of a specific subscriber.
Subscriber_PrimarySMSAddress_Address	String	The primary SMS address of the subscribers.
Carrier	String	Name of the SMS carrier associated with an SMS address.

SMSSharedKeyword

Contains information used to request a keyword for use with SMS messages in a Marketing Cloud account.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SMSSharedKeyword



SELECT * FROM SMSSharedKeyword WHERE Client_ID = 123



SELECT * FROM SMSSharedKeyword WHERE Client_ID IN (123, 456)



SELECT * FROM SMSSharedKeyword WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Long	The Id of the client.
SharedKeyword	String	Specifies keyword requested for use in an account.
RequestDate	Datetime	Specifies the date when the request for an SMS shared keyword was made.
EffectiveDate	Datetime	Specifies when an SMS shared keyword becomes active for use.
ExpireDate	Datetime	Specifies when an SMS shared keyword stops being active for use.
ReturnToPoolDate	Datetime	Specifies the date when an expired SMS keyword can be requested for different use in a short code.
ShortCode	String	Specifies the short code for which an SMS keyword was requested.

SMSTriggeredSendDefinition

Defines the send definition for an SMS message.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SMSTriggeredSendDefinition



SELECT * FROM SMSTriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM SMSTriggeredSendDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM SMSTriggeredSendDefinition WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
Client_ID	Long	The Id of the client.
Name	String	Name of the object or property.
Description	String	Describes and provides information regarding the object.
Publication_ID	Int	Read-only identifier for an object.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Content_ID	Int	Read-only identifier for an object.
SendToList	Bool	Indicates whether SMS triggered send goes to a list or a single subscriber.
DataExtension_ObjectID	String	System-controlled, read-only text string identifier for object.
IsPlatformObject	Bool	Indicated whether the object is a platform object.

SubscriberList

Use to retrieve lists for a specific subscriber.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SubscriberList



SELECT * FROM SubscriberList WHERE Id = 123



SELECT * FROM SubscriberList WHERE Id IN (123, 456)



SELECT * FROM SubscriberList WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ListSubID	Long	Identifier for an object.
ID [KEY]	Int	Identifier for an object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	date and time of the object's creation.
Subscriber_UnsubscribedDate	Datetime	The unsubscribed date of the subscriber.
Client_ID	Int	The Id of the client.
Status	String	Defines status of object.
List_ID	Int	Identifier for an object.
List_ListName	String	The name of the list.
Subscriber_Status	String	Defines status of object.
Subscriber_CreatedDate	Datetime	Indicates the date and time of the object's creation.
Subscriber_ID	Int	identifier for an object.
Subscriber_EmailAddress	String	The email address of a subscriber.
Subscriber_SubscriberKey	String	Identification of a specific subscriber.
Subscriber_PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.

SubscriberSendResult

Reserved for future use.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SubscriberSendResult



SELECT * FROM SubscriberSendResult WHERE Id = 123



SELECT * FROM SubscriberSendResult WHERE Id IN (123, 456)



SELECT * FROM SubscriberSendResult WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
Send_ID	Int	Read-only identifier for an object.
ID [KEY]	Int	Read-only identifier for an object.
Email_ID	Int	Read-only identifier for an object.
Email_Name	String	Name of the object or property.
Subject	String	Contains subject area information for a message.
FromName	String	Specifies the default email message From Name.
FromAddress	String	Indicates From address associated with a object.
SentDate	Datetime	Indicates date on which a send took place.
OpenDate	Datetime	Specifies data on which a subscriber opened a send.
ClickDate	Datetime	Specifies the data subscriber clicked a link included in a send.
Subscriber_Partnerkey	String	Unique identifier provided by partner for an object, accessible only via API.
Subscriber_EmailAddress	String	The email address of the subscriber.
Subscriber_PartnerType	String	The partner type of the subscriber.
UnsubscribeDate	Datetime	Indicates the date on which an unsubscribe event took place due to a send.
LastOpenDate	Int	Specifies the date subscribe was last opened.
LastClickDate	Int	Specifies the date subscribe was last clicked.
BounceDate	Datetime	Contains the date on which an individual send bounced for a subscriber.
EventDate	Int	Indicated the date of the event.
TotalClicks	Int	Indicates total number of clicks on link in message.
UniqueClicks	Int	Indicates number of unique clicks on message.
EmailAddress	Int	Indicates From address associated with a object.
Subscriber_ID	Int	Read-only identifier for an object.
SubscriberTypeID	Int	Read-only identifier for an object.
Subscriber_SubscriberKey	String	The subscriber key of the subscriber.
Send_PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
Client_ID	Int	The Id of the client.
OtherBounces	Int	Specifies number of Other-type bounces in a send.
SoftBounces	Int	Indicates number of soft bounces associated with a specific send.
HardBounces	Int	Indicates number of hard bounces associated with a send.

SuppressionListContext

Defines a context that a SuppressionListDefinition can be associated with.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SuppressionListContext



SELECT * FROM SuppressionListContext WHERE Id = 123



SELECT * FROM SuppressionListContext WHERE Id IN (123, 456)



SELECT * FROM SuppressionListContext WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
Definition_ObjectID	String	System-controlled, read-only text string identifier for object.
Definition_Name	String	Name of the object or property.
Definition_CustomerKey	String	User-supplied unique identifier for an object within an object type.
Definition_Category	Long	The category of the defition.
Definition_Description	String	Describes and provides information regarding the object.
Context	String	The context with which a SuppressionListDefinition is associated.
SendClassification_ObjectID	String	System-controlled, read-only text string identifier for object.
Send_ID	Int	Read-only identifier for an object.
SenderProfile_ObjectID	String	System-controlled, read-only text string identifier for object.
SendClassificationType	String	Defines the type for the applicable send classification. Valid values include Operational and Marketing.
Client_CreatedBy	Int	Returns user ID for user who created object
CreatedDate	Datetime	Read-only date and time of the object's creation.
Client_ModifiedBy	Int	Returns user ID for user who modified object.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Long	The Id of the client.
Client_EnterpriseID	Long	Reserved for future use.
AppliesToAllSends	Bool	Indicates whether this context applies to all transactional and marketing sends.

SurveyEvent

Contains information on when a survey response took place.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM SurveyEvent



SELECT * FROM SurveyEvent WHERE Id = 123



SELECT * FROM SurveyEvent WHERE Id IN (123, 456)



SELECT * FROM SurveyEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
ObjectID	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
EventType	String	The type of tracking event.
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
BatchID	Int	Ties triggered send sent events to other events.
Question	String	Specifies question associated with a survey event.
Answer	String	The answer provided by a subscriber to the survey question.

Template

Represents an email template in a Marketing Cloud account.

Table-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM Template



SELECT * FROM Template WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM Template WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM Template WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID	String	System-controlled, read-only text string identifier for object.
ID [KEY]	Int	Read-only identifier for an object.
Client_ID	Int	The Id of the client.
TemplateName	String	Name used to identify template within Marketing Cloud application.
LayoutHTML	String	Contains HTML used to define layout of fields and content within template.
BackgroundColor	String	Specifies background color used for template.
BorderColor	String	Specifies border color used in template.
BorderWidth	Int	Specifies border pixel width used in template.
Cellpadding	Int	Specifies pixel width of padding within cells used in template.
Cellspacing	Int	Specifies pixel spacing between cells used in template.
Width	Int	Specifies the pixel width of the entire template
Align	String	Indicates the alignment of elements within the template.
ActiveFlag	Int	Indicates whether the template is available for use within the account.
CategoryID	Int	Indicates whether content validation has completed for this email message.
CategoryType	String	Identifies correlation of objects across several requests.
OwnerID	Int	Specifies MID of business unit that created the template within an Enterprise 2.0 account.
HeaderContent_ID	Int	The Id of the header content.
HeaderContent_ObjectID	String	System-controlled, read-only text string identifier for object.
Layout_ID	Int	The Id of the layout.
Layout_LayoutName	String	The name of the layout.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
TemplateSubject	String	Contains email subject line specified by the template.
IsTemplateSubjectLocked	Bool	Indicates whether the subject defined in the header can be changed or not by email using template.

TimeZone

Represents a specific time zone in the application.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM TimeZone

Columns


Name	Type	Description
ID [KEY]	Int	Read-only identifier for an object.
Name	String	Name of the object or property.

TriggeredSendSummary

Summary of results for a specific triggered send.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM TriggeredSendSummary



SELECT * FROM TriggeredSendSummary WHERE ObjectID = 'nzxcaslkjd-123'



SELECT * FROM TriggeredSendSummary WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')



SELECT * FROM TriggeredSendSummary WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ObjectID [KEY]	String	System-controlled, read-only text string identifier for object.
Client_ID	Long	The Id of the client.
Client_PartnerClientKey	String	User-defined partner key for an account.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
Sent	Long	Indicates number of messages sent.
NotSentDueToOptOut	Long	Indicates number of sends not completed due to a subscriber's decision to opt out of receiving messages.
NotSentDueToUndeliverable	Long	Indicates number of sends not completed due to a subscriber's undeliverable status.
Bounces	Long	Indicates number of bounces resulting from a triggered send.
Opens	Long	Indicates number of opens from a triggered send.
UniqueOpens	Long	Indicates number of opens from a triggered send.
Clicks	Long	Indicates the number of clicks resulting from a triggered send.
UniqueClicks	Long	Indicates number of unique clicks on message.
OptOuts	Long	Indicates number of subscribers who opted out of receiving messages after receiving a triggered send.
SurveyResponses	Long	Indicates number of responses to a survey question contained in a triggered send.
FTAFRequests	Long	Indicates number of Forward To A Friend requests received as part of a triggered send.
FTAFEmailsSent	Long	Indicates Forward To A Friend emails sent as a result of a triggered send.
FTAFOptIns	Long	Indicates number of subscribers opting in to receiving messages as a result of a Forward To A Friend action from a triggered send.
Conversions	Long	Indicates the number of conversions results from a triggered send.
UniqueConversions	Long	Indicates number of unique conversions resulting from a triggered send.
InProcess	Long	Indicates the number of triggered send messages in progress. Deprecated.
NotSentDueToError	Long	Indicates number of triggered send messages not sent due to error.
RowObjectID	String	The row id of the object.
TriggeredSendDefinition_ObjectID	String	The Id of the associated triggered send definition for triggered send.
Queued	Long	Indicates number of messages queued for sending.

UnsubEvent

Contains information regarding a specific unsubscription action taken by a subscriber.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM UnsubEvent



SELECT * FROM UnsubEvent WHERE Id = 123



SELECT * FROM UnsubEvent WHERE Id IN (123, 456)



SELECT * FROM UnsubEvent WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
ID	Int	Read-only identifier for an object.
ObjectID	String	System-controlled, read-only text string identifier for object.
PartnerKey	String	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
Client_ID	Int	The Id of the client.
SendID	Int	Contains identifier for a specific send.
SubscriberKey	String	Identification of a specific subscriber.
EventDate	Datetime	Date when a tracking event occurred.
EventType	String	The type of tracking event
TriggeredSendDefinitionObjectID	String	Identifies the triggered send definition associated with an event.
BatchID	Int	Ties triggered send sent events to other events.
List_ID	Int	Indicates the id of the list involved in the unsubscription.
List_Type	String	Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master.
List_ListClassification	String	Specifies the classification for a list.
IsMasterUnsubscribed	Bool	Indicates whether the subscriber master unsubscribed.

UnsubscribeFromSMSPublicationMOKeyword

Defines keyword used by a subscriber to unsubscribe from an SMS publication list.

View-Specific Information

Select

For example, the following (but not only) queries are processed server side:

SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword



SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID = 123



SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID IN (123, 456)



SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE CreatedDate > '2017/01/25'

Columns


Name	Type	Description
Client_ID	Int	The Id of the client.
CreatedDate	Datetime	Read-only date and time of the object's creation.
ModifiedDate	Datetime	Indicates the last time object information was modified.
CustomerKey	String	User-supplied unique identifier for an object within an object type.
NextMOKeyword_CustomerKey	String	Defines next MO keyword to use in an SMS conversation.
IsDefaultKeyword	Bool	Specifies if account defaults to this SMS keyword action if no other options are available.
AllUnsubSuccessMessage	String	Contains message to send to subscriber when they have successfully unsubscribed from all SMS publication lists.
InvalidPublicationMessage	String	Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list.
SingleUnsubSuccessMessage	String	Contains message to send to subscriber when they have successfully unsubscribed from a single publication list.

Matillion Data Model for Salesforce Marketing Cloud Query SOAPVersion - 21.0.8222.0

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Authentication on Headless Machines

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Matillion Data Model for Salesforce Marketing Cloud Query SOAP
Version - 21.0.8222.0