`

Matillion ETL Data Model for Marketo
Version - 18.0.6886

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




Connection String OptionsBack To Top

  1. Auto Cache
  2. Batch Size
  3. Cache Connection
  4. Cache Driver
  5. Cache Location
  6. Cache Metadata
  7. Cache Query Result
  8. Cache Tolerance
  9. Check Prompt Mode
  10. Connection Life Time
  11. Connect On Open
  12. Encryption Key
  13. Firewall Password
  14. Firewall Port
  15. Firewall Server
  16. Firewall Type
  17. Firewall User
  18. Initiate OAuth
  19. Job Polling Interval
  20. Location
  21. Logfile
  22. Max Log File Size
  23. Max Rows
  24. OAuth Access Token
  25. OAuth Client Id
  26. OAuth Client Secret
  27. OAuth Settings Location
  28. Offline
  29. Other
  30. Page Size
  31. Pool Idle Timeout
  32. Pool Max Size
  33. Pool Min Size
  34. Pool Wait Time
  35. Proxy Auth Scheme
  36. Proxy Auto Detect
  37. Proxy Exceptions
  38. Proxy Password
  39. Proxy Port
  40. Proxy Server
  41. Proxy SSL Type
  42. Proxy User
  43. Pseudo Columns
  44. Readonly
  45. REST Endpoint
  46. RTK
  47. Schema
  48. SOAP Endpoint
  49. SSL Server Cert
  50. Support Enhanced SQL
  51. Tables
  52. Timeout
  53. Use Bulk API
  54. Use Connection Pooling
  55. User Id
  56. Verbosity
  57. Views



Auto Cache

Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . Configured with CacheQueryResult .
Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. 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. With CacheQueryResult additionally set, the driver updates the cache when you execute a SELECT query and returns the live results from the Marketo data.

Explicitly Caching SELECT Results

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

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

SELECT * FROM [Leads#CACHE]

Setting the Caching Database

When AutoCache is set, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

See Also





Batch Size

The maximum size of each batch operation to submit.
Data Type

int

Default Value

0

Remarks

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

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





Cache Connection

The connection string for the cache database. Always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Data Type

string

Default Value

""

Remarks

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

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

Derby and Java DB

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

Alternatively, you can configure the connection to Derby manually using CacheProvider and CacheConnection. Below is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

SQLite

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

jdbc:sqlite:dataSource

MySQL

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

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

SQL Server

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

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
Below are typical SQL Server connection properties:
Oracle

Below is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
Below are typical connection properties:
PostgreSQL

Below is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
Below are typical connection properties:





Cache Driver

The database driver to be used to cache data.
Data Type

string

Default Value

""

Remarks

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

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

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

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

Derby and Java DB

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

jdbc:marketo:CacheLocation='c:/Temp/cachedir';Schema=REST;RESTEndpoint=https://MyMarketoUrl/rest;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;
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:marketo:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';Schema=REST;RESTEndpoint=https://MyMarketoUrl/rest;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;
SQLite

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:marketo:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';Schema=REST;RESTEndpoint=https://MyMarketoUrl/rest;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;
MySQL

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

  jdbc:marketo:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';Schema=REST;RESTEndpoint=https://MyMarketoUrl/rest;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;
  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Marketo 2018 installation directory.
SQL Server

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

jdbc:marketo:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';Schema=REST;RESTEndpoint=https://MyMarketoUrl/rest;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;
Oracle

Below is a JDBC URL for the Oracle Thin Client:

jdbc:marketo:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';Schema=REST;RESTEndpoint=https://MyMarketoUrl/rest;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;
PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:marketo:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';Schema=REST;RESTEndpoint=https://MyMarketoUrl/rest;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;





Cache Location

Specifies the path to the cache when caching to a file.
Data Type

string

Default Value

""

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also





Cache Metadata

Whether or not to cache the table metadata to a file store.
Data Type

bool

Default Value

false

Remarks

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





Cache Query Result

With AutoCache set, caches each row read from a SELECT query's results. Without this, the provider will attempt to fully replicate the table before executing the actual query against the replication database.
Data Type

bool

Default Value

false

Remarks

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





Cache Tolerance

The tolerance for stale data in the cache specified in seconds when using AutoCache .
Data Type

string

Default Value

"600"

Remarks

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





Check Prompt Mode

For ODBC, check whether the application says if it supports prompting the user. You can turn this off to force it to launch the browser during OAuth. (Qlikview, Visual Studio, Power BI all have NO_PROMPT).
Data Type

bool

Default Value

false

Remarks

For ODBC, check whether the application says if it supports prompting the user. You can turn this off to force it to launch the browser during OAuth. (Qlikview, Visual Studio, Power BI all have NO_PROMPT).

For ODBC, check whether the application says if it supports prompting the user. You can turn this off to force it to launch the browser during OAuth. (Qlikview, Visual Studio, Power BI all have NO_PROMPT).





Connection Life Time

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Data Type

string

Default Value

"0"

Remarks

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





Connect On Open

Species whether to connect to the Marketo when the connection is opened.
Data Type

bool

Default Value

false

Remarks

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





Encryption Key

The Marketo SOAP API Encryption Key.
Data Type

string

Default Value

""

Remarks

The EncryptionKey is generated on the Admin page of the Marketo website and is used to authenticate to the Marketo SOAP Web service.





Firewall Password

A password used to authenticate to a proxy-based firewall.
Data Type

string

Default Value

""

Remarks

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





Firewall Port

The TCP port for a proxy-based firewall.
Data Type

string

Default Value

""

Remarks

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





Firewall Server

The name or IP address of a proxy-based firewall.
Data Type

string

Default Value

""

Remarks

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

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





Firewall Type

The protocol used by a proxy-based firewall.
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 Marketo and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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





Firewall User

The user name to use to authenticate with a proxy-based firewall.
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.





Initiate OAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Data Type

string

Default Value

"GETANDREFRESH"

Remarks

The following options are available:

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





Job Polling Interval

Specifies the polling interval (in seconds) when checking the status of a bulk API job.
Data Type

int

Default Value

120

Remarks

This property is used to specify the polling interval (in seconds) to identify when a bulk API job has completed. The driver will wait JobPollingInterval seconds between calls to check a bulk API job status. Once the job is identified as 'Completed', the driver will download and parse the generated file returning the results of the specified query.

This property can be set to 0 to just create and enqueue a job in which case the Job Id will be returned in the result set. The job status can then be checked using stored procedures.

Note: This property is only applicable when UseBulkAPI is set to True. See the UseBulkAPI page for more information about using the Bulk API.





Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type

string

Default Value

""

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.





Logfile

A path to the log file.
Data Type

string

Default Value

""

Remarks

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





Max Log File Size

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Data Type

string

Default Value

"100MB"

Remarks

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





Max Rows

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

string

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.





OAuth Access Token

The access token for connecting using OAuth.
Data Type

string

Default Value

""

Remarks

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

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





OAuth Client Id

The client Id assigned when you register your application with an OAuth authorization server.
Data Type

string

Default Value

""

Remarks

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





OAuth Client Secret

The client secret assigned when you register your application with an OAuth authorization server.
Data Type

string

Default Value

""

Remarks

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





OAuth Settings Location

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
Data Type

string

Default Value

"%APPDATA%\\CData\\Marketo 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. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder. 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.





Offline

Use offline mode to get the data from the cache instead of the live source.
Data Type

bool

Default Value

false

Remarks

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





Other

Hidden properties needed only in specific use cases.
Data Type

string

Default Value

""

Remarks

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

Specify multiple properties in a semicolon-separated list.

Caching Configuration

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

Integration and Formatting

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





Page Size

The number of results to return per page from Marketo.
Data Type

string

Default Value

"1000"

Remarks

The PageSize can control the number of results requested from Marketo on a given query. Setting a higher PageSize will cause more data to come back in a given request, but may take longer to execute. Setting a smaller PageSize is generally recommended to ensure timeout exceptions do not occur.

The default value is 1000; however, Marketo may impose a smaller items-per-page limit (such as 100). Therefore the PageSize will be 100 for all subsequent requests.

Note the Marketo REST API imposes a 300 items-per-page limit and thus 300 is the maximum number of items that will be returned in a Marketo REST API.





Pool Idle Timeout

The allowed idle time for a connection before it is closed.
Data Type

string

Default Value

""

Remarks

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





Pool Max Size

The maximum connections in the pool.
Data Type

string

Default Value

"100"

Remarks

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





Pool Min Size

The minimum number of connections in the pool.
Data Type

string

Default Value

"1"

Remarks

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





Pool Wait Time

The max seconds to wait for an available connection.
Data Type

string

Default Value

""

Remarks

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





Proxy Auth Scheme

The authentication type to use to authenticate to the ProxyServer proxy.
Data Type

string

Default Value

"BASIC"

Remarks

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

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

The authentication type can be one of the following:

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





Proxy Auto Detect

This indicates whether to use the system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.
Data Type

bool

Default Value

true

Remarks

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

To connect to an HTTP proxy, see ProxyServer.

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





Proxy Exceptions

A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer .
Data Type

string

Default Value

""

Remarks

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

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





Proxy Password

A password to be used to authenticate to the ProxyServer proxy.
Data Type

string

Default Value

""

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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





Proxy Port

The TCP port the ProxyServer proxy is running on.
Data Type

string

Default Value

"80"

Remarks

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





Proxy Server

The hostname or IP address of a proxy to route HTTP traffic through.
Data Type

string

Default Value

""

Remarks

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

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

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





Proxy SSL Type

The SSL type to use when connecting to the ProxyServer proxy.
Data Type

string

Default Value

"AUTO"

Remarks

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

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





Proxy User

A user name to be used to authenticate to the ProxyServer proxy.
Data Type

string

Default Value

""

Remarks

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

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

user@domain
domain\user





Pseudo Columns

Indicates whether or not to include pseudo columns as columns to the table.
Data Type

string

Default Value

""

Remarks

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





Readonly

You can use this property to enforce read-only access to Marketo from the provider.
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.





REST Endpoint

The Marketo REST API Endpoint.
Data Type

string

Default Value

""

Remarks

The URL of the REST Web service endpoint is provided by Marketo on the Admin page of the Marketo website.





RTK

The runtime key used for licensing.
Data Type

string

Default Value

""

Remarks

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





Schema

The type of schema to use.
Data Type

string

Default Value

"REST"

Remarks

The schemas available are REST (to use Marketo's REST API) and SOAP (to use Marketo's SOAP API).





SOAP Endpoint

The Marketo SOAP API Endpoint.
Data Type

string

Default Value

""

Remarks

The URL of the SOAP Web service endpoint is provided by Marketo on the Admin page of the Marketo website.





SSL Server Cert

The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type

string

Default Value

""

Remarks

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

This property can take the forms:

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

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).





Support Enhanced SQL

Enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to Marketo and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the Marketo API.

Execution of Predicates

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

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





Tables

Restrict the tables reported to a subset of the available tables. For example: Tables=TableA,TableB,TableC.
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. For example: Tables=TableA,TableB,TableC





Timeout

The value in seconds until the timeout error is thrown, canceling the operation.
Data Type

string

Default Value

"60"

Remarks

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

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





Use Bulk API

Specifies whether to use the Marketo Bulk API.
Data Type

bool

Default Value

false

Remarks

When set to 'True', the Marketo Bulk API will be used to extract or import data, where applicable. The Bulk API in an interface that allows you to retrieve or import large sets of data using delimited (CSV, TSV, or SSV) files. Currently the only tables that support the Bulk API are: Leads (extract and import) and Activities (extract). For any tables that do not support the Bulk API, this property will be ignored.

The Bulk API causes all the data to be retrieved in a single request and requires the data to be accumulated on the server side prior to sending. Therefore requesting a large amount of data using the Bulk API may be advantageous over using the REST API and you may see performance improvements. Additionally the Bulk API requires less API requests to be made (which helps preserve your API calls and staying within the API restrictions enforced by Marketo).

To use the Bulk API to extract records, a job must be created and enqueued. Once enqueued, Marketo will begin processing the job to retrieve the requested data and generate the delimited file. The status of the job can be polled to determine the current status and whether the file is available to be downloaded. Once the status shows that the job is complete and the file is ready, the data can then be downloaded.

When UseBulkAPI is set to True and JobPollingInterval is set to a value greater than 0, the driver will perform all the previous mentioned steps for you when executing a SELECT query on a Leads or Activities table. This will create and enqueue a job with the specified columns and filters. Note that a filter is required when exporting bulk data. For the Activities tables, an ActivityDate range must be specified. For the Leads table, a CreatedAt or UpdatedAt range may be specified or a Static or Smart list. The driver will poll the job status to identify when the job has completed, waiting JobPollingInterval seconds in between calls. Once the job is complete, the driver will download the delimited file that was created, parse it, and return the results for the specified query.

Note that job status calls count against your API call limit and thus it is suggested to space out your status requests based on the amount of data you are requesting. The job status polling interval is configurable via JobPollingInterval. Marketo will only update the status every 60 seconds and thus it is suggested that your polling interval be larger than 60 seconds. When expecting large datasets, it may be best to increase the polling interval to a value greater than 5 minutes to minimize API calls. It is possible that it may take a while for the job to be processed and thus it may seem like the query is exhibiting a hanging behavior when it is actually just waiting for the job to complete.

In the case that you want to issue your own job status polling requests, you can set JobPollingInterval to 0. This will just create and enqueue the job for you when you execute a SELECT query on a Leads or Activities table, returning the JobId in the result set.

Once a job has been enqueued, the status of the job can be polled by calling the GetExportJobStatus stored procedure.

The JobStatus value will be 'Complete' signaling that the job has finished processing and is ready to be downloaded. To finish executing your initial SELECT query, add the JobId filter to the WHERE clause of the initial SELECT statement. This query will download the file for the specified JobId and parse the result set.

Logic/Code Example (JobPollingInterval = 0):

SELECT JobId, Company, FirstName AS fn, LastName AS ln FROM Leads WHERE CreatedAt>='10/01/2017' AND CreatedAt<'10/31/2017'
# Retrieve the JobId value from the ResultSet (e.g. c4ebf745-b0e3-4bb8-bfc9-bd8472a28d35). Only one row is returned and JobId will be the only relevant value returned.

loop(desired time interval) {
  EXEC GetExportJobStatus @JobId='c4ebf745-b0e3-4bb8-bfc9-bd8472a28d35', @Type='Leads'
  if (JobStatus == 'Completed') break;
}

SELECT Company, FirstName AS fn, LastName AS ln FROM Leads WHERE CreatedAt>='10/01/2016' AND CreatedAt<'10/31/2016' AND JobId='c4ebf745-b0e3-4bb8-bfc9-bd8472a28d35'

Note: this property is only applicable when using the REST API.





Use Connection Pooling

Enables connection pooling.
Data Type

bool

Default Value

false

Remarks

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





User Id

The Marketo SOAP API User Id.
Data Type

string

Default Value

""

Remarks

The User Id is provided by Marketo and is used to authenticate to the Marketo SOAP Web service.





Verbosity

The verbosity level that determines the amount of detail included in the log file.
Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described below:

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

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





Views

Restrict the views reported to a subset of the available tables. For example: Views=ViewsA,ViewsB,ViewsC.
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. For example: For example: Views=ViewsA,ViewsB,ViewsC





TablesBack To Top

  1. Companies
  2. CustomActivities
  3. CustomObjects
  4. Leads
  5. NamedAccounts
  6. Opportunities
  7. OpportunityRoles
  8. Programs
  9. SalesPersons



Companies

Query Companies for a Marketo organization.

Table Specific Information

Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled. If sync is enabled, an error will be returned when attempting to query the table stating that the API is disabled.

Select

A filter must be specified when retrieving companies. Valid filters are any searchable columns which include Id, ExternalCompanyId, ExternalSalesPersonId, or Company.

SELECT * FROM Companies WHERE ExternalCompanyId='CData'



Columns

Name Type ReadOnly Filterable Description
Id [KEY] String True True

The unique, Marketo-assigned identifier of the company.

ExternalCompanyId String False True

The external Id of the company.

AnnualRevenue Double False

The annual revenue of the company.

BillingCity String False

The billing ciy of the company.

BillingCountry String False

The billing country of the company.

BillingState String False

The billing state of the company.

BillingStreet String False

The billing street of the company.

Company String False True

The name of the company.

CompanyNotes String False

Notes about the company.

ExternalSalesPersonId String False True

The external sales person Id associated with the company.

Industry String False

The industry of the company.

MainPhone String False

The main phone number of the company.

NumberOfEmployees Integer False

The number of employees at the company.

SICCode String False

The SIC Code of the company.

Site String False

The site of the company.

Website String False

The web site of the company.

CreatedAt Datetime True

The date and time the company was created.

UpdatedAt Datetime True

The date and time the company was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String

An input used internally to determine whether to get the next page of results.





CustomActivities

Query Custom Activities for a Marketo organization.

Table Specific Information
Each custom activity contained within your Marketo organization will be returned as it's own table. Each table name will be prefixed with 'Activity_' followed by the name of your custom activity.
Select

Custom activities can be retrieved by performing a SELECT query on the custom activity table.

SELECT * FROM Activity_MyCustomActivity



Columns

Name Type ReadOnly Filterable Description
ActivityId [KEY] String True

The unique Id of the activity.

LeadId String True True

The unique Id of the lead associated with the activity.

ActivityDate Datetime True True

The date and time the lead was added to the list. Can be used as a filter to specify the starting date and time to retrieve all activities on or after the specified date.

PrimaryAttribute String True

The primary field Id

PrimaryAttributeValue String True

The primary field value.

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

A List Id used to retrieve actvities for all leads contained within the specified list.

rows@next String

An input used internally to determine whether to get the next page of results.





CustomObjects

Create, update, delete, and query custom objects for a Marketo organization.

Table Specific Information
Each custom object contained within your Marketo organization will be returned as it's own table. Each table name will be prefixed with 'CustomObject_' followed by the name of your custom object.
Select

The Marketo REST API requires that a filter be specified to retrieve custom objects. The filter must contain at least one column that is the Key, a dedupeField, or a column that is searchable. Only the '=' operator is supported on these filter types. Other filters can be specified in addition to this but at least one of the previously mentioned filters must be specified. All filterable columns allow multiple values to be specified by using the IN operator or the OR logical operator.

Response time from the server can be improved by identifying only the rows and columns you want to retrieve.

SELECT Make, Model, Year, Color FROM CustomObject_MyCustomBikeObject WHERE VIN='12345'



Columns

Name Type ReadOnly Filterable Description
MarketoGUID [KEY] String True

The unique, Marketo-assigned identifier of the custom object.

CreatedAt Datetime False

The datetime the custom object was created.

UpdatedAt Datetime False

The datetime the custom object was updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String

An input used internally to determine whether to get the next page of results.





Leads

Create, update, delete, and query Leads for a Marketo organization.

Table Specific Information
Select

All columns must be specified using the '=' operator. All filterable columns allow multiple values to be specified by using the IN operator or the OR logical operator.

Response time from the server can be improved by identifying only the rows and columns you want to retrieve.

SELECT Id, FirstName, LastName FROM Leads WHERE Id IN ('1','2','5','10')

If a filter is not specified, the Activities_NewLead table will be queried to retrieve a list of Lead Ids. Once the Lead Ids have been compiled, the Leads table will be queried using the compiled list of Lead Ids. The 'CreatedAt' column can be used as a filter to specify the created datetime range of Leads to retrieve. When the '>' or '>=' operator is specified, the datetime value will be submitted in the Activities_NewLead table request. Note that this requires additional API calls and will at least double the amount of API calls made as one Activities_NewLead request must be made for each Leads request made. The maximum batch size per request for the REST API is 300, so to get a rough estimate of the number of API calls required, the following formula can be used: (Total Number of Leads / 300) * 2

The 'UpdatedAt' column can also be used as a filter to specify the updated datetime range of Leads to retrieve. When specified, the Activities_LeadChanges table will be queried to retrieve a list of Lead Ids. Once the Lead Ids have been compiled, the Leads table will be queried using the compiled list of Lead Ids. When the '>' or '>=' operator is specified, the datetime value will be submitted in the Activities_LeadChanges table request. Note that this requires additional API calls and will at least double the amount of API calls made as one Activities_LeadChanges request must be made for each Leads request made. In most cases, the total API calls will more than double as individual values for a Lead are returned as a record). Thus to get a full list of Lead Ids, multiple Activities_LeadChanges requests may need to be made. The maximum batch size per request for the REST API is 300, so to get a minimum estimate of the number of API calls required, the following formula can be used: (Total Number of Leads / 300) * 2

Alternatively, the SOAP API can be used to to retrieve a list of Lead Ids by setting "UseSOAPForLeadIds=True" in the 'Other' property. When specified the SOAP API will be used (provided the SOAP connection details are specified) to compile a list of Lead Ids which will then be used as a filter for the REST API. Note that the SOAP API is significantly slower than the REST API, although this hybrid approach is faster than using just the SOAP API by itself. The maximum batch size per request for the SOAP API is 1000, so to get a minimum estimate of the number of API calls required, the following formula can be used: (Total Number of Leads / 1000) + (Total Number of Leads / 300)

To bypass utilizing multiple API calls and for the best performance, create a static list of Leads within Marketo and then specify the ListId to retrieve them.


Columns

Name Type ReadOnly Filterable Description
Id [KEY] String True True

The unique, Marketo-assigned identifier of the account.

Email String False True

The lead's email address.

Salutation String False

The lead's salutation.

FirstName String False

The lead's first name.

MiddleName String False

The lead's middle name.

LastName String False

The lead's last name.

DateOfBirth Date False

The lead's date of birth.

Title String False

The lead's job title.

Address String False

The lead's street address.

City String False

The lead's city.

State String False

The lead's state.

PostalCode String False

The lead's ZIP/postal code.

Country String False

The lead's country.

Website String False

The lead's website.

Phone String False

The lead's phone number.

MobilePhone String False

The lead's mobile phone number.

Fax String False

The lead's fax number.

Company String False

The name of the lead's company.

MainPhone String False

The phone number of the lead's company.

SICCode String False

The SIC (Standard Industrial Classification) code of the lead's company.

Site String False

The site of the lead's company.

BillingStreet String False

The billing street address of the lead's company.

BillingCity String False

The billing city of the lead's company.

BillingState String False

The billing state of the lead's company.

BillingPostalCode String False

The billing ZIP/postal code of the lead's company.

BillingCountry String False

The billing country of the lead's company.

NumberOfEmployees Integer False

The number of employees at the lead's company.

Industry String False

The industry of the lead's company.

Department String False

The lead's deparment.

AnnualRevenue Double False

The annual revenue generated at the lead's company.

AnonymousIP String False

The IP address of the lead if it is anonymous.

Unsubscribed Boolean False

Determines whether the lead is unsubscribed.

UnsubscribedReason String False

The reason why the lead has unsubscribed.

EmailInvalid Boolean False

Identifies whether the lead's email address is invalid.

EmailInvalidCause String False

The reason why the lead's email address is invalid.

DoNotCall Boolean False

Identifies whether the lead is on the 'Do Not Call' list.

DoNotCallReason String False

The reason why the lead is on the 'Do Not Call' list.

PersonType String False

The type of person the current record is, such as a contact.

IsAnonymous Boolean True

Identifies whether the lead is anonymous or not.

IsLead Boolean False

Identifies whether the person is a lead or not.

LeadRole String False

The lead's role.

LeadSource String False

The lead's source.

LeadStatus String False

The lead's current status.

LeadScore Integer False

The lead's score.

Rating String False

The lead's rating.

Urgency Double True

The lead's urgency.

Priority Integer True

The lead's priority.

RelativeScore Integer True

The lead's relative score.

OriginalSourceType String True

The original source type where the lead originated from.

OriginalSourceInfo String True

Information about the original source of the lead.

RegistrationSourceType String False

The original source type where the lead originated from.

RegistrationSourceInfo String False

Information about the original source of the lead.

CreatedAt Datetime True True

The date the lead was created.

UpdatedAt Datetime True True

The date the lead was last updated.

Cookies String False True

The cookies associated with the lead.

AcquisitionProgramId String False

The Id of the program in which the lead was acquired.

Gender String False

The lead's social gender.

TotalReferredVisits Integer True

The lead's total social referred visits.

TotalReferredEnrollments Integer True

The lead's total social referred enrollments.

LastReferredEnrollment Datetime False

The lead's last social referred enrollment.

LastReferredVisit Datetime False

The lead's last social referred visit.

SyndicationId String False

The lead's social syndication Id.

FacebookDisplayName String False

The lead's Facebook display name.

FacebookId String False True

The lead's Facebook Id.

FacebookPhotoURL String False

The lead's Facebook photo URL.

FacebookProfileURL String False

The lead's Facebook profile URL.

FacebookReach Integer False

The lead's Facebook reach.

FacebookReferredEnrollments Integer False

The lead's Facebook referred enrollments.

FacebookReferredVisits Integer False

The lead's Facebook referred visits.

LinkedInDisplayName String False True

The lead's LinkedIn display name.

LinkedInId String False

The lead's LinkedIn Id.

LinkedInPhotoURL String False

The lead's LinkedIn photo URL.

LinkedInProfileURL String False

The lead's LinkedIn profile URL.

LinkedInReach Integer False

The lead's LinkedIn reach.

LinkedInReferredEnrollments Integer False

The lead's LinkedIn referred enrollments.

LinkedInReferredVisits Integer False

The lead's LinkedIn referred visits.

TwitterDisplayName String False

The lead's Twitter display name.

TwitterId String False

The lead's Twitter Id.

TwitterPhotoURL String False

The lead's Twitter photo URL.

TwitterProfileURL String False

The lead's Twitter profile URL.

TwitterReach Integer False

The lead's Twitter reach.

TwitterReferredEnrollments Integer False

The lead's Twitter referred enrollments.

TwitterReferredVisits Integer False

The lead's Twitter referred visits.

ListId String True True

A List Id used to retrieve all leads contained within the specified list. This is a filter only field made available to enhance filtering capabilities.

ProgramId String True True

A Program Id used to retrieve all leads associated with the specified program. This is a filter only field made available to enhance filtering capabilities.

LookupField String True True

Used to specify the field used to find duplicate leads. Only used when performing an INSERT or UPDATE. Available values are: id (default), cookie, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, and custom fields. This is a filter only field made available to enhance filtering capabilities.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String

An input used internally to determine whether to get the next page of results.





NamedAccounts

Query Named Accounts for a Marketo organization.

Table Specific Information
Select

A filter must be specified when retrieving named accounts. Valid filters are any searchable columns which include MarketoGUID, Name, Industry, State, City, etc.

SELECT * FROM NamedAccounts WHERE Name='MyAccount'



Columns

Name Type ReadOnly Filterable Description
MarketoGUID [KEY] String True True

The unique, Marketo-assigned identifier of the named account.

Name String False True

The name of the account.

AccountOwnerId Integer False True

The owner id of the account.

AnnualRevenue Double False True

The annual revenue for the account.

City String False True

The city for the account.

Country String False True

The country for the account.

DomainName String False True

The name of the domain for the account.

Industry String False True

The industry for the account.

LogoURL String False True

The URL to the logo for the account.

MembershipCount Integer True True

The number of members for the account.

NumberOfEmployees Integer False True

The number of employees for the account.

OpptyAmount Double True True

The total amount of opportunities for the account.

OpptyCount Integer True True

The total number of opportunities for the account.

SICCode String False True

The SIC Code for the account.

State String False True

The state for the account.

CreatedAt Datetime True

The date and time the named account was created.

UpdatedAt Datetime True

The date and time the named account was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String

An input used internally to determine whether to get the next page of results.





Opportunities

Query Opportunities for a Marketo organization.

Table Specific Information

Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled. If sync is enabled, an error will be returned when attempting to query the table stating that the API is disabled.

Select

A filter must be specified when retrieving opportunities. Valid filters are any searchable columns which include MarketoGUID, ExternalOpportunityId, ExternalCompanyId, or ExternalSalesPersonId.

SELECT * FROM Opportunities WHERE ExternalOpportunityId='CDATA1'



Columns

Name Type ReadOnly Filterable Description
MarketoGUID [KEY] String True True

The unique, Marketo-assigned identifier of the opportunity.

ExternalOpportunityId String False True

The external Id of the opportunity.

Amount Double False

The description of the opportunity.

CloseDate Datetime False

The date and time the opportunity was closed.

Description String False

The description of the opportunity.

ExpectedRevenue Double False

The expected revenue of the opportunity.

ExternalCompanyId String False True

The external company Id of the opportunity.

ExternalCreatedDate Datetime False

The external date and time the opportunity was created.

ExternalSalesPersonId String False True

The external sales person Id of the opportunity.

Fiscal String False

The fiscal of the opportunity.

FiscalQuarter String False

The fiscal quarter of the opportunity.

FiscalYear String False

The fiscal year of the opportunity.

ForecastCategoryName String False

The forecast category name of the opportunity.

IsClosed Boolean False

Specifies whether the opportunity is closed.

IsWon Boolean False

Specifies whether the opportunity was won.

LastActivityDate Datetime False

The date and time the last activity occurred on the opportunity.

LeadSource String False

The lead source of the opportunity.

Name String False

The name of the opportunity.

NextStep String False

The next step of the opportunity.

Probability Integer False

The probability of the opportunity.

Quantity Double False

The quantity of the opportunity.

Stage Double False

The stage of the opportunity.

Type Double False

The type of the opportunity.

CreatedAt Datetime True

The date and time the opportunity was created.

UpdatedAt Datetime True

The date and time the opportunity was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String

An input used internally to determine whether to get the next page of results.





OpportunityRoles

Query Opportunity Roles for a Marketo organization.

Table Specific Information

Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled. If sync is enabled, an error will be returned when attempting to query the table stating that the API is disabled.

Select

A filter must be specified when retrieving opportunities. Valid filters are any searchable columns which include MarketoGUID and a combination of ExternalOpportunityId, LeadId, and Role.

SELECT * FROM OpportunityRoles WHERE ExternalOpportunityId='Opportunity1' AND LeadId='1' AND Role='MyRole'



Columns

Name Type ReadOnly Filterable Description
MarketoGUID [KEY] String True True

The unique, Marketo-assigned identifier of the opportunity role.

ExternalOpportunityId String False True

The external Id of the opportunity.

ExternalCreatedDate Datetime False

The external date and time the opportunity role was created.

IsPrimary Boolean False

Specifies whether the opportunity role is the primary role on the opportunity.

LeadId String False True

The lead Id associated with the opportunity role.

Role String False True

The role associated with the opportunity.

CreatedAt Datetime True

The date and time the opportunity role was created.

UpdatedAt Datetime True

The date and time the opportunity role was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String

An input used internally to determine whether to get the next page of results.





Programs

Query Programs for a Marketo organization.

Table Specific Information
Select

Note: Tag and Cost columns are not returned when browsing all Programs (such as performing a SELECT * query). These columns are only returned when filtering by a specific Program Id or Name.

Tag and Cost Columns are not returned in this case.

SELECT * FROM Programs

Tag and Cost Columns are returned in this case.

SELECT * FROM Programs WHERE Id='1001'



Columns

Name Type ReadOnly Filterable Description
Id [KEY] String True True

The unique, Marketo-assigned identifier of the program.

Name String False True

The name of the program.

Description String False

The description of the program.

Type String False

The program type.

Channel String False

The channel the program is associated with.

Workspace String False

The name of the workspace where the program is located.

Url String True

The URL reference to the program.

Status String False

The status of the program.

FolderType String False

The folder type that the program is contained in.

FolderId Integer False

The folder id that the program is contained in.

FolderName String False

The name of the folder the program is contained in.

TagTypes# String False True

A comma-separated list of tag types associated with the program. Each TagType has a value associated with it which is returned via the TagValue column.

TagValues# String False True

A comma-separated list of tag values. Each value corresponds to the type listed within the TagTypes column.

CostStartDates# String False

A comma-separated list of cost start dates. Each value corresponds to the costs and notes listed within the Costs and CostNotes columns.

Costs# String False

A comma-separated list of costs (integer values). Each value corresponds to the start dates and notes listed within the CostStartDates and CostNotes columns.

CostNotes# String False

A comma-separated list of cost notes. Each value corresponds to the costs and start dates listed within the Costs and CostStartDates columns.

CreatedAt Datetime True

The date and time the program was created.

UpdatedAt Datetime True

The date and time the program was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String

An input used internally to determine whether to get the next page of results.





SalesPersons

Query Sales Persons for a Marketo organization.

Table Specific Information
Select

A filter must be specified when retrieving companies. Valid filters are any searchable columns which include Id, ExternalSalesPersonId, or Email.

SELECT * FROM SalesPersons WHERE ExternalSalesPersonId='sales@cdata.com'



Columns

Name Type ReadOnly Filterable Description
Id [KEY] String True True

The unique, Marketo-assigned identifier of the sales person.

ExternalSalesPersonId String False True

The external Id of the sales person.

Email String False True

The email address of the sales person.

Fax String False

The fax number of the sales person.

FirstName String False

The first name of the sales person.

LastName String False

The last name of the sales person.

MobilePhone String False

The mobile phone number of the sales person.

Phone String False

The phone number of the sales person.

Title String False

The sales person's title.

CreatedAt Datetime True

The date and time the sales person was created.

UpdatedAt Datetime True

The date and time the sales person was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String

An input used internally to determine whether to get the next page of results.





ViewsBack To Top

  1. ActivityBulkExports
  2. Campaigns
  3. Channels
  4. Emails
  5. LeadBulkExports
  6. LeadPartitions
  7. Lists
  8. Tags



ActivityBulkExports

Returns a list of activity export jobs that were created in the past 7 days.

Columns

Name Type Filterable Description
ExportId [KEY] String Unique id of the export job.
ErrorMessage String The error message in case of
CreatedAt Datetime The date when the export request was created.
FileSize Integer The size of file in bytes. Thiscolumn will have a value only when status is 'Completed'.
FinishedAt Datetime The finish time of export job. This column will have a value only when status is 'Completed' or 'Failed'.
Format String The format of the file.
NumberOfRecords Integer The number of records in the export file. This column will have a value only when the status is 'Completed'.
QueuedAt String The queue time of the export job. This column will have a value only when 'Queued' status is reached.
StartedAt String The start time of the export job. This column will have a value only when 'Processing' status is reached.
Status String The status of the export.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String An input used internally to determine whether to get the next page of results.





Campaigns

Query Campaigns for a Marketo organization.

Columns

Name Type Filterable Description
Id [KEY] String True The unique, Marketo-assigned identifier of the campaign
Name String True The name of the campaign
Description String The description of the campaign
Type String The campaign type.
ProgramName String The name of the program associated with the campaign
WorkspaceName String The name of the workspace associated with the campaign
CreatedAt Datetime The date and time the campaign was created.
UpdatedAt Datetime The date and time the campaign was last updated.
Active Boolean Identifies whether the campaign is active.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String An input used internally to determine whether to get the next page of results.





Channels

Query Channels for a Marketo organization.

Columns

Name Type Filterable Description
Id [KEY] String The unique, Marketo-assigned identifier of the channel.
Name String True The name of the channel.
Description String The description of the channel.
ApplicableProgramType String The type of program that the channel is used for.
StatusName [KEY] String The progression status name of the channel.
StatusStep String The step number of each progression status used to sequence the order of the channel.
StatusDescription String The description of the progression status of the channel.
StatusHidden Boolean Specifies whether the progression status is hidden.
StatusSuccess Boolean Specifies whether the progression status results in a success.
CreatedAt Datetime The date and time the channel was created.
UpdatedAt Datetime The date and time the channel was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String An input used internally to determine whether to get the next page of results.





Emails

Query Emails for a Marketo organization.

Columns

Name Type Filterable Description
Id [KEY] String True The unique, Marketo-assigned identifier of the email.
Name String True The name of the email.
Description String The description of the email.
Subject String The email subject.
FromName String The from name.
FromEmail String The from email address.
ReplyEmail String The reply email address.
FolderId String The folder where the email is located.
FolderType String The folder where the email is located.
FolderName String The folder where the email is located.
Operational Boolean Identifies whether the email is operational.
TextOnly Boolean Identifies whether the email is text only.
PublishToMSI Boolean Identifies whether the email is published.
WebView Boolean Identifies whether the email is published.
Status String The status of the email.
Version String The version of the email.
AutoCopyToText Boolean Identifies whether the email is auto copied to text.
Template String The template associated with the email.
Workspace String The name of the workspace where the email is located.
CreatedAt Datetime The date and time the email was created.
UpdatedAt Datetime The date and time the email was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String An input used internally to determine whether to get the next page of results.





LeadBulkExports

Returns a list of lead export jobs that were created in the past 7 days.

Columns

Name Type Filterable Description
ExportId [KEY] String Unique id of the export job.
ErrorMessage String The error message in case of
CreatedAt Datetime The date when the export request was created.
FileSize Integer The size of file in bytes. This column will have a value only when status is 'Completed'.
FinishedAt Datetime The finish time of export job. This column will have a value only when status is 'Completed' or 'Failed'.
Format String The format of the file.
NumberOfRecords Integer The number of records in the export file. This will have a value only when the status is 'Completed'.
QueuedAt String The queue time of the export job. This column will have a value only when 'Queued' status is reached.
StartedAt String The start time of the export job. This column will have a value only when 'Processing' status is reached.
Status String The status of the export.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String An input used internally to determine whether to get the next page of results.





LeadPartitions

Query Lead Partitions for a Marketo organization.

Columns

Name Type Filterable Description
Id [KEY] String The unique, Marketo-assigned identifier of the lead partition.
Name String True The name of the partiton.
Description String The description of the partition.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String An input used internally to determine whether to get the next page of results.





Lists

Query Lists for a Marketo organization.

Columns

Name Type Filterable Description
Id [KEY] String True The unique, Marketo-assigned identifier of the list.
Name String True The name of the list.
Description String The description of the list.
ProgramName String The name of the program associated with the list.
WorkspaceName String The name of the workspace associated with the list.
CreatedAt Datetime The date and time the list was created.
UpdatedAt Datetime The date and time the list was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String An input used internally to determine whether to get the next page of results.





Tags

Query Tags for a Marketo organization.

Columns

Name Type Filterable Description
TagType [KEY] String True The name/type of the tag.
ApplicableProgramTypes String The types of program that the tag is used for.
Required Boolean The date and time the channel was created.
AllowableValues String The date and time the channel was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
rows@next String An input used internally to determine whether to get the next page of results.