Connecting to Outreach

For information on the available WHL files for supported environments, and how to install the appropriate file for your Python distribution, see Package Installation.

For information on the module to import, and how to configure the necessary connection properties in a connection string, see Establishing a Connection.

Other available connection properties can be used to configure other aspects of the connector capabilities.

Python Version Support

The CData Python Connector for Outreach can be installed and used in Python 3.10 or newer.

Outreach Version Support

The connector leverages version 2 (v2) of the Outreach API to enable bidirectional access to revenue management data from Outreach.

See Also

• Using the Connector: Establish connections and query Outreach through Python code.
• From SQLAlchemy: Use SQLAlchemy to establish a connection with dialect URL, and interact with Outreach data using mapped classes and Sessions.

Dependencies

The Python connectors require that Python 3.10 or newer be installed.

Installation

The CData Python Connector for Outreach is available as a WHL file for Windows, Linux, and Mac. Each connector is built using the Python 3.10 Stable ABI (indicated by the abi3 tag in the filename), so a single wheel supports any Python 3.10 or newer installation — there is no need to match your exact Python minor version. Use the "pip install" command with the appropriate WHL file for your platform.

Windows:

pip install cdata_outreach_connector-26.0.9655-cp310-abi3-win_amd64.whl

Linux:

pip install cdata_outreach_connector-26.0.9655-cp310-abi3-linux_x86_64.whl

macOS:

pip install cdata_outreach_connector-26.0.9655-cp310-abi3-macosx_12_0_arm64.whl

The macOS wheel supports arm64 (Apple Silicon) architectures only on macOS 12 and newer.

Regardless of the environment, certain distributions might require that the "pip3 install" command be used instead, to differentiate from a Python 2 distribution that might exist already. After installation, confirm whether the connector is successfully installed by running the "pip list" command. If "cdata_outreach_connector" is present in the list output by the command, then the installation was successful.

Upgrading

When upgrading, "pip install" does not automatically clean up old JRE files. To avoid leftover files that could cause JVM errors, uninstall the previous version before installing the new one.

Licensing

After the installation is complete, a separate step is needed to activate a license for the connector. Among the CData assets in the distribution's site packages, there is an install-license tool that activates this license. From within the distribution's site-packages folder, after navigating to the "cdata/installlic_outreach" folder, simply use a command like the below to activate the license. Omitting the <key> argument activates a trial license:

• Windows:
  

  ./install-license.exe <key>

• Linux / Mac:
  

  ./install-license.sh <key>

Sometimes, file access issues may cause pip to install the connector in a fallback file path that is not the python distribution's main or primary site-packages location. This can make it difficult to find where the connector was installed, and from there, the license activator. In that event, this python script below will print out the full file path of the connector's native file. This file will be stored in the mentioned cdata folder, from which the installlic_outreach folder is trivial to find:

import os
import cdata.outreach
path = os.path.abspath(cdata.outreach.__file__)
print(path)

Uninstallation

If the connector needs to be uninstalled for any reason, do so by running the pip uninstall command, as in the example below:

pip uninstall cdata-outreach-connector

The objects available within our connector are accessible from the "cdata.outreach" module. To use the module's objects directly:

1. Import the module as follows:
   

   import cdata.outreach as mod

2. To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
   

   mod.connect("InitiateOAuth=GETANDREFRESH;")

Connecting to Outreach

Outreach supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Outreach from three common authentication flows:

• Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
• Web: access to data via a shared website. Authenticated via custom OAuth only.
• Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to obtain custom OAuth information, and why you might want to create a custom connection even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Outreach, see Connection.

Desktop Applications

CData provides an embedded OAuth application that simplifies authentication at the desktop. You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Outreach console. For information about how to obtain the needed configuration information, see Creating a Custom OAuth Application.

Before you connect, set the following variables:

• InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• Custom OAuth applications only:
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
  • CallbackURL: The redirect URI defined when you registered your custom OAuth application.

When you connect, the connector opens Outreach's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector completes the OAuth process:

1. The connector obtains an access token from Outreach and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Web Applications

Authenticating via the Web requires you to obtain the needed configuration information, as described in Creating a Custom OAuth Application. You can then use the connector to get and manage the OAuth token values.

This section describes how to get the OAuth access token, how to have the driver refresh the OAuth access token automatically, and how to refresh the OAuth access token manually.

Get the OAuth access token:

1. Set the following connection properties to obtain the OAuthAccessToken:
   • OAuthClientId: The client Id in your application settings.
   • OAuthClientSecret: The client secret in your application settings.

2. Call stored procedures to complete the OAuth exchange:
   • Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Redirect URI you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
   • Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
   • Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you obtain the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic refresh of the OAuth access token:

To have the connector automatically refresh the OAuth access token, do the following:

1. The first time you connect to data, set the following connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your application settings.
   • OAuthClientSecret: The client secret in your application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the connector to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set the following connection properties:
   • OAuthClientId: The Client Id in your application settings.
   • OAuthClientSecret: The Client Secret in your application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

• Option 1: Obtain the OAuthVerifier value.
• Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Do the following:

1. Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

   If you are using the embedded OAuth application, call the GetOAuthAuthorizationURL stored procedure. Open the URL returned by the stored procedure in a browser.

   If you are using a custom OAuth application, set the following properties:

   • InitiateOAuth: OFF.
   • OAuthClientId: The client Id assigned when you registered your application.
   • OAuthClientSecret: The client secret assigned when you registered your application.

2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

   Copy this URL and paste it into a new browser tab.

3. Log in and grant permissions to the connector. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

4. Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, set the following connection properties to obtain the OAuth authentication values:

   • InitiateOAuth: REFRESH.
   • OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
   • OAuthSettingsLocation: persist the encrypted OAuth authentication values to the specified file.
   • Custom OAuth applications only:
     • OAuthClientId: The client Id in your custom OAuth application settings.
     • OAuthClientSecret: The client secret in the custom OAuth application settings.

5. Test the connection to generate the OAuth settings file.

6. After you re-set the following properties, you are ready to connect:

   • InitiateOAuth: REFRESH.
   • OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the connector.
   • Custom OAuth applications only:
     • OAuthClientId: The client Id assigned when you registered your application.
     • OAuthClientSecret: The client secret assigned when you registered your application.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set the following connection properties:

• InitiateOAuth: REFRESH
• OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the connector.
• Custom OAuth applications only:
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Java Native Interface (JNI) is a standard programming interface for writing Java native methods and embedding the Java virtual machine into native applications.

The connector leverages the JNI for improved performance on Mac and Linux.

Configure the Config INI File

The Linux and Mac editions of the Outreach python connector are configured with an ini file. This file is used to set several parameters, including JNI behavior. This file is to be located in:

{path_to_distribution_site-packages}/cdata/config.ini

Ensure that any configuration properties you set in the ini file fall under the following section name (adjust the 311 number if you are using an different python version from 3.11):

• For Linux:
  

  [outreach.cpython-311-x86_64-linux-gnu.so]

• For Mac:
  

  [outreach.cpython-311-darwin.so]

Configure the JNI connector's behavior by editing the properties in the connector's config.ini file. The connector can be configured as follows:

• LOGFILE: Set this the same way as the CDATA_LOGFILE envrionment variable below.
• JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
• CLASS_PATH: Use a colon-separated list to configure the paths to the third-party jar libraries.

Configure Environment Variables

Additionally, set the following environment variables:

• CDATA_JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
• CDATA_JVM_OPTIONS: Place JVM options here.
• CDATA_LOGFILE: Set this in the following scheme: <SCHEME>://<TAG>[|<LEVEL>]
  • SCHEME: The options are STDOUT, FILE.
    • STDOUT: Both the native wrapper and odbc core log into stdout. The Logfile and Verbosity properties can override the behavior of ODBC core.
    • FILE: The native wrapper logs into <FILENAME> while the odbc core logs into <FILENAME>.driver.log. The Logfile and Verbosity properties can override the behavior of ODBC core.
  • TAG
    • For STDOUT, set this to 1. For FILE, set this to the filename.
  • LEVEL
    • Set to one of: FATAL | ERROR | WARNING | INFO | DEBUG

The following are some examples of this syntax:

• STDOUT://1|DEBUG
• FILE:///tmp/my_py.log|DEBUG

Custom Logger

The Python connector supports a custom logging mechanism for redirecting log output to any destination, such as a cloud storage service or logging framework. Use setCustomLoggerFactory() to register a factory function that creates a logger instance for each connection.

The factory function receives the context string from the Logfile connection property (the portion after CUSTOM://) and must return an object with a writeLog(verbosity, message) method.

To enable custom logging:

1. Call setCustomLoggerFactory() with your factory function before opening connections.
2. Set Logfile to CUSTOM:// followed by a context string to identify the connection.
3. Set Verbosity to the desired log level.

The following example demonstrates a custom logger factory that creates a separate logger instance per connection:

import cdata.outreach as mod
import time

class MyLogger:
    def __init__(self, loggerId):
        self.loggerId = loggerId
    def writeLog(self, verbosity, message):
        print("[MyLogger " + self.loggerId + "] " + message)

def createLogger(context):
    return MyLogger(context[len("MyLoggerId="):])

mod.setCustomLoggerFactory(createLogger)

conn1 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=1;Verbosity=2;")
# do something with conn1
time.sleep(1)  # Wait for logs to flush from conn1

conn2 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=2;Verbosity=2;")
# do something with conn2
time.sleep(1)  # Wait for logs to flush from conn2

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Outreach via a desktop application or a headless machine. If you want to use the embedded OAuth application, all you need to do to connect is to:

• set AuthScheme to OAuth,
• get and set the OAuthAccessToken, and
• set the necessary configuration parameters.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Outreach".)

However, if you need to connect to Outreach via the Web, you will have to create a custom OAuth connection. In fact, since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway. Custom OAuth applications are useful if you want to:

• control branding of the authentication dialog;
• control the redirect URI that the application redirects the user to after the user authenticates; or
• customize the permissions that you are requesting from the user.

Procedure

To obtain the OAuth client credentials you need to make a custom OAuth connection, including OAuthClientId and OAuthClientSecret, contact Outreach directly via platform@outreach.io.

After you obtain this information, use it to configure the connection variables to connect and authenticate to Outreach, as described in "Connecting to Outreach".

General Changes

Date	Version	Source	Category	Type	Description
2026-05-27	26.0.9643	General	Connection	Removed	Removed the deprecated ReplaceInvalidTypesWithNull connection property. Use the ReplaceInvalidValuesWithNull property instead.
2026-05-22	26.0.9638	Python		Removed	Remove support for Intel x64 architecture on macOS
2026-05-09	26.0.9625	Outreach	Data Model	Changed	In the Teams view, renamed the following columns and changed their data type from integer to string: ContentCategoriesId to ContentCategoriesData UsersId to UsersData In the Templates view, renamed the following columns and changed their data type from integer to string: ContentCategoryMembershipsId to ContentCategoryMembershipsData RecipientsId to RecipientsData In the Users view, renamed the following columns: RecipientsId to RecipientsData TeamsId to TeamsData
2026-05-07	26.0.9623	General	Data Model	Added	Added the ColumnCapabilities column to the sys_tablecolumns system table. This column is a bit mask denoting the column's write capabilities.
2026-05-07	26.0.9623	Python		Changed	Updated embedded JRE to jre-17.0.19+10 (Linux x64 / MacOs x64).
2026-04-21	26.0.9607	Outreach	Data Model	Removed	Removed the OwnerId and OwnerType columns from the ContentCategoryMemberships view. Removed the UserId column from the MailAliases view. Removed the OwnerId and OwnerType columns from the Mailbox view. Removed the ContentCategoryMembershipsId column from the Users view.
2026-04-15	26.0.9601	General	Query Exec	Changed	String comparisons using GREATER, LESS, and CONTAINS operators are now case-insensitive by default.
2026-04-01	26.0.9587	Outreach		Removed	Removed the BatchSize connection property.
2026-01-13	25.0.9509	General		Added	Added support for the REGEXP_REPLACE() string function.
2025-12-21	25.0.9486	Python		Added	Added support for custom loggers in Python connectors on Linux and macOS.
2025-12-05	25.0.9470	General		Added	Added support for the INSERT INTO SELECT statement, with driver-side execution for providers that do not support the operation natively.
2025-10-30	25.0.9434	Python		Changed	Updated embedded JRE to jre-17.0.17+10 (Linux x64 / MacOs x64).
2025-10-06	25.0.9410	General		Added	Support for parsing datetime formats using ".S" and ",S" for milliseconds and nanoseconds.
2025-09-12	25.0.9386	General		Added	Added the IsInsertable, IsUpdateable, and IsDeleteable columns to the sys_tables table.
2025-09-10	25.0.9384	General		Changed	All columns in statically defined Views are now reported as read-only.
2025-09-03	25.0.9377	General		Changed	Corrected the behavior when IN criteria with NULL values are used in the projection part. It now returns NULL instead of 0. For example, "NULL IN (1,2)" returns "NULL".
2025-09-01	25.0.9375	General		Added	Added support for using the CAST function with infinity values. This function can cast "inf" and "-inf" to DOUBLE, FLOAT, or REAL.
2025-08-21	25.0.9364	General		Changed	Report behavior change: Fixed inconsistent string value comparisons in non-table queries. For example, "SELECT 'A' = 'a'" previously returned false, but it now returns true.
2025-08-13	25.0.9356	General		Changed	Changed the maximum number of pages held in memory from 15 to 5 for the page providers to decrease heap usage.
2025-07-25	25.0.9337	Outreach		Changed	Changed the data type of the ExternalCreatedAt column from string to datetime in the Opportunities view.
2025-07-11	25.0.9323	Outreach		Added	Added support for the Scope connection property.
2025-07-07	25.0.9319	Python		Removed	Removed the 32-bit version of Windows Python.
2025-07-02	25.0.9314	Python		Removed	Removed support for Python 3.9.
2025-06-25	25.0.9307	General		Removed	Removed the "ADLS Gen 1" value from the ConnectionType property.
2025-06-25	25.0.9307	Python		Added	Added support for Python 3.13 in Windows, Linux, and Mac editions.
2025-06-25	25.0.9307	Python		Removed	Removed support for Python 3.8 as it is no longer supported.
2025-06-20	25.0.9302	General		Added	Created the following functions: TEXT_ENCODE: encodes a string into a different charset (UTF8 → UTF7 and returns a binary array as the result). TEXT_DECODE: takes a binary array and decodes it back into a string when provided the charset. BASE64_ENCODE: takes a binary array and encodes it as a base64 string (varchar). BASE64_DECODE: takes a base 64-encoded string and decodes it into a binary array.
2025-06-18	25.0.9300	General		Changed	The internal code for exception handling has been refactored. Exception messages returned during certain error conditions may now have different wording or formatting.
2025-05-27	25.0.9278	General		Removed	Removed the "Proprietary" enum option from ProxyAuthscheme.
2025-05-12	25.0.9263	Python		Changed	Updated embedded JRE to jre-17.0.15+6 (Linux x64 / MacOS x64) and jre-17.0.15+6 (MacOS aarch64).
2025-02-15	24.0.9177	General		Added	Added support for converting unsigned integer types to the nearest signed data type that has enough precision to hold the unsigned value.This is done for JDBC only because it does not have support for unsigned data types.
2024-12-16	24.0.9116	Outreach		Removed	Removed SpecialProfileExists from the stored procedure because it is non-functional.
2024-12-05	24.0.9105	Outreach		Changed	Changed the data type to datetime for the data column, because the API returns data in this format.
2024-11-28	24.0.9098	Outreach		Changed	Changed the data type of the TouchedAt column from string to datetime in the Accounts and Opportunities views to enable proper usage of comparison operators. Changed the data type of the EngagedAt column from string to datetime in the Prospects view to enable proper usage of comparison operators.
2024-11-27	24.0.9097	General		Added	Added ThreadId to LogModule output. Logfile lines now include the Thread ID associated with the action being performed.
2024-11-27	24.0.9097	Outreach		Removed	Removed MailboxId, ProfileId, RecipientsId, RoleId, TeamsId, and UpdaterId from the UserDuties view. These are non-functional input parameters added to the RSD.
2024-07-08	24.0.8955	Outreach		Removed	Removed the Audit table.
2024-06-05	24.0.8922	Python		Added	Added support for Python 3.12.
2024-05-09	24.0.8895	General		Changed	The ROUND function previously did not accept negative precision values. That feature has now been restored.
2024-03-15	23.0.8840	General		Added	Created a new SQL function called STRING_COMPARE that provides java's String.compare() ability to SQL queries. Returns a number representative of the compared value of two strings
2023-11-29	23.0.8733	General		Changed	The ROUND function doesn't accept the negative precision values anymore.
2023-11-29	23.0.8733	General		Changed	The returning types of the FDMonth, FDQuarter, FDWeek, LDMonth, LDQuarter, LDWeek functions are changed from Timestamp to Date. The return type of the ABS function will be consistent with the parameter value type.
2023-11-28	23.0.8732	General		Added	Added the HMACSHA256 formatter to allow for secrets to be decoded if it is in base64 format
2023-08-29	23.0.8641	Python		Added	Added support for SQLAlchemy 2.0.
2023-07-19	23.0.8600	Outreach		Removed	Removed UpdateContentCategories SP as api deprecated this endpoint. Removed server-side filter support on Relationship column as api deprecated the filter supports.
2023-06-20	23.0.8571	General		Added	Added the new sys_lastresultinfo system table.
2023-05-19	23.0.8539	Python		Added	Added support for Python 3.11 on Windows, Linux and Mac.
2023-05-16	23.0.8536	Python		Removed	Removed support for Python 3.7 on Windows and Linux
2023-04-25	23.0.8515	General		Removed	Removed support for the SELECT INTO CSV statement. The core code doesn't support it anymore.
2022-12-14	22.0.8383	General		Changed	Added the Default column to the sys_procedureparameters table.
2022-11-15	22.0.8354	Python		Changed	Updated embedded JRE to jre8u345-b01(Linux x64 / MacOS x64) and jre-17.0.5+8(MacOS aarch64).
2022-09-30	22.0.8308	General		Changed	Added the IsPath column to the sys_procedureparameters table.
2022-05-18	22.0.8173	Python		Added	Added support for Python 3.10 on Windows, Linux, and Mac Added support for Python 3.9 on Mac Added support for Mac M1
2022-05-18	22.0.8173	Python		Removed	Removed support for Python 3.6 on Windows and Linux
2021-09-02	21.0.7915	General		Added	Added support for the STRING_SPLIT table-valued function in the CROSS APPLY clause.
2021-08-07	21.0.7889	General		Changed	Added the KeySeq column to the sys_foreignkeys table.
2021-08-06	21.0.7888	General		Changed	Added the new sys_primarykeys system table.
2021-07-23	21.0.7874	General		Changed	Updated the Literal Function Names for relative date/datetime functions. Previously, relative date/datetime functions resolved to a different value when used in the projection as opposed to the predicate. For example: SELECT LAST_MONTH() AS lm, Col FROM Table WHERE Col > LAST_MONTH(). Formerly, the two LAST_MONTH() methods would resolve to different datetimes. Now, they will match. As a replacement for the previous behavior, the relative date/datetime functions in the criteria may have an 'L' appended to them. For example: WHERE col > L_LAST_MONTH(). This will continue to resolve to the same values that were previously calculated in the criteria. Note that the "L_" prefix will only work in the predicate - it not available for the projection.
2021-04-23	21.0.7783	General		Changed	Updated how display sizes are determined for varchar primary key and foreign key columns so they will match the reported length of the column.
2021-04-16	21.0.7776	General		Changed	Reduced the length to 255 for varchar primary key and foreign key columns.
2021-04-16	21.0.7776	General		Changed	Updated implicit and metadata caching to improve performance and support for multiple connections. Old metadata caches are not compatible - you need to generate new metadata caches if you are currently using CacheMetadata.
2021-04-16	21.0.7776	General		Changed	Updated index naming convention to avoid duplicates.

This section provides a walk-through for writing Outreach data access code in Python script.

For more information on the available data source entities and how to query them with SQL, see Data Model. For the SQL syntax, see SQL Compliance.

Connecting from Code

For information on how to deploy the connector and configure the connection to Outreach, see Package Installation and Establishing a Connection.

For information on how to connect with the outreach.connector module and its related classes, see Connecting.

Executing SQL

The connection's cursor object is used to directly execute SQL queries. For information on how to execute SELECT statements and process the returned result sets, see Querying Data.

Executing Stored Procedures

You can call stored procedures by using the EXECUTE statement. For further information, see Calling Stored Procedures.

Connecting with the cdata.outreach Module:

The connector's module is used directly to establish a connection with the data source. It does this by using a connection string as its argument. For example:

import cdata.outreach as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")

Once the connection is created, you can use it to execute subsequent SQL queries.

After connecting as described in Connecting, you can use the open connection to execute SQL statements.

Executing Queries

To execute SQL statements that return data, use the execute() method. Once a query is executed, the result set is fetched from the cursor. This result set can then be iterated over to process the records individually.

For example:

cur = conn.execute("SELECT Id, Column1 FROM SampleTable_1")
rs = cur.fetchall()
for row in rs:
	print(row)

Parameterized Queries

Various Python collections, such as arrays and tuples, can act as additional arguments for the execute() method. This enables you to parameterize the queries executed and help to prevent SQL Injection.

For example:

cmd = "SELECT Id, Column1 FROM SampleTable_1 WHERE Column2 = ?"
params = ["Bob"]
cur = conn.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

You can execute stored procedures using either the execute() or callproc() method of the connection.

Calling Stored Procedures Using Execute()

When you call stored procedures by issuing EXECUTE commands, the stored procedure arguments are parameterized. For example:

cmd = "EXECUTE SampleProcedure Id = ?"
params = ["7"]
conn.execute(cmd, params)

Calling Stored Procedures Using Callproc()

When you call stored procedured by issuing the callproc() method, the stored procedure arguments are a procedure name and a list of parameters. For example:

cur = conn.cursor()
params = ["7"]
cur.callproc("SampleProcedure", params)

The connector is integrated with other tools and packages within Python.

Python Integration Guides

The following sections show how to create and use connections with the connector in common packages in Python:

• From SQLAlchemy
• From Pandas
• From Matplotlib
• From Petl

Complete List of Outreach Integration Quickstarts

For information on connecting from other applications, see Outreach integration guides.

The CData Python Connector for Outreach includes a Dialect class that enables integration with SQLAlchemy. Bear in mind that several aspects of connector functionality are not currently supported in SQLAlchemy 2.0 or above. If necessary, downgrade SQLAlchemy to version 1.4 or 1.3 before using this connector.

The following sections detail various aspects of this integration:

Connecting From SQLAlchemy

To construct a URL with which SQLAlchemy loads and uses the appropriate connector automatically, see Connecting

Reflecting Metadata With SQLAlchemy

To learn how to model Outreach tables with mapped classes, see Reflecting Metadata.

Querying Data From SQLAlchemy

To learn how to use mapped classes to query the associated tables, see Querying Data.

Connecting With a Dialect URL

Establishing a connection using SQLAlchemy requires a specific URL format.

from sqlalchemy import create_engine
engine = create_engine("outreach:///?InitiateOAuth=GETANDREFRESH;")

For SQLAlchemy 2.0, the dialect name is outreach_2. To establish a connection, use the following URL format:

from sqlalchemy import create_engine
engine = create_engine("outreach_2:///?InitiateOAuth=GETANDREFRESH;")

SQLAlchemy can act as an Object-relational Map (ORM). This enables you to treat records of a database table as instantiable records. To leverage this functionality, you must reflect the underlying metadata in one of the following ways.

Note: The following examples employ SQLAlchemy 1.4.

Modeling Data Using a Mapping Class

Use "sqlalchemy.ext.declarative.declarative_base" to declare a mapping class for the table you wish to model in the ORM. A known table in the data model is modeled either partially or completely, as shown in the following example:

from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class SampleTable_1(Base):
	__tablename__ = "SampleTable_1"
	Id = Column(String, primary_key=True)
	Id = Column(String)
	Column1 = Column(String)

Automatically Reflecting Metadata

Rather than mapping tables manually, SQLAlchemy can discover the metadata for one or more tables automatically. To accomplish this across the entire data model, use automap_base:

from sqlalchemy import MetaData
from sqlalchemy.ext.automap import automap_base
meta = MetaData()
abase = automap_base(metadata=meta)
abase.prepare(autoload_with=engine)
SampleTable_1 = abase.classes.SampleTable_1

You can also reflect a single table with an inspector. When reflecting this way, providing a list of specific columns to map is optional:

from sqlalchemy import MetaData, Table
from sqlalchemy import inspect
meta = MetaData()
insp = inspect(engine)
SampleTable_1_table = Table("SampleTable_1", meta)
insp.reflect_table(SampleTable_1_table, ["Id","Column1"])

After you use the steps in Connecting to connect, and use one of the methods in Reflecting Metadata to reflect some of the metadata, you can use a session object to query data.

Querying Data Using the Query Method

If the mapping class has been prepared, use it with a session object to query the data source. After binding the engine to the session, provide the mapping class to the session's query method.

For example:

engine = create_engine("outreach:///?InitiateOAuth=GETANDREFRESH;")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(SampleTable_1).filter_by(Column2="Bob"):
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("Column1: ", instance.Column1)
	print("---------")

Querying Data Using the Execute Method

The session object can also run the query with the execute() method alongside the appropriate Table object. Assuming you have an active session, the following is just as viable:

SampleTable_1_table = SampleTable_1.metadata.tables["SampleTable_1"]
for instance in session.execute(SampleTable_1_table.select().where(SampleTable_1_table.c.Column2 == "Bob")):
	print("Id: ", instance.Id)
	print("FullName: ", instance.Name)
	print("City: ", instance.BillingCity)
	print("---------")

Implicit Joining

If mapped classes of related Outreach objects have a singular foreign key relationship, the classes are implicitly joined. After importing the necessary objects, a relationship is established between your two mapped classes, as in the example below:

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, String, Integer, DateTime, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship

Base = declarative_base()
class Contact(Base):
	__tablename__ = "Contact"
	Id = Column(Integer, primary_key=True)
	Name = Column(String)
	Email = Column(String)
	BirthDate = Column(DateTime)
	AccountId = Column(String, ForeignKey("Account.Id"))
	Account_Link = relationship("Account", back_populates="Contact_Link")

class Account(Base):
	__tablename__ = "Account"
	Id = Column(String, primary_key=True)
	Name = Column(String)
	BillingCity = Column(String)
	NumberOfEmployees = Column(Integer)
	Contact_Link = relationship("Contact", order_by=Contact.Id, back_populates="Account_Link")

Once the relationship is established, the tables are queried simultaneously using the session's query() method. For example:

rs = session.query(Account, Contact).filter(Account.Id == Contact.AccountId)
for Ac, Ct in rs:
  print("AccountId: ", Ac.Id)
  print("AccountName: ", Ac.Name)
  print("ContactId: ", Ct.Id)
  print("ContactName: ", Ct.Name)

Other Join Forms

In situations where mapped classes have either no foreign keys or multiple foreign keys, you may need different forms of the JOIN query to accommodate them. Using the earlier classes as examples, the following JOIN queries are possible as well:

• Explicit condition (necessary if there are no foreign keys in your mapped classes):
  

  rs = session.query(Account, Contact).join(Contact, Account.Id == Contact.AccountId)
  for Ac, Ct in rs:

• Left-to-right relationship:
  

  rs = session.query(Account, Contact).join(Account.Contact_Link)
  for Ac, Ct in rs:

• Left-to-right relationship with explicit target:
  

  rs = session.query(Account, Contact).join(Contact, Account.Contact_Link)
  for Ac, Ct in rs:

• String form of a left-to-right relationship:
  

  rs = session.query(Account, Contact).join("Contact_Link")
  for Ac, Ct in rs:

SQLAlchemy ORM also exposes support for other clauses in SQL, such as ORDER BY, GROUP BY, LIMIT, and OFFSET. All of these are supported by this connector:

ORDER BY

The following example sorts by a specified column using the session object's query() method:

rs = session.query(SampleTable_1).order_by(SampleTable_1.AnnualRevenue)
for instance in rs:
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("Column1: ", instance.Column1)
	print("---------")

You can also use the session object's execute() method perform an ORDER BY. For example:

rs = session.execute(SampleTable_1_table.select().order_by(SampleTable_1_table.c.AnnualRevenue))
for instance in rs:

GROUP BY

The following example uses the session object's query() method to group records with a specified column:

rs = session.query(func.count(SampleTable_1.Id).label("CustomCount"), SampleTable_1.Id).group_by(SampleTable_1.Id)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to perform a GROUP BY:

rs = session.execute(SampleTable_1_table.select().with_only_columns([func.count(SampleTable_1_table.c.Id).label("CustomCount"), SampleTable_1_table.c.Id]).group_by(SampleTable_1_table.c.Id))
for instance in rs:

LIMIT and OFFSET

The following example uses the session object's query() method to skip the first 100 records and fetch the following 25:

rs = session.query(SampleTable_1).limit(25).offset(100)
for instance in rs:
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("Column1: ", instance.Column1)
	print("---------")

You can also use the session object's execute() method to set a LIMIT or OFFSET:

rs = session.execute(SampleTable_1_table.select().limit(25).offset(100))
for instance in rs:

Certain aggregate functions can also be used within SQLAlchemy by using the func module.

To import this module, execute:

from sqlalchemy.sql import func

Once func is imported, the following aggregate functions are available:

COUNT

The following example counts the number of records in a set of groups using the session object's query() method.

rs = session.query(func.count(SampleTable_1.Id).label("CustomCount"), SampleTable_1.Id).group_by(SampleTable_1.Id)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("Id: ", instance.Id)
	print("---------")

You can also execute COUNT using the session object's execute() method:

rs = session.execute(SampleTable_1_table.select().with_only_columns([func.count(SampleTable_1_table.c.Id).label("CustomCount"), SampleTable_1_table.c.Id])group_by(SampleTable_1_table.c.Id))
for instance in rs:

SUM

This example calculates the cumulative amount of a numeric column in a set of groups.

rs = session.query(func.sum(SampleTable_1.AnnualRevenue).label("CustomSum"), SampleTable_1.Id).group_by(SampleTable_1.Id)
for instance in rs:
	print("Sum: ", instance.CustomSum)
	print("Id: ", instance.Id)
	print("---------")

You can also invoke SUM using the session object's execute() method.

rs = session.execute(SampleTable_1_table.select().with_only_columns([func.sum(SampleTable_1_table.c.AnnualRevenue).label("CustomSum"), SampleTable_1_table.c.Id]).group_by(SampleTable_1_table.c.Id))
for instance in rs:

AVG

This example uses the session object's query() method to calculate the average amount of a numeric column in a set of groups:

rs = session.query(func.avg(SampleTable_1.AnnualRevenue).label("CustomAvg"), SampleTable_1.Id).group_by(SampleTable_1.Id)
for instance in rs:
	print("Avg: ", instance.CustomAvg)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to invoke AVG:

rs = session.execute(SampleTable_1_table.select().with_only_columns([func.avg(SampleTable_1_table.c.AnnualRevenue).label("CustomAvg"), SampleTable_1_table.c.Id]).group_by(SampleTable_1_table.c.Id))
for instance in rs:

MAX and MIN

This example finds the maximum value and minimum value of a numeric column in a set of groups.

rs = session.query(func.max(SampleTable_1.AnnualRevenue).label("CustomMax"), func.min(SampleTable_1.AnnualRevenue).label("CustomMin"), SampleTable_1.Id).group_by(SampleTable_1.Id)
for instance in rs:
	print("Max: ", instance.CustomMax)
	print("Min: ", instance.CustomMin)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to invoke MAX and MIN:

rs = session.execute(SampleTable_1_table.select().with_only_columns([func.max(SampleTable_1_table.c.AnnualRevenue).label("CustomMax"), func.min(SampleTable_1_table.c.AnnualRevenue).label("CustomMin"), SampleTable_1_table.c.Id]).group_by(SampleTable_1_table.c.Id))
for instance in rs:

When combined with the connector, Pandas can be used to generate data frames that contain your Outreach data. Once created, a data frame can be passed to various other Python packages.

Connecting

Pandas relies on an SQLAlchemy engine to execute queries. Before you can use Pandas you must import it:

import pandas as pd
from sqlalchemy import create_engine
engine = create_engine("outreach:///?InitiateOAuth=GETANDREFRESH;")

Querying Data

In Pandas, SELECT queries are provided in a call to the read_sql() method, alongside a relevant connection object. Pandas executes the query on that connection, and returns the results in the form of a data frame, which can be used for a variety of purposes.

df = pd.read_sql("""
	SELECT
	   Id,
	   Column1,
     $exNumericCol;
	FROM SampleTable_1;""", engine)
print(df)

Matplotlib contains a number of tools that can graphically model Outreach data after being fed a data frame From Pandas.

Using PyPlot

Before any Matplotlib tool, such as pyplot, can be used, it must be imported:

from matplotlib import pyplot as plt

Once a Pandas data frame is obtained, it can be used to create a plot visualizing Outreach data. For example, the following plot generates and displays a bar graph relating Id and AnnualRevenue values:

df.plot(kind="bar", x="Id", y=["AnnualRevenue"])
plt.show()

The connector can be used to create ETL applications and pipelines for CSV data in Python using Petl.

Install Required Modules

Install the Petl modules using the pip utility.

pip install petl

Connecting

After you import the modules, including the CData Python Connector for Outreach, you can use the connector's connect function to create a connection using a valid Outreach connection string. If you prefer not to use a direct connection, you can use a SQLAlchemy engine.

import petl as etl
import cdata.outreach as mod
cnxn = mod.connect("InitiateOAuth=GETANDREFRESH;")

Extract, Transform, and Load the Outreach Data

Create a SQL query string and store the query results in a DataFrame.

sql = "SELECT	Id, Column1 FROM SampleTable_1 "
table1 = etl.fromdb(cnxn,sql)

Loading Data

With the query results stored in a DataFrame, you can load your data into any supported Petl destination. The following example loads the data into a CSV file.

etl.tocsv(table1,'output.csv')

The extension supports schema discovery by using SQL queries to available System Tables.

Using SQL

The following sections describe the discovery of metadata through several System Tables:

• Tables and Views
• Columns
• Procedures

The connector possesses system tables that are used to discover the tables and views available in the data model. Of these system tables, "sys_tables" and "sys_views" are used to fetch information about the available tables and views respectively:

Tables

import cdata.outreach as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tables"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Views

import cdata.outreach as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_views"
cur.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

The available columns for any given table are fetched from a system table called "sys_tablecolumns". A specific table name is provided in the WHERE criteria to restrict the table from which the column information is fetched:

import cdata.outreach as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tablecolumns WHERE TableName = 'SampleTable_1'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Procedures

A system table called "sys_procedures" is queried to obtain the available stored procedures that are executed:

import cdata.outreach as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedures"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Parameters

The input parameters of any stored procedure are similarly obtained from the "sys_procedureparameters" system table:

import cdata.outreach as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

SELECT Statements

See SELECT Statements for a syntax reference and examples.

See Data Model for information on the capabilities of the Outreach API.

CACHE Statements

CACHE statements allow granular control over the connector's caching functionality. For a syntax reference and examples, see CACHE Statements.

For more information on the caching feature, see Caching Data.

EXECUTE Statements

Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.

Names and Quoting

• Table and column names are considered identifier names; as such, they are restricted to the following characters: [A-Z, a-z, 0-9, _:@].
• To use a table or column name with characters not listed above, the name must be quoted using square brackets ([name]) in any SQL statement.
• Parameter names can optionally start with the @ symbol (e.g., @p1 or @CustomerName) and cannot be quoted.
• Strings must be quoted using single quotes (e.g., 'John Doe').

The connector provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.

The connector interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and connector syntax for the DATENAME function:

• SQL Server:
  

  SELECT DATENAME(yy,GETDATE())

• connector:
  

  SELECT DATENAME('yy',GETDATE())

String Functions

These functions perform string manipulations and return a string value. See STRING Functions for more details.

Date Functions

These functions perform date and date time manipulations. See DATE Functions for more details.

Math Functions

These functions provide mathematical operations. See MATH Functions for more details.

ASCII(character_expression)

Returns the ASCII code value of the left-most character of the character expression.

• character_expression: The character expression.

                      SELECT ASCII('0');
                      --  Result: 48
                    

BASE64_ENCODE(input_binary)

Returns the Base64-encoded string form of a binary input.

• input_binary: The binary value to encode.

                        SELECT BASE64_ENCODE(BinaryData);
                    -- Result: 'QmFzZTY0RW5jb2RlZA=='
                    

BASE64_DECODE(input_string)

Returns the binary result of decoding a Base64-encoded string.

• input_string: The Base64-encoded string.

                        SELECT BASE64_DECODE('QmFzZTY0RW5jb2RlZA==');
                    -- Result: (binary output)
                    

CHAR(integer_expression)

Converts the integer ASCII code to the corresponding character.

• integer_expression: The integer from 0 through 255.

                      SELECT CHAR(48);
                      -- Result: '0'
                    

CHARINDEX(expressionToFind ,expressionToSearch [,start_location ])

Returns the starting position of the specified expression in the character string.

• expressionToFind: The character expression to find.
• expressionToSearch: The character expression, typically a column, to search.
• start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT CHARINDEX('456', '0123456');
                      -- Result: 4

                      SELECT CHARINDEX('456', '0123456', 5);
                      -- Result: -1
                    

CHAR_LENGTH(character_expression),

Returns the number of UTF-8 characters present in the expression.

• character_expression: The set of characters to be evaluated for length.

				 SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
				 -- Result: 11			
				

CONCAT(string_value1, string_value2, ..., string_valueN)

Returns the string that is the concatenation of two or more string values.

• string_value1: The first string to be concatenated.
• string_value2: The second string to be concatenated.
• string_valueN: (optional) Any additional strings to be concatenated.

                      SELECT CONCAT('Hello, ', 'world!');
                      -- Result: 'Hello, world!'
                    

CONTAINS(expressionToSearch, expressionToFind)

Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.

• expressionToSearch: The character expression, typically a column, to search.
• expressionToFind: The character expression to find.

                      SELECT CONTAINS('0123456', '456');
                      -- Result: 1

                      SELECT CONTAINS('0123456', 'Not a number');
                      -- Result: 0
                    

ENDSWITH(character_expression, character_suffix)

Returns 1 if character_expression ends with character_suffix; otherwise, 0.

• character_expression: The character expression.
• character_suffix: The character suffix to search for.

                      SELECT ENDSWITH('0123456', '456');
                      -- Result: 1

                      SELECT ENDSWITH('0123456', '012');
                      -- Result: 0
                    

FILESIZE(uri)

Returns the number of bytes present in the file at the specified file path.

• uri: The path of the file from which to read the size.

				SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
				-- Result: 23684
				

FORMAT(value [, parseFormat], format )

Returns the value formatted with the specified format.

• value: The string to format.
• format: The string specifying the output syntax of the date or numeric format.
• parseFormat: The string specifying the input syntax of the date value. Not applicable to numeric types.

                      SELECT FORMAT(12.34, '#');
                      -- Result: 12

                      SELECT FORMAT(12.34, '#.###');
                      -- Result: 12.34

                      SELECT FORMAT(1234, '0.000E0');
                      -- Result: 1.234E3
                      
                      SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
                      -- Result: 2019-01-01
                      
                      SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
                      -- Result: '2019-01-01'
                    

HASHBYTES(algorithm, value)

Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.

• algorithm: The algorithm to use for hashing. Must be one of MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, or SHA3_512.
• value: The value to hash. Must be either a string or byte array.

                      SELECT HASHBYTES('MD5', 'Test');
                      -- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
                    

INDEXOF(expressionToSearch, expressionToFind [,start_location ])

Returns the starting position of the specified expression in the character string.

• expressionToSearch: The character expression, typically a column, to search.
• expressionToFind: The character expression to find.
• start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT INDEXOF('0123456', '456');
                      -- Result: 4

                      SELECT INDEXOF('0123456', '456', 5);
                      -- Result: -1
                    

ISALPHABETIC(character_expression)

Returns 1 if the character expression consists only of alphabetic characters; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISALPHABETIC('Hello');
                      -- Result: 1

                      SELECT ISALPHABETIC('Hello123');
                      -- Result: 0

                      SELECT ISALPHABETIC('Hello!');
                      -- Result: 0
                    

ISALPHANUMERIC(character_expression)

Returns 1 if the character expression consists only of alphabetic and numeric characters; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISALPHANUMERIC('Hello123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('Hello.123');
                      -- Result: 0
                    

ISNUMERIC(character_expression)

Returns 1 if the character expression consists only of numeric digits and up to one decimal point; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISNUMERIC('123');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45.67');
                      -- Result: 0

                      SELECT ISNUMERIC('12a3');
                      -- Result: 0
                    

JSON_EXTRACT(json, jsonpath)

Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to extract.
• jsonpath: The XPath used to select the nodes. The JSONPath must be a string constant. The values of the nodes selected will be returned in a token-separated list.

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
                      -- Result: '{"data":1}'

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
                      -- Result: 1

                      SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
                      -- Result: 2
                    

LEFT ( character_expression , integer_expression )

Returns the specified number of characters counting from the left of the specified string.

• character_expression: The character expression.
• integer_expression: The positive integer that specifies how many characters will be returned counting from the left of character_expression.

                      SELECT LEFT('1234567890', 3);
                      -- Result: '123'
                    

LEN(string_expression)

Returns the number of characters of the specified string expression.

• string_expression: The string expression.

                      SELECT LEN('12345');
                      -- Result: 5
                    

LOCATE(substring,string)

Returns an integer representing how many characters into the string the substring appears.

• substring: The substring to find inside larger string.
• string: The larger string that is searched for the substring.
• start locations: An optional integer that sets the character position (offset) from which to start searching.

				SELECT LOCATE('sample','XXXXXsampleXXXXX');
				-- Result: 6

                SELECT LOCATE('sample', 'XXXXXsampleXXXXX', 7)
                -- Result: 0
				

LOWER ( character_expression )

Returns the character expression with the uppercase character data converted to lowercase.

• character_expression: The character expression.

                      SELECT LOWER('MIXED case');
                      -- Result: 'mixed case'
                    

LTRIM(character_expression)

Returns the character expression with leading blanks removed.

• character_expression: The character expression.

                      SELECT LTRIM('     trimmed');
                      -- Result: 'trimmed'
                    

MASK(string_expression, mask_character [, start_index [, end_index ]])

Replaces the characters between start_index and end_index with the mask_character within the string.

• string_expression: The string expression to be searched.
• mask_character: The character to mask with.
• start_index: The optional number of characters to leave unmasked at beginning of string. Defaults to 0.
• end_index: The optional number of characters to leave unmasked at end of string. Defaults to 0.

                        SELECT MASK('1234567890','*',);
                        -- Result: '**********'
                        SELECT MASK('1234567890','*', 4);
                        -- Result: '1234******'
                        SELECT MASK('1234567890','*', 4, 2);
                        -- Result: '1234****90'  
                    

NCHAR(integer_expression)

Returns the Unicode character with the specified integer code as defined by the Unicode standard.

• integer_expression: The integer from 0 through 65535 (0 through xFFFF).

OCTET_LENGTH(character_expression),

Returns the number of bytes present in the expression.

• character_expression: The set of characters to be be evaluated.

				 SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
				 -- Result: 4
				

PATINDEX(pattern, expression)

Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.

• pattern: The character expression that contains the sequence to be found. The wild-card character % can be used only at the start or end of the expression.
• expression: The expression, typically a column, to search for the pattern.

                      SELECT PATINDEX('123%', '1234567890');
                      -- Result: 1

                      SELECT PATINDEX('%890', '1234567890');
                      -- Result: 8

                      SELECT PATINDEX('%456%', '1234567890');
                      -- Result: 4
                    

POSITION(expressionToFind IN expressionToSearch)

Returns the starting position of the specified expression in the character string.

• expressionToFind: The character expression to find.
• expressionToSearch: The character expression, typically a column, to search.

                      SELECT POSITION('456' IN '123456');
                      -- Result: 4

                      SELECT POSITION('x' IN '123456');
                      -- Result: 0
                    

QUOTENAME(character_string [, quote_character])

Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.

• character_string: The string of Unicode character data. The string is limited to 128 characters. Inputs greater than 128 characters return null.
• quote_character: An optional single character to be used as the delimiter. These include:
  • a single quotation mark (')
  • a left or right bracket ([])
  • a double quotation mark (")
  • a left or right parenthesis ( () )
  • a greater or less than sign (><)
  • a left or right brace ({})
  • a backtick (`)

  If quote_character is not specified brackets are used. If an unacceptable character is supplied, it returns NULL.

                      SELECT QUOTENAME('table_name');
                      -- Result: '[table_name]'

                      SELECT QUOTENAME('table_name', '"');
                      -- Result: '"table_name"'

                      SELECT QUOTENAME('table_name', '[');
                      -- Result: '[table_name]'
                    

REGEXP_REPLACE(expr, pattern [, replacement [, position [, occurrence [, match_type]]]])

Replaces occurrences of a regular expression pattern in the input string with a specified value and returns the resulting string.

• expr: The string expression to be searched.
• pattern: The regular expression pattern to match.
• replacement: (optional) The string to replace each matched occurrence of pattern with. Supports backreferences \1 through \9 and escape sequences \n, \r, \t, and \\. By default, this argument is an empty string, meaning matched portions are removed from the output string.
• position: (optional) The 1-based starting position used when searching for regular expression matches in expr. The default is 1. All characters prior to the starting position are included in the output string unaltered. Skipped characters are ignored when calculating regular expression matches, even if they match pattern.
• occurrence: (optional) Specifies whether all occurrences of pattern,, or only a specific occurrence of pattern are replaced. The default is 0, which means all occurrences of pattern are replaced with replacement. Set to 1 to only replace the first instance of the pattern; 2 to replace the second; etc.
• match_type: (optional) Modifiers used to customize matching behavior. Supported values are: 'c' (case-sensitive, default), 'i' (case-insensitive), 'm' (multiline), 'n' (dot matches newline), 'x' (extended mode). These can be freely combined by including the letters back to back. For example, 'im' applies the functionality of both 'i' and 'm'. The regular expression syntax used is that of the Extended mode ('x') ignores whitespace and allows inline comments. If the pattern needs to match a literal space, it must be explicitly escaped.

                      SELECT REGEXP_REPLACE('abc123def456', '\d+', 'NUM');
                      -- Result: 'abcNUMdefNUM'

                      SELECT REGEXP_REPLACE('Hello\nHELLO\nhello', '^hello', 'X', 1, 0, 'im');
                      -- Result: 'X\nX\nX'
                    

REPLACE(string_expression, string_pattern, string_replacement)

Replaces all occurrences of a string with another string.

• string_expression: The string expression to be searched. This can be a character or binary data type.
• string_pattern: The substring to be found. Cannot be an empty string.
• string_replacement: The replacement string.

                      SELECT REPLACE('1234567890', '456', '|');
                      -- Result: '123|7890'

                      SELECT REPLACE('123123123', '123', '.');
                      -- Result: '...'

                      SELECT REPLACE('1234567890', 'a', 'b');
                      -- Result: '1234567890'
                    

REPLICATE ( string_expression ,integer_expression )

Repeats the string value the specified number of times.

• string_expression: The string to replicate.
• integer_expression: The repeat count.

                      SELECT REPLACE('x', 5);
                      -- Result: 'xxxxx'
                    

REVERSE ( string_expression )

Returns the reverse order of the string expression.

• string_expression: The string.

                      SELECT REVERSE('1234567890');
                      -- Result: '0987654321'
                    

RIGHT ( character_expression , integer_expression )

Returns the right part of the string with the specified number of characters.

• character_expression: The character expression.
• integer_expression: The positive integer that specifies how many characters of the character expression will be returned.

                      SELECT RIGHT('1234567890', 3);
                      -- Result: '890'
                    

RTRIM(character_expression)

Returns the character expression after it removes trailing blanks.

• character_expression: The character expression.

                      SELECT RTRIM('trimmed     ');
                      -- Result: 'trimmed'
                    

SOUNDEX(character_expression)

Returns the four-character Soundex code, based on how the string sounds when spoken.

• character_expression: The alphanumeric expression of character data.

                      SELECT SOUNDEX('smith');
                      -- Result: 'S530'
                    

SPACE(repeatcount)

Returns the string that consists of repeated spaces.

• repeatcount: The number of spaces.

                      SELECT SPACE(5);
                      -- Result: '     '
                    

SPLIT(string, delimiter, offset)

Returns a section of the string between to delimiters.

• string: The string to split.
• delimiter: The character to split the string with.
• offset: The number of the split to return. Positive numbers are treated as offsets from the left, and negative numbers are treated as offsets from the right.

                      SELECT SPLIT('a/b/c/d', '/', 1);
                      -- Result: 'a'
                      SELECT SPLIT('a/b/c/d', '/', -2);
                      -- Result: 'c'
                    

STARTSWITH(character_expression, character_prefix)

Returns 1 if character_expression starts with character_prefix; otherwise, 0.

• character_expression: The character expression.
• character_prefix: The character prefix to search for.

                      SELECT STARTSWITH('0123456', '012');
                      -- Result: 1

                      SELECT STARTSWITH('0123456', '456');
                      -- Result: 0
                    

STR ( float_expression [ , integer_length [ , integer_decimal ] ] )

Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.

• float_expression: The float expression.
• length: The optional total length to return. This includes decimal point, sign, digits, and spaces. The default is 10.
• decimal: The optional number of places to the right of the decimal point. The decimal must be less than or equal to 16.

                      SELECT STR('123.456');
                      -- Result: '123'

                      SELECT STR('123.456', 2);
                      -- Result: '**'

                      SELECT STR('123.456', 10, 2);
                      -- Result: '123.46'
                    

STUFF(character_expression , integer_start , integer_length , replaceWith_expression)

Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.

• character_expression: The string expression.
• start: The integer value that specifies the location to start deletion and insertion. If start or length is negative, null is returned. If start is longer than the string to be modified, character_expression, null is returned.
• length: The integer that specifies the number of characters to delete. If length is longer than character_expression, deletion occurs up to the last character in replaceWith_expression.
• replaceWith_expression: The expression of character data that will replace length characters of character_expression beginning at the start value.

                      SELECT STUFF('1234567890', 3, 2, 'xx');
                      -- Result: '12xx567890'
                    

SUBSTRING(string_value FROM start FOR length)

Returns the part of the string with the specified length; starts at the specified index.

• string_value: The character string.
• start: The positive integer that specifies the start index of characters to return.
• length: Optional. The positive integer that specifies how many characters will be returned.

                      SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
                      -- Result: '34'

                      SELECT SUBSTRING('1234567890' FROM 3);
                      -- Result: '34567890'
                    

You can also drop the FROM and FOR clauses:

                    SELECT SUBSTRING('1234567890', 3, 2)
                    --Result: '34'
                    SELECT SUBSTRING('1234567890', 3)
                    --Result: '34567890'
                    

TEXT_ENCODE(input_string, charset)

Returns binary output by encoding a string using the specified character set.

• input_string: The plain text string.
• charset: The character set to use, such as 'UTF-8', 'ISO-8859-1'.

                    SELECT TEXT_ENCODE('Café', 'UTF-8');
                    -- Result: (binary output)
                    

TEXT_DECODE(input_binary, charset)

Returns a string decoded from binary data using the specified character set.

• input_binary: The binary value to decode.
• charset: The character set used for decoding.

                    SELECT TEXT_DECODE(BinaryData, 'UTF-8');
                    -- Result: 'Café'
                    

TOSTRING(string_value1)

Converts the value of this instance to its equivalent string representation.

• string_value1: The string to be converted.

                      SELECT TOSTRING(123);
                      -- Result: '123'

                      SELECT TOSTRING(123.456);
                      -- Result: '123.456'

                      SELECT TOSTRING(null);
                      -- Result: ''
                    

TRIM(trimspec trimchar FROM string_value)

Returns the character expression with leading and/or trailing blanks removed.

• trimspec: Optional. If included must be one of the keywords BOTH, LEADING or TRAILING.
• trimchar: Optional. If included should be a one-character string value.
• string_value: The string value to trim.

                      SELECT TRIM('     trimmed     ');
                      -- Result: 'trimmed'

                      SELECT TRIM(LEADING FROM '     trimmed     ');
                      -- Result: 'trimmed     '

                      SELECT TRIM('-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
                      -- Result: '-----trimmed'
                    

UNICODE(ncharacter_expression)

Returns the integer value defined by the Unicode standard of the first character of the input expression.

• ncharacter_expression: The Unicode character expression.

UPPER ( character_expression )

Returns the character expression with lowercase character data converted to uppercase.

• character_expression: The character expression.

                      SELECT UPPER('MIXED case');
                      -- Result: 'MIXED CASE'
                    

XML_EXTRACT(xml, xpath [, separator])

Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.

• xml: The XML document to extract.
• xpath: The XPath used to select the nodes. The nodes selected will be returned in a token-separated list.
• separator: The optional token used to separate the items in the flattened response. If this is not specified, the separator will be a comma.

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
                      -- Result: 'a,e,i,o,u'

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
                      -- Result: 'a;e;i;o;u'
                    

ABS ( numeric_expression )

Returns the absolute (positive) value of the specified numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT ABS(15);
                      -- Result: 15

                      SELECT ABS(-15);
                      -- Result: 15
                    

ACOS ( float_expression )

Returns the arc cosine, the angle in radians whose cosine is the specified float expression.

• float_expression: The float expression that specifies the cosine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ACOS(0.5);
                      -- Result: 1.0471975511966
                    

ASIN ( float_expression )

Returns the arc sine, the angle in radians whose sine is the specified float expression.

• float_expression: The float expression that specifies the sine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ASIN(0.5);
                      -- Result: 0.523598775598299
                    

ATAN ( float_expression )

Returns the arc tangent, the angle in radians whose tangent is the specified float expression.

• float_expression: The float expression that specifies the tangent of the angle to be returned.

                      SELECT ATAN(10);
                      -- Result: 1.47112767430373
                    

ATN2 ( float_expression1 , float_expression2 )

Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.

• float_expression1: The float expression that is the y-coordinate.
• float_expression2: The float expression that is the x-coordinate.

                      SELECT ATN2(1, 1);
                      -- Result: 0.785398163397448
                    

CEILING ( numeric_expression ) or CEIL( numeric_expression )

Returns the smallest integer greater than or equal to the specified numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT CEILING(1.3);
                      -- Result: 2

                      SELECT CEILING(1.5);
                      -- Result: 2

                      SELECT CEILING(1.7);
                      -- Result: 2
                    

COS ( float_expression )

Returns the trigonometric cosine of the specified angle in radians in the specified expression.

• float_expression: The float expression of the specified angle in radians.

                      SELECT COS(1);
                      -- Result: 0.54030230586814
                    

COT ( float_expression )

Returns the trigonometric cotangent of the angle in radians specified by float_expression.

• float_expression: The float expression of the angle in radians.

                      SELECT COT(1);
                      -- Result: 0.642092615934331
                    

DEGREES ( numeric_expression )

Returns the angle in degrees for the angle specified in radians.

• numeric_expression: The angle in radians, an expression of an indeterminate numeric data type except for the bit data type.

                      SELECT DEGREES(3.1415926);
                      -- Result: 179.999996929531
                    

EXP ( float_expression )

Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.

• float_expression: The float expression.

                      SELECT EXP(2);
                      -- Result: 7.38905609893065
                    

EXPR ( expression )

Evaluates the expression.

• expression: The expression. Operators allowed are +, -, *, /, ==, !=, >, <, >=, and <=.

                      SELECT EXPR('1 + 2 * 3');
                      -- Result: 7

                      SELECT EXPR('1 + 2 * 3 == 7');
                      -- Result: true
                    

FLOOR ( numeric_expression )

Returns the largest integer less than or equal to the numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT FLOOR(1.3);
                      -- Result: 1

                      SELECT FLOOR(1.5);
                      -- Result: 1

                      SELECT FLOOR(1.7);
                      -- Result: 1
                    

GREATEST(int1,int2,....)

Returns the greatest of the supplied integers.

				SELECT GREATEST(3,5,8,10,1)
				-- Result: 10			
				

HEX(value)

Returns a the equivalent hex for the input value.

• value: A string or numerical value to be converted into hex.

				SELECT HEX(866849198);
				-- Result: 33AB11AE
				
				SELECT HEX('Sample Text');
				-- Result: 53616D706C652054657874
				

JSON_AVG(json, jsonpath)

Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4.5
                    

JSON_COUNT(json, jsonpath)

Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 2
                    

JSON_MAX(json, jsonpath)

Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
                      -- Result: 4
                    

JSON_MIN(json, jsonpath)

Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4
                    

JSON_SUM(json, jsonpath)

Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 9
                    

LEAST(int1,int2,....)

Returns the least of the supplied integers.

				SELECT LEAST(3,5,8,10,1)
				-- Result: 1			
				

LOG ( float_expression [, base ] )

Returns the natural logarithm of the specified float expression.

• float_expression: The float expression.
• base: The optional integer argument that sets the base for the logarithm.

                      SELECT LOG(7.3890560);
                      -- Result: 1.99999998661119
                    

LOG10 ( float_expression )

Returns the base-10 logarithm of the specified float expression.

• float_expression: The expression of type float.

                      SELECT LOG10(10000);
                      -- Result: 4
                    

MOD(dividend,divisor)

Returns the integer value associated with the remainder when dividing the dividend by the divisor.

• dividend: The number to take the modulus of.
• divisor: The number to divide the dividend by when determining the modulus.

				SELECT MOD(10,3);
				-- Result: 1
				

NEGATE(real_number)

Returns the opposite to the real number input.

• real_number: The real number to find the opposite of.

				SELECT NEGATE(10);
				-- Result: -10
				
				SELECT NEGATE(-12.4)
				--Result: 12.4
				

PI ( )

Returns the constant value of pi.

                  SELECT PI()
                  -- Result: 3.14159265358979 
                

POWER ( float_expression , y )

Returns the value of the specified expression raised to the specified power.

• float_expression: The float expression.
• y: The power to raise float_expression to.

                      SELECT POWER(2, 10);
                      -- Result: 1024

                      SELECT POWER(2, -2);
                      -- Result: 0.25
                    

RADIANS ( float_expression )

Returns the angle in radians of the angle in degrees.

• float_expression: The degrees of the angle as a float expression.

                      SELECT RADIANS(180);
                      -- Result: 3.14159265358979
                    

RAND ( [ integer_seed ] )

Returns a pseudorandom float value from 0 through 1, exclusive.

• seed: The optional integer expression that specifies the seed value. If seed is not specified, a seed value at random will be assigned.

                      SELECT RAND();
                      -- This result may be different, since the seed is randomized
                      -- Result: 0.873159630165044

                      SELECT RAND(1);
                      -- This result will always be the same, since the seed is constant
                      -- Result: 0.248668584157093
                    

ROUND ( numeric_expression [ ,integer_length] [ ,function ] )

Returns the numeric value rounded to the specified length or precision.

• numeric_expression: The expression of a numeric data type.
• length: The optional precision to round the numeric expression to. When this is omitted, the default behavior will be to round to the nearest whole number.
• function: The optional type of operation to perform. When the function parameter is omitted or has a value of 0 (default), numeric_expression is rounded. When a value other than 0 is specified, numeric_expression is truncated.

                      SELECT ROUND(1.3, 0);
                      -- Result: 1

                      SELECT ROUND(1.55, 1);
                      -- Result: 1.6

                      SELECT ROUND(1.7, 0, 0);
                      -- Result: 2

                      SELECT ROUND(1.7, 0, 1);
                      -- Result: 1
                      
                      SELECT ROUND (1.24);
                      -- Result: 1.0
                    

SIGN ( numeric_expression )

Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.

• numeric_expression: The expression of an indeterminate data type except for the bit data type.

                      SELECT SIGN(0);
                      -- Result: 0

                      SELECT SIGN(10);
                      -- Result: 1

                      SELECT SIGN(-10);
                      -- Result: -1
                    

SIN ( float_expression )

Returns the trigonometric sine of the angle in radians.

• float_expression: The float expression specifying the angle in radians.

                     SELECT SIN(1);
                     -- Result: 0.841470984807897
                    

SQRT ( float_expression )

Returns the square root of the specified float value.

• float_expression: The expression of type float.

                      SELECT SQRT(100);
                      -- Result: 10
                    

SQUARE ( float_expression )

Returns the square of the specified float value.

• float_expression: The expression of type float.

                      SELECT SQUARE(10);
                      -- Result: 100

                      SELECT SQUARE(-10);
                      -- Result: 100
                    

TAN ( float_expression )

Returns the tangent of the input expression.

• float_expression: The expression of type float.

                      SELECT TAN(1);
                      -- Result: 1.5574077246549
                    

TRUNC(decimal_number,precision)

Returns the supplied decimal number truncated to have the supplied decimal precision.

• decimal_number: The decimal value to truncate.
• precision: The number of decimal places to truncate the decimal number to.

				SELECT TRUNC(10.3423,2);
				-- Result: 10.34
				

_ROW_NUMBER_()

Returns a row index as an additional column.

				SELECT ColumnName, _ROW_NUMBER_() FROM TableName
				-- Result: ColumnData, 0
				ColumnData2, 1
				ColumnData3, 2
				

CURRENT_DATE()

Returns the current date value.

                  SELECT CURRENT_DATE();
                  -- Result: 2018-02-01
                

CURRENT_TIMESTAMP()

Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.

                  SELECT CURRENT_TIMESTAMP();
                  -- Result: 2018-02-01 03:04:05
                

DATEADD (datepart , integer_number , date [, dateformat])

Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.

• datepart: The part of the date to add the specified number to. The valid values and abbreviations are
  • year (yy, yyyy)
  • quarter (qq, q)
  • month (mm, m)
  • week (wk, ww)
  • weekday (dw)
  • dayofyear (dy, y)
  • day (dd, d)
  • hour (hh)
  • minute (mi, n)
  • second (ss, s)
  • millisecond (ms)
• number: The number to be added.
• date: The expression of the datetime data type.
• dateformat: The optional output date format.

                  SELECT DATEADD('d', 5, '2018-02-01');
                  -- Result: 2018-02-06

                  SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
                  -- Result: 2018-02-01 05:00:00
                

DATEDIFF ( datepart , startdate , enddate )

Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.

• datepart: The part of the date that is the time interval of the difference between the start date and end date. The valid values and abbreviations are:
  • Year (year, yyyy, yy)
  • Quarter (quarter, qq, q)
  • Month (month, mm, m)
  • Week (week, wk, ww)
  • Weekday (weekday, dw)
  • Dayofyear (dayofyear, dy, y)
  • Day (day, dd, d)
  • Hour (hour, hh)
  • Minute (minute, mi, n)
  • Second (second, ss, s)
  • Millisecond (millisecond, ms)
• startdate: The datetime expression of the start date.
• enddate: The datetime expression of the end date.

                  SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
                  -- Result: 9

                  SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
                  -- Result: 12
                

DATE_FORMAT(date,format)

Returns the date or timestamp in the format specified. This function mirrors the MySQL DATE_FORMAT function.

• date: A date or timestamp string.
• format: The specifier string of the desired output format. The list of supported format specifiers comes from the MySQL DATE_FORMAT function (see link to MySQL documentation above).

					SELECT DATE_FORMAT('9/4/2021 3:11:53 AM','%h')
					-- Result: 03
				  

DATEFROMPARTS(integer_year, integer_month, integer_day)

Returns the datetime value for the specified year, month, and day.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.

                    SELECT DATEFROMPARTS(2018, 2, 1);
                    -- Result: 2018-02-01
                  

DATENAME(datepart , date)

Returns the character string that represents the specified date part of the specified date.

• datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), and nanosecond (ns).
• date: The datetime expression.

                     SELECT DATENAME('yy', '2018-02-01');
                     -- Result: '2018'

                     SELECT DATENAME('dw', '2018-02-01');
                     -- Result: 'Thursday'
                   

DATEPART(datepart, date [,integer_datefirst])

Returns a character string that represents the specified date part of the specified date.

• datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), nanosecond (ns), ISODOW, ISO_WEEK (isoweek, isowk,isoww), and ISOYEAR.
• date: The datetime string.
• datefirst: The optional integer representing the first day of the week. The default is 7, Sunday.

                    SELECT DATEPART('yy', '2018-02-01');
                    -- Result: 2018

                    SELECT DATEPART('dw', '2018-02-01');
                    -- Result: 5
                  

DATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_milliseconds)

Returns the datetime value for the specified date parts.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• milliseconds: The integer expression specifying the milliseconds.

                    SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATETIME2FROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the datetime value for the specified date parts.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• fractions: The integer expression specifying the fractions of the second.
• precision: The integer expression specifying the precision of the fraction.

				    SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATE_TRUNC(date, datepart)

Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.

• date: The datetime string that specifies the date.
• datepart: Refer to the Oracle documentation for valid datepart syntax.

				    SELECT DATE_TRUNC('05-04-2005', 'YY');
                    -- Result: '1/1/2005'
					
                    SELECT DATE_TRUNC('05-04-2005', 'MM');
                    -- Result: '5/1/2005'                    
                  

DATE_TRUNC2(datepart, date, [weekday])

Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.

• datepart: One of 'millennium', 'century', 'decade', 'year', 'quarter', 'month', 'week', 'day', 'hour', 'minute' or 'second'.
• date: The datetime string that specifies the date.
• weekday: The optional day of the week to use as the first day for 'week'. One of 'sunday', 'monday', etc.

                    SELECT DATE_TRUNC2('year', '2020-02-04');
                    -- Result: '2020-01-01'

                    SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
                    -- Result: '2020-02-02', which is the previous Monday
                  

DAY(date)

Returns the integer that specifies the day component of the specified date.

• date: The datetime string that specifies the date.

                    SELECT DAY('2018-02-01');
                    -- Result: 1
                  

DAYNAME(date)

Returns the name of the day of the week of the specified date.

• date: The datetime string that specifies the date.

                    SELECT DAYNAME('8/18/2021');
                    -- Result: Wednesday
                  

DAYOFMONTH(date)

Returns the day of the month of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFMONTH('04/15/2000');
				  -- Result: 15
				  

DAYOFWEEK(date)

Returns the day of the week of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFWEEK('04/15/2000');
				  -- Result: 7
				  

DAYOFYEAR(date)

Returns the day of the year of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFYEAR('04/15/2000');
				  -- Result: 106
				  

EOMONTH(date [, integer_month_to_add ]) or LAST_DAY(date)

Returns the last day of the month that contains the specified date with an optional offset.

• date: The datetime expression specifying the date for which to return the last day of the month.
• integer_month_to_add: The optional integer expression specifying the number of months to add to the date before calculating the end of the month.

                  SELECT EOMONTH('2018-02-01');
                  -- Result: 2018-02-28
                  
                  SELECT LAST_DAY('2018-02-01');
                  -- Result: 2018-02-28

                  SELECT EOMONTH('2018-02-01', 2);
                  -- Result: 2018-04-30
                

EXTRACT(date_part FROM date_column_name)

Returns the last day of the month that contains the specified date with an optional offset.

• date_part: One of the following date components: YEAR, MONTH, DAY, HOUR, MINUTE, SECOND.
• date_column_name: The name of a date column in a table.

                  SELECT EXTRACT(YEAR FROM DateColumn)
                  -- Result: 2021
                

FDWEEK(date)

Returns the first day of the week of the given date part.

• date: The datetime string that specifies the date.
• weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the week.

				  SELECT FDWEEK('02-08-2018');
				  -- Result: 2/4/2018

          SELECT FDWEEK('02-08-2018', 1)
          --Result: 02/11/2018
				  

FDMONTH(date)

Returns the first day of the month of the given date part.

• date: The datetime string that specifies the date.
• month to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the month.

				  SELECT FDMONTH('02-08-2018');
				  -- Result: 2/1/2018

          SELECT FDMONTH('02-08-2018', 1) 
          --Result: 03/01/2018
				  

FDQUARTER(date)

Returns the first day of the quarter of the given date part.

• date: The datetime string that specifies the date.
• quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the quarter.

				  SELECT FDQUARTER('05-08-2018');
				  -- Result: 4/1/2018

          SELECT FDQUARTER('05-08-2018',1)
          --Result: 07/01/2018
				  

FILEMODIFIEDTIME(uri)

Returns the time stamp associated with the Date Modified of the relevant file.

• uri: An absolute path pointing to a file on the local file system.

				 SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
				 -- Result: 6/25/2019 10:06:58 AM
				 

FROM_DAYS(datevalue)

Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.

• datevalue: A integer value representing the number of days since 1582-10-15.

				SELECT FROM_DAYS(736000);
				-- Result: 2/6/2015
				

FROM_UNIXTIME(time, issecond)

Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.

• time: The time stamp value from epoch time. Milliseconds are accepted.
• issecond: Indicates the time stamp value is milliseconds to epoch time.

                      SELECT FROM_UNIXTIME(1540495231, 1);
                      -- Result: 2018-10-25 19:20:31

                      SELECT FROM_UNIXTIME(1540495357385, 0);
                      -- Result: 2018-10-25 19:22:37
                    

GETDATE()

Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.

                  SELECT GETDATE();
                  -- Result: 2018-02-01 03:04:05
                

GETUTCDATE()

Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.

In addition, GETUTCDATE can take an optional second parameter, a date and time that are converted to UTC.

                  SELECT GETUTCDATE();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

                  SELECT GETUTCDATE('2020/08/31 13:56:00')
                  --Result: '2020-08-31 17:56:00'
                

HOUR(date)

Returns the hour component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT HOUR('02-02-2020 11:30:00');
				-- Result: 11
				

ISDATE(date, [date_format])

Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.

• date: The datetime string.
• date_format: The optional datetime format.

                      SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
                      -- Result: 1

                      SELECT ISDATE('Not a date');
                      -- Result: 0
                    

LAST_WEEK()

Returns a time stamp equivalent to exactly one week before the current date.

				SELECT LAST_WEEK();	//Assume the date is 3/17/2020	
			 -- Result: 3/10/2020 00:00:00
				

LAST_MONTH()

Returns a time stamp equivalent to exactly one month before the current date.

	
				SELECT LAST_MONTH(); //Assume the date is 3/17/2020
				-- Result: 2/17/2020 00:00:00
				

LAST_YEAR()

Returns a time stamp equivalent to exactly one year before the current date.

				SELECT LAST_YEAR();	//Assume the date is 3/17/2020	
				-- Result: 3/10/2019 00:00:00
				

LDWEEK(date)

Returns the last day of the provided week.

• date: The datetime string.
• weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the week.

				SELECT LDWEEK('02-02-2020');
				-- Result: 2/8/2020
				

LDMONTH(date)

Returns the last day of the provided month.

• date: The datetime string.
• months to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the month.

				SELECT LDMONTH('02-02-2020');
				-- Result: 2/29/2020

        SELECT LDMONTH('02-08-2020', 1)
        --Result: 03/31/2020
				

LDQUARTER(date)

Returns the last day of the provided quarter.

• date: The datetime string.
• quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the quarter.

				SELECT LDQUARTER('02-02-2020');
				-- Result: 3/31/2020

        SELECT LDQUARTER('02-02-2020',1)
        --Result: 06/30/2020
				

MAKEDATE(year, days)

Returns a date value from a year and a number of days.

• year: The year
• days: The number of days into the year. Value must be greater than 0.

          SELECT MAKEDATE(2020, 1);
          -- Result: 2020-01-01
        

MINUTE(date)

Returns the minute component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT MINUTE('02-02-2020 11:15:00');
				-- Result: 15
				

MONTH(date)

Returns the month component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT MONTH('02-02-2020');
				-- Result: 2
				

QUARTER(date)

Returns the quarter associated with the provided datetime.

• date: The datetime string that specifies the date.

				SELECT QUARTER('02-02-2020');
				-- Result: 1
				

SECOND(date)

Returns the second component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT SECOND('02-02-2020 11:15:23');
				-- Result: 23
				

SMALLDATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute)

Returns the datetime value for the specified date and time.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.

                      SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
                      -- Result: 2018-02-01 01:02:00
                    

STRTODATE(string,format)

Parses the provided string value and returns the corresponding datetime.

• string: The string value to be converted to datetime format.
• format: A format string which describes how to interpret the first string input. A few special formats are available as well, including UNIX, UNIXMILIS, TICKS, and FILETICKS.

				SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
				-- Result: 4/3/2020
				

SYSDATETIME()

Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.

                  SELECT SYSDATETIME();
                  -- Result: 2018-02-01 03:04:05
                

SYSUTCDATETIME()

Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.

                  SELECT SYSUTCDATETIME();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05
                

TIMEFROMPARTS(integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the time value for the specified time and with the specified precision.

• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• fractions: The integer expression specifying the fractions of the second.
• precision : The integer expression specifying the precision of the fraction.

                      SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
                      -- Result: 01:02:03.456
                    

TO_DAYS(date)

Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.

• date: The datetime string that specifies the date.

				SELECT TO_DAYS('02-06-2015');
				-- Result: 736000
				

WEEK(date)

Returns the week (of the year) associated with the provided datetime.

• date: The datetime string that specifies the date.

				SELECT WEEK('02-17-2020 11:15:23');
				-- Result: 8
				

YEAR(date)

Returns the integer that specifies the year of the specified date.

• date: The datetime string.

                      SELECT YEAR('2018-02-01');
                      -- Result: 2018
                    

The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.

L_TODAY()

The current day.

  SELECT * FROM MyTable WHERE MyDateField = L_TODAY()

L_YESTERDAY()

The previous day.

  SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()

L_TOMORROW()

The following day.

  SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()

L_LAST_WEEK()

Every day in the preceding week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()

L_THIS_WEEK()

Every day in the current week.

  SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()

L_NEXT_WEEK()

Every day in the following week.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()

Also available:

• L_LAST/L_THIS/L_NEXT MONTH
• L_LAST/L_THIS/L_NEXT QUARTER
• L_LAST/L_THIS/L_NEXT YEAR

L_LAST_N_DAYS(n)

The previous n days, excluding the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)

L_NEXT_N_DAYS(n)

The following n days, including the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)

Also available:

• L_LAST/L_NEXT_90_DAYS

L_LAST_N_WEEKS(n)

Every day in every week, starting n weeks before current week, and ending in the previous week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)

L_NEXT_N_WEEKS(n)

Every day in every week, starting the following week, and ending n weeks in the future.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)

Also available:

• L_LAST/L_NEXT_N_MONTHS(n)
• L_LAST/L_NEXT_N_QUARTERS(n)
• L_LAST/L_NEXT_N_YEARS(n)

A SELECT statement can consist of the following basic clauses.

• SELECT
• INTO
• FROM
• JOIN
• WHERE
• GROUP BY
• HAVING
• UNION
• ORDER BY
• LIMIT

SELECT Syntax

The following syntax diagram outlines the syntax supported by the SQL engine of the connector:

SELECT {
  [ TOP <numeric_literal> | DISTINCT ]
  { 
    * 
    | { 
        <expression> [ [ AS ] <column_reference> ] 
        | { <table_name> | <correlation_name> } .* 
      } [ , ... ] 
  }
  { 
    FROM <table_reference> [ [ AS ] <identifier> ] 
  } [ , ... ]
  [ [  
      INNER | { { LEFT | RIGHT | FULL } [ OUTER ] } 
    ] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ] 
  ] [ ... ] 
  [ WHERE <search_condition> ]
  [ GROUP BY <column_reference> [ , ... ]
  [ HAVING <search_condition> ]
  [ UNION [ ALL ] <select_statement> ]
  [ 
    ORDER BY 
    <column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
  ]
  [ 
    LIMIT <expression>
    [ 
      { OFFSET | , }
      <expression> 
    ]
  ] 
}

<expression> ::=
  | <column_reference>
  | @ <parameter> 
  | ?
  | COUNT( * | { [ DISTINCT ] <expression> } )
  | { AVG | MAX | MIN | SUM | COUNT } ( <expression> ) 
  | NULLIF ( <expression> , <expression> ) 
  | COALESCE ( <expression> , ... ) 
  | CASE <expression>
      WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
    [ ELSE { <expression> | NULL } ]
    END 
  | {RANK() | DENSE_RANK()} OVER ([PARTITION BY <column_reference>] {ORDER BY <column_reference>})
  | <literal>
  | <sql_function> 

<search_condition> ::= 
  {
    <expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN | IS DISTINCT FROM | IS NOT DISTINCT FROM } [ <expression> ]
  } [ { AND | OR } ... ] 

Examples

1. Return all columns:
   

   SELECT * FROM SampleTable_1

2. Rename a column:
   

   SELECT [Column1] AS MY_Column1 FROM SampleTable_1

3. Cast a column's data as a different data type:
   

   SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM SampleTable_1

4. Search data:
   

   SELECT * FROM SampleTable_1 WHERE Column2 = 'Bob'

5. Return the number of items matching the query criteria:
   

   SELECT COUNT(*) AS MyCount FROM SampleTable_1 

6. Return the number of unique items matching the query criteria:
   

   SELECT COUNT(DISTINCT Column1) FROM SampleTable_1 

7. Return the unique items matching the query criteria:
   

   SELECT DISTINCT Column1 FROM SampleTable_1 

8. Sort a result set in ascending order:
   

   SELECT Id, Column1 FROM SampleTable_1  ORDER BY Column1 ASC

9. Restrict a result set to the specified number of rows:
   

   SELECT Id, Column1 FROM SampleTable_1 LIMIT 10 

10. Parameterize a query to pass in inputs at execution time. This enables you to create prepared statements and mitigate SQL injection attacks.
    

    SELECT * FROM SampleTable_1 WHERE Column2 = @param

See Explicitly Caching Data for information on using the SELECT statement in offline mode.

Pseudo Columns

Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from Outreach.

    SELECT * FROM SampleTable_1 WHERE Query = 'Column3 > 100'
    

Aggregate Functions

For SELECT examples using aggregate functions, see Aggregate Functions.

JOIN Queries

See JOIN Queries for SELECT query examples using JOINs.

Date Literal Functions

Date Literal Functions contains SELECT examples with date literal functions.

Window Functions

See Window Functions for SELECT examples containing window functions.

Table-Valued Functions

See Table-Valued Functions for SELECT examples with table-valued functions.

COUNT

Returns the number of rows matching the query criteria.

SELECT COUNT(*) FROM SampleTable_1 WHERE Column2 = 'Bob'

COUNT(DISTINCT)

Returns the number of distinct, non-null field values matching the query criteria.

SELECT COUNT(DISTINCT Id) AS DistinctValues FROM SampleTable_1 WHERE Column2 = 'Bob'

AVG

Returns the average of the column values.

SELECT Column1, AVG(AnnualRevenue) FROM SampleTable_1 WHERE Column2 = 'Bob'  GROUP BY Column1

MIN

Returns the minimum column value.

SELECT MIN(AnnualRevenue), Column1 FROM SampleTable_1 WHERE Column2 = 'Bob' GROUP BY Column1

MAX

Returns the maximum column value.

SELECT Column1, MAX(AnnualRevenue) FROM SampleTable_1 WHERE Column2 = 'Bob' GROUP BY Column1

SUM

Returns the total sum of the column values.

SELECT SUM(AnnualRevenue) FROM SampleTable_1 WHERE Column2 = 'Bob'

The CData Python Connector for Outreach supports standard SQL joins like the following examples.

Inner Join

An inner join selects only rows from both tables that match the join condition:

SELECT c.Id, o.Id, o.Name, o.Emails FROM Accounts c INNER JOIN Prospects o ON c.Id = o.AccountId

Left Join

A left join selects all rows in the FROM table and only matching rows in the JOIN table:

 SELECT c.Id, o.Id, o.Name, o.Emails FROM Accounts c LEFT JOIN Prospects o ON c.Id = o.AccountId

Window functions allow you to create computed fields from a group of rows (a window) that return a result for each row, as opposed to one computed result for a set of rows, as is the case with aggregate functions. The connector supports the following window function syntax.

Note: Window function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with window functions may not be optimal.

Window Function Clauses

OVER

The OVER clause defines the window over which window functions are performed.

SELECT A, B, <window function> OVER (<window frame>) FROM TableName

The <window function> refers to any supported window function clause, and the <window frame> refers to one or more clauses that specify the logic by which the window is defined.

PARTITION BY

The PARTITION BY clause subdivides a window into sub-windows called partitions. For each unique value in the column specified in the PARTITION BY clause, every record with that value collectively forms an individual partition.

SELECT A, B, <window function> OVER (PARTITION BY A ORDER BY B) From SampleTable_1

The <window function> refers to any supported window function clause.

Window Functions

The connector supports math, ranking, and analytic window functions.

Math

These window functions perform mathematical operations on the records within the window.

COUNT()

Calculates the number of records in each partition. The calculated column is of the data type "int".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT() OVER (PARTITION BY Role) FROM Employees

COUNT_BIG()

Calculates the number of records in each partition. The calculated column is of the data type "bigint".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT_BIG() OVER (PARTITION BY Role) FROM Employees

MIN(numeric_column)

Calculates the minimum value of a numerical column per partition.

In each partition, every record will display the minimum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MIN(Earnings) OVER (PARTITION BY Role) FROM Employees

MAX(numeric_column)

Calculates the maximum value of a numerical column per partition.

In each partition, every record will display the maximum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MAX(Earnings) OVER (PARTITION BY Role) FROM Employees

SUM(numeric_column)

Calculates the sum of a numerical column per partition.

In each partition, every record will display the sum of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, SUM(Earnings) OVER (PARTITION BY Role) FROM Employees

AVG(numeric_column)

Calculates the average value of a numerical column per partition.

In each partition, every record will display the average value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, AVG(Earnings) OVER (PARTITION BY Role) FROM Employees

MEDIAN(numeric_column)

Calculates the median value of a numerical column per partition.

In each partition, every record will display the median value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MEDIAN(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEV(numeric_column)

Calculates the standard deviation of a numerical column per partition.

In each partition, every record will display the standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEV(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEVP(numeric_column)

Calculates the population standard deviation of a numerical column per partition.

In each partition, every record will display the population standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEVP(Earnings) OVER (PARTITION BY Role) FROM Employees

VAR(numeric_column)

Calculates the statistical standard variance of a numerical column per partition.

In each partition, every record will display the statistical standard variance of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VAR(Earnings) OVER (PARTITION BY Role) FROM Employees

VARP(numeric_column)

Calculates the variance population of a numerical column per partition.

In each partition, every record will display the variance population of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VARP(Earnings) OVER (PARTITION BY Role) FROM Employees

Ranking

These window functions rank records that fall within the window and its partitions.

RANK()

Assigns a rank number to each record in a window based on the value of the column specified in the required ORDER BY clause.

If two or more records have an equal value in the in ranked column, they all receive the same rank number and the rank count increments internally, skipping ahead one rank number for each record with a duplicate value in the ORDER BY column.

SELECT Id, Column1, RANK() OVER (ORDER BY Column1) AS Rank FROM SampleTable_1

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT Id, Column1, RANK() OVER (PARTITION BY Id ORDER BY Column1) AS Rank FROM SampleTable_1

DENSE_RANK()

Operates like the RANK() function, but it doesn't increment the internal rank counter for each record with a duplicate value in the ranked column.

This means that, while records with identical values in the ORDER BY column still share a rank number, the function never skips a rank number.

SELECT Id, Column1, DENSE_RANK() OVER (PARTITION BY Id ORDER BY Column1) AS Rank FROM SampleTable_1

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT Id, Column1, DENSE_RANK() OVER (PARTITION BY Id ORDER BY Column1) AS Rank FROM SampleTable_1

ROW_NUMBER()

Calculates a row number for each record. An ORDER BY clause in the OVER clause is required.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (ORDER BY Role) FROM Employees

If you define multiple partitions with PARTITION BY, a new set of row numbers are calculated for each partition.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (PARTITION BY Role ORDER BY Earnings) FROM Employees

NTILE()

Distributes rows of an ordered partition into a specified number of approximately equal groups, or buckets. It assigns each group a bucket number starting from one. For each row in a group, the NTILE() function assigns a bucket number representing the group to which the row belongs.

The syntax of NTILE() is:

NTILE(buckets) OVER (
    [PARTITION BY partition_expression, ... ]
    ORDER BY sort_expression [ASC | DESC], ...
)

The following are paramaters that NTILE() supports:

• buckets: The number of buckets into which the rows are divided. The buckets can be an expression or subquery that evaluates to a positive integer. It cannot be a window function.
• PARTITION BY: distributes rows of a result set into partitions to which the NTILE() function is applied.
• ORDER BY is clause that specifies the logical order of rows in each partition to which the NTILE() is applied.

If the number of rows is not divisible by the buckets, the NTILE() function returns groups of two sizes with the difference by one. The larger groups always precede the smaller group in the order set by ORDER BY in the OVER() clause.

If the total of rows is divisible by the number of buckets, the function divides the rows evenly among buckets. The following statement creates a new table named ntile_demo that stores 10 integers:

CREATE TABLE sales.ntile_demo (
	v INT NOT NULL
);
	
INSERT INTO sales.ntile_demo(v) 
VALUES(1),(2),(3),(4),(5),(6),(7),(8),(9),(10);	
	
SELECT * FROM sales.ntile_demo;

This statement uses the NTILE() function to divide ten rows into three groups:

SELECT 
	v, 
	NTILE (3) OVER (
		ORDER BY v
	) buckets
FROM 
	sales.ntile_demo;

Analytical

These window functions perform analytical operations on the records within the window.

PERCENT_RANK()

Calculates the relative rank SQL Percentile of each row. It returns values greater than zero, but the maximum value is one. It does not count any NULL values. This function is nondeterministic.

The syntax of PERCENT_RANK() is:

PERCENT_RANK() OVER (
      [PARTITION BY partition_expression, ... ]
      ORDER BY sort_expression [ASC | DESC], ...
  )
  

This syntax uses the following parameters.

• PARTITION BY: By default, SQL Server treats the whole data set as a single set. You can specify the PARTITION BY clause to divide data into multiple sets. The Percent_Rank function performs the analytical calculations on each set. This parameter is optional.
• ORDER BY: Sorts the data in either ascending or descending order. This parameter is required.

Table-valued functions are functions that return a table (rowset).

Note: Table-valued function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with these functions may not be optimal.

Table-Valued Function Clauses

CROSS APPLY

The CROSS APPLY operator is used to perform a subquery on each row of a table or resultset produced by a preceding table expression.

<table_expression_1> CROSS APPLY <table_expression_2>

The second table expression can reference results from the first table expression to create derived columns or an altered recordset via a table-valued function.

Each resulting record is an instance of the record it's splitting, with all the same column values, except for the column(s) containing the value split by the function.

WITH

The WITH clause is used alongside certain table-valued functions to match against constructs within the structure being split (keys, element names, attribute names, etc.) and/or to specify metadata for the columns generated from the function.

SELECT A.ColumnName, X.DerivedColumnName FROM TableName A CROSS APPLY <table-valued function> WITH (DerivedColumnName varchar(255)) AS X

Table-Valued Functions

STRING_SPLIT(input_text,delimiter)

Takes each record in the recordset of the preceding table expression, splits the column containing delimiters (input_text) into substrings separated by the delimiter, and returns one record per substring.

• input_text: A column whose value you want to parse.
• delimiter: The character used to split the value of the column specified in input_text.

Suppose there is a column called "SplitColumn" with the following content:

One-Two-Three

To unpack this value across multiple records:

SELECT A.ID, X.Value FROM [TableWithDelimitedStringField] A CROSS APPLY STRING_SPLIT(A.SplitColumn,'-') WITH (Value VARCHAR(255)) AS X

-- Results:
-----------
|ID|Value|
|1|One|
|1|Two|
|1|Three|

JSONTABLE(json_content,[jsonpath])

For each record in the recordset of the preceding table expression, returns one record for each instance of a key in a JSON array (json_content) that matches the key(s) specified in the WITH clause, at the scope specified by the "jsonpath" input.

• json_content: A JSON "table" (array of objects). The contents can nest, but this must be a single JSON array, not any other JSON structure, at the root level.
  • The values of every instance of the key(s) provided in the WITH clause are retrievable only for substructures which are immediate children of the root-level JSON array.
• jsonpath: An optional JSONPath query defining the scope, within the json_content array, that you want to pull content from. The JSON key(s) identified in the WITH clause must exist at the scope defined in this parameter. This defaults to the JSON root ($).

Consider a sample table with a single record, including an ID column and column with JSON content called "JSONColumn" with the following content:

[
	{
		"name": "Samuel",
		"email": "sam@gmail.com",
		"extrainfo": {
			"city": "Seattle"
		}
	},
	{
		"name": "Katherine",
		"email": "kat@gmail.com",
	},
	{
		"name": "George",
		"email": "george23@gmail.com",
	},
	{
		"name": "Carlos",
		"email": "carlos32@gmail.com",
	}
]

To extract all values for a certain key, specify the scope in the JSONTABLE function and provide the desired key(s) in the WITH clause.

SELECT A.ID, X.name FROM [TableWithJSONField] A CROSS APPLY JSONTABLE(A.JSONColumn) WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1 |Samuel|
|1 |Katherine|
|1 |George|
|1 |Carlos|

XMLTABLE(xml_content,[xpath,child_type])

For each record in the resultset of the preceding table expression, returns one record for each of the elements and/or attributes in an XML structure (xml_content) that match the tag name(s) and/or attribute name(s) specified in the WITH clause, at the scope specified in the "xpath" input.

• xml_content: A column containing an XML structure.
• xpath: An optional XPath that specifies the scope within the XML structure at which the connector extracts content matching the tag/attribute name(s) specified in the WITH clause.
  • When extracting the content of sub-elements, the connector can retrieve all content from tags at the root level, (depth 0) immediate children of the root (depth 1), and children of those children (depth 2).
  • When extracting element attribute content, the connector can retrieve all content from tags containing the specified attribute at the root level (depth 0) and from immediate children of root-level elements (depth 1).
• child_type: An optional parameter that specifies the part(s) of the parent element (specified in the xpath input) that the column(s) provided in the WITH clause are checked against to identify content.
  • You can supply the following values:
    • 0: The column(s) in the WITH clause are checked for matches against the parent element's attribute names and sub-element tag names.
    • 1: The column(s) in the WITH clause are checked for matches against the parent element's attribute names.
    • 2: The column(s) in the WITH clause are checked for matches against the parent element's sub-element tag names.
  • When not supplied, this defaults to 0.

Extracting Sub-Element Values

Consider a sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<shoppingList>
    <item>
        <name>Apples</name>
        <quantity>3</quantity>
        <unit>Kg</unit>
    </item>
    <item>
        <name>Bread</name>
        <quantity>2</quantity>
        <unit>Loaf</unit>
		<extrainfo>
			<Type>Whole-Grain</Type>
		</extrainfo>
    </item>
    <item>
        <name>Milk</name>
        <quantity>1</quantity>
        <unit>Carton</unit>
    </item>
    <item>
        <name>Eggs</name>
        <quantity>12</quantity>
        <unit></unit>
    </item>
</shoppingList>

To extract sub-element content, specify the scope in the XMLTABLE function and provide the desired element name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 1.

SELECT A.ID, X.name FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/item') WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1|Apples|
|1|Bread|
|1|Milk|
|1|Eggs|

Extracting Values Using Element Tag Attributes

Suppose you have this sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<restaurant>
  <dish type="appetizer">
    <name lang="en">Caprese Salad</name>
    <chef>Chef Giovanni</chef>
    <price currency="USD">9.99</price>
  </dish>
  <dish type="main-course">
    <name lang="fr">Boeuf Bourguignon</name>
    <chef>Chef Marie</chef>
    <price currency="EUR">19.99</price>
  </dish>
  <dish type="dessert">
    <name lang="es">Tres Leches Cake</name>
    <chef>Chef Alejandro</chef>
    <price currency="MXN">89.99</price>
  </dish>
</restaurant>

To extract attribute content, specify the scope in the XMLTABLE function and provide the desired attribute name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 2.

SELECT A.ID, X.type FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/dish') WITH (type VARCHAR(255)) AS X

-- Results: 
|ID|type|
---------
|1|appetizer|
|1|main-course|
|1|dessert|

CSVTABLE(csv_content,[delimiter])

For each record in the resultset of the preceding table expression, reads from a column that contains a CSV table (csv_content) and for each record in that CSV table, returns one record containing the value of the CSV column(s) specified in the WITH clause.

• csv_content: A column containing a CSV table.
• delimiter: An optional custom delimiter (instead of a comma) which splits the CSV content contained in the csv_content input.

Consider a sample table with a single record, including an ID column and a column containing CSV table called "CSVContent" with the following content:

Name;Category;Price
Apple;Fruit;0.99
Spaghetti;Pasta;5.49
Chicken Breast;Meat;8.99
Broccoli;Vegetable;2.49

To select every value in the "Name" column and account for the custom delimiter (;):

SELECT A.ID, X.Name FROM [TableWithCSVField] A CROSS APPLY CSVTABLE(A.CSVContent,';') WITH (Name VARCHAR(255)) AS X

-- Results:
|ID|Name|
-----------
|1|Apple|
|1|Spaghetti|
|1|Chicken Breast|
|1|Broccoli|

When caching is enabled, CACHE statements provide complete control over the data that is cached and the table to which it is cached. The CACHE statement executes the SELECT statement specified and caches its results to a table with the same name in the cache database or to table specified in <cached_table_name>. The connector updates or inserts rows to the cache depending on whether or not they already exist in the cache, so the primary key, which is used to identify existing rows, must be included in the selected columns.

See Caching Data for more information on different caching strategies.

CACHE Statement Syntax

The cache statement may include the following options that alter its behavior:

CACHE [ <cached_table_name> ] [ WITH TRUNCATE | AUTOCOMMIT | SCHEMA ONLY | DROP EXISTING | ALTER SCHEMA ] <select_statement> 

WITH TRUNCATE

If this option is set, the connector removes existing rows in the cache table before adding the selected rows. Use this option if you want to refresh the entire cache table but keep its existing schema.

AUTOCOMMIT

If this option is set, the connector commits each row individually. Use this option if you want to ignore the rows that could not be cached due to some reason. By default, the entire result set is cached as a single transaction.

DROP EXISTING

If this option is set, the connector drops the existing cache table before caching the new results. Use this option if you want to refresh the entire cache table, including its schema.

SCHEMA ONLY

If this option is set, the connector creates the cache table based on the SELECT statement without executing the query.

ALTER SCHEMA

If this option is set, the connector alters the schema of the existing table in the cache if it does not match the schema of the SELECT statement. This option results in new columns or dropped columns, if the schema of the SELECT statement does not match the cached table.

Common Queries

Use the following cache statement to cache all rows of a table:

CACHE SELECT * FROM SampleTable_1

Use the following cache statement to cache all rows of a table into the cache table CachedSampleTable_1:

CACHE CachedSampleTable_1 SELECT * FROM SampleTable_1

Use the following cache statement for incremental caching. The DateModified column may not exist in all tables. The cache statement shows how incremental caching would work if there were such a column. Also, notice that, in this case, the WITH TRUNCATE and DROP EXISTING options are specifically omitted, which would have deleted all existing rows.

CACHE CachedSampleTable_1 SELECT * FROM SampleTable_1 WHERE DateModified > '2013-04-04'

Use the following cache statements to create a table with all available columns that will then cache only a few of them. The sequence of statements cache only Id and Column1 even though the cache table CachedSampleTable_1 has all the columns in SampleTable_1.

CACHE CachedSampleTable_1 SCHEMA ONLY SELECT * FROM SampleTable_1
CACHE CachedSampleTable_1 SELECT Id, Column1 FROM SampleTable_1

To execute stored procedures, you can use EXECUTE or EXEC statements.

EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.

Stored Procedure Syntax

To execute a stored procedure as an SQL statement, use the following syntax:

 
{ EXECUTE | EXEC } <stored_proc_name> 
{
  [ @ ] <input_name> = <expression>
} [ , ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

Example Statements

Reference stored procedure inputs by name:

EXECUTE my_proc @second = 2, @first = 1, @third = 3;

Execute a parameterized stored procedure statement:

EXECUTE my_proc second = @p1, first = @p2, third = @p3; 

PIVOT and UNPIVOT can be used to change a table-valued expression into another table.

PIVOT

PIVOT rotates a table-value expression by turning unique values from one column into multiple columns in the output. PIVOT can run aggregations where required on any column value.

PIVOT Synax

 
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"

UNPIVOT

UNPIVOT carries out nearly the opposite to PIVOT by rotating columns of a table-valued expressions into column values.

UNPIVOT Sytax

 
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"

For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)

Overview

This section shows the available API objects and provides more information on executing SQL to the Outreach API.

Key Features

• The connector models Outreach entities as relational views, allowing you to write SQL to query Outreach data.
• Stored procedures allow you to execute operations to Outreach.
• Live connectivity to these objects means any changes to your Outreach account are immediately reflected when using the connector.

Views

Views describes the available views. Views are statically defined to model Outreach entities such as Accounts, Prospects, and Calls.

Stored Procedures

Stored Procedures are function-like interfaces to Outreach.

Stored procedures allow you to execute operations to Outreach, including downloading documents and moving envelopes.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Python Connector for Outreach Views

Name	Description
Accounts	Get Details of accounts.
CallDispositions	A ready-made collection of call dispositions that help categorize your call logs.
CallPurposes	Get details of ready-made collection of call dispositions that help categorize your call logs.
Calls	Get details of an inbound or outbound call made with a prospect.
ComplianceRequests	Get details of compliance requests.
ContentCategories	Get details of content categories.
ContentCategoryMemberships	Get details of a record that maps content to a content category.
ContentCategoryOwnerships	A record that maps content to a content category.
Duties	An Outreach-suggested role or job duty played by a user in their organization.
EmailAddress	Get details of prospect email addresses.
Events	Get details of application events, capturing details around the initiator, recipient.
Favorites	Get details of a record favorited by a particular user.
MailAliases	Alternative email name for a mailbox.
Mailbox	Get details of email mailboxes.
Mailings	Get details of mailings.
Opportunities	Get details of opportunity for a sale or pending deal.
OpportunityProspectRoles	Get details of prospect roles and associated with an opportunity.
OpportunityStages	The stage an opportunity is in.
Personas	A descriptor of a person used for categorizing prospects.
PhoneNumbers	Get details of prospect phone numbers.
Profiles	Controls what you can see and do within Outreach.
Prospects	Get Details of Prospects.
Recipients	Record for a recipient for some communication, such as email.
Roles	Get details of where you fall within your organizations structure.
Rulesets	A reusable set of behaviors to be applied to sequences.
Sequences	Get details of sequences.
SequenceStates	Get details of sequence states.
SequenceSteps	Get details of sequence steps.
SequenceTemplates	An object used to track which templates are in use by which sequence steps.
Snippets	Piece of an email to be reused in multiple messages.
Stages	The point in the process used for categorizing prospects.
TaskPriorities	Descriptor of importance used for categorizing tasks.
Tasks	An item that requires action to complete.
Teams	Get details of a group of users.
Templates	Get details of reusable templates for building emails.
Users	Get deatils of The individual that uses the application.
UsersDuties	Get details of the individual that uses the application.

Get Details of accounts.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• BuyerIntentScore supports the '=,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• CustomId supports the '=,>=,<=,>,<' operators.
• Domain supports the '=,IN' operators.
• Name supports the '=,IN' operators.
• Nammed supports the '=,IN' operators.
• SharingTeamId supports the '=,IN' operators.
• TouchedAt supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Accounts WHERE Id = 1

SELECT * FROM Accounts WHERE Id IN (1, 2)

SELECT * FROM Accounts WHERE Id >= 1

SELECT * FROM Accounts WHERE Id <= 1

SELECT * FROM Accounts WHERE Id > 1

SELECT * FROM Accounts WHERE Id < 2

SELECT * FROM Accounts WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM accounts WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CustomId = 1

SELECT * FROM Accounts WHERE BuyerIntentScore = 1

SELECT * FROM Accounts WHERE SharingTeamId = 1

Columns

Name	Type	Description
Id [KEY]	Integer	Id of Accounts.
BuyerIntentScore	Double	A custom score given to measure the quality of the account.
CompanyType	String	A description of the company type.
CreatedAt	Datetime	The date and time the account was created.
CustomId	String	A custom ID for the account often referencing an ID in an external system.
Description	String	A custom description of the account.
Domain	String	The company website domain.
ExternalSource	String	The source of the resource creation.
Followers	String	The number of followers the company has listed on social media.
FoundedAt	Datetime	The founding date of the company.
Industry	String	A description of the company industry.
LinkedInEmployees	String	The number of employees listed on the company LinkedIn URL.
LinkedInUrl	String	The company LinkedIn URL.
Locality	String	The company primary geographic region.
Name	String	The name of the company.
Named	Boolean	A boolean value determining whether this is a named account or not Only named accounts will show up on the collection index.
NaturalName	String	The natural name of the company.
NumberOfEmployees	String	The number of employees working at the company.
SharingTeamId	String	The ID of the sharing team associated with this object Access is currently in beta.
Tags	String	A list of tag values associated with the account.
TouchedAt	Datetime	The date and time the account was last touched.
TrashedAt	String	The date and time the account was last updated.
UpdatedAt	Datetime	The date and time the account was last touched at.
WebsiteUrl	String	The company website URL.
LinksSelf	String	Link Self.
Creatorid	Integer	Creator Id.
CreatorType	String	Creator Type.
OwnerId	Integer	owner Id.
OwnerType	String	Owner Type.
ProspectsLinks	String	Prospects Links.
TasksLinks	String	Tasks Links.
UpdaterId	Integer	Updater Id.
UpdaterType	String	Updater Type.
Type	String	Type.

A ready-made collection of call dispositions that help categorize your call logs.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• OrderValue supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.
• Name supports the '=,IN' operators.

For example, the following query is processed server side:

SELECT * FROM CallDispositions WHERE Id = 1

SELECT * FROM CallDispositions WHERE Id IN (1, 2)

SELECT * FROM CallDispositions WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE Name = 'Answered - Meeting Set'

SELECT * FROM CallDispositions WHERE Name IN ('test', 'ram')

SELECT * FROM CallDispositions WHERE OrderValue = 1

Columns

Name	Type	Description
Id [KEY]	Integer	Id.
CreatedAt	Datetime	The date and time the call disposition was created.
LinksSelf	String	Links self.
Name	String	The disposition's name.
OrderValue	Integer	The disposition's display OrderValue within the collection.
Outcome	String	The disposition's call outcome.
UpdatedAt	Datetime	The date and time the call disposition was last updated.
CallsLinks	String	Calls links.
CreatorId	Integer	Creator Id.
Type	String	Type of disposition.

Get details of ready-made collection of call dispositions that help categorize your call logs.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• OrderValue supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.
• Name supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM CallPurposes WHERE Id = 1

SELECT * FROM CallPurposes WHERE Id IN (1, 2)

SELECT * FROM CallPurposes WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE Name = 'Answered - Meeting Set'

SELECT * FROM CallPurposes WHERE Name IN ('test', 'ram')

SELECT * FROM CallPurposes WHERE OrderValue = 1

Columns

Name	Type	Description
Id [KEY]	Integer	Id.
CreatedAt	Datetime	The date and time the call disposition was created.
LinksSelf	String	Links self.
Name	String	The purpose's name.
OrderValue	Integer	The purpose's display OrderValue within the collection.
UpdatedAt	Datetime	The date and time the call disposition was last updated.
CallsLinks	String	Calls Links.
CreatorId	Integer	Creator Id.
Type	String	Type of disposition.

Get details of an inbound or outbound call made with a prospect.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• From supports the '=,IN' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Outcome supports the '=,IN' operators.
• State supports the '=,IN' operators.
• To supports the '=,IN' operators.
• UserCallType supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Calls WHERE Id = 1

SELECT * FROM Calls WHERE Id IN (1, 2)

SELECT * FROM Calls WHERE Id >= 1

SELECT * FROM Calls WHERE Id <= 1

SELECT * FROM Calls WHERE Id > 1

SELECT * FROM Calls WHERE Id < 2

SELECT * FROM Calls WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE UserCallType = 'bridge'

SELECT * FROM Calls WHERE UserCallType IN('bridge', 'test')

Columns

Name	Type	Description
Id [KEY]	Integer	Id of call.
AnsweredAt	Datetime	The date and time the call was answered.
CompletedAt	Datetime	The date and time the call was completed.
CreatedAt	Datetime	The date and time the call was created.
DialedAt	Datetime	The date and time the call was dialed.
Direction	String	The call direction from the user's point of view.
ExternalVendor	String	The voice provider of the call.
From	String	The phone number used to place the call.
Note	String	A custom note associated with this call.
Outcome	String	The calls outcome. Possible values are 'Answered', 'Not Answered', etc.
RecordingDeletionReason	String	Recording Deletion Reason.
RecordingUrl	String	The URL of the calls audio recording.
ReturnedAt	Datetime	The date and time the call was returned.
SequenceAction	String	The action to take on the associated sequence.
ShouldRecordCall	Boolean	Indicated whether or not the call is recorded.
State	String	The calls current state.
StateChangedAt	Datetime	The date and time the calls state last changed.
Tags	String	A list of tag values associated with the call.
To	String	The phone number that the call was placed to.
Uid	String	The Outreach voice trace Id.
UpdatedAt	Datetime	The date and time the call was last updated.
UserCallType	String	The type of call placed within the Outreach client. Possible values are bridge, voip, etc.
VendorCallId	String	The call-id as recorded by the voice provider.
VoicemailRecordingUrl	String	The URL of the calls voicemail audio recording.
LinksSelf	String	Link self.
BatchesLinks	String	Batches Links.
CallDispositionId	Integer	The associated call disposition Id.
CallDispositionType	String	The associated Call disposition type.
CallPurposeId	Integer	The associated call purpose Id.
CallPurposeType	String	The associated call purpose type.
OpportunityId	Integer	The associated opportunity Id.
PhoneNumberId	Integer	The associated phone number's Id.
ProspectId	Integer	The associated prospect Id.
SequenceId	Integer	The associated sequence Id.
SequenceStateId	Integer	The associated sequenceStates Id.
SequenceStepId	Integer	The associated sequence Step Id.
TaskId	Integer	The associated task's Id.
UserId	Integer	The associated user's Id.
Type	String	Type.

Get details of compliance requests.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN' operators.
• State supports the '=,IN' operators.
• UuId supports the '=,IN' operators.

For example, the following query is processed server side:

SELECT * FROM ComplianceRequests WHERE Id = 1

SELECT * FROM ComplianceRequests WHERE Id IN (1, 2)

SELECT * FROM ComplianceRequests WHERE State = 'test'

SELECT * FROM ComplianceRequests WHERE uuid = '12345'

SELECT * FROM ComplianceRequests WHERE uuid IN (1, 2)

Columns

Name	Type	Description
Id [KEY]	Integer	Id of compliance request.
BatchComplianceRequestUuid	String	The UUID of the batch the compliance request belongs to.
CreatedAt	Datetime	The date and time the compliance request was created.
ObjectType	String	The type of record to process.
RequestObjectId	String	The identifier for the record processed for prospects. This is the prospect Id for recipients. This is an e-mail address.
RequesterId	Integer	The ID of the Outreach user who submitted the compliance request.
RequestType	String	The type of compliance request.
State	String	The current state of the compliance request.
UpdatedAt	Datetime	The date and time at which the compliance request was last updated.
UuId	String	The UUID of the compliance request.

Get details of content categories.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Name supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM ContentCategories WHERE Id = 1

SELECT * FROM ContentCategories WHERE Id IN (1, 2)

SELECT * FROM ContentCategories WHERE Id >= 1

SELECT * FROM ContentCategories WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of Content Category.
AllowSequences	Boolean	Whether or not this category be used to group sequences.
AllowSnippets	Boolean	Whether or not this category be used to group snippets.
AllowTemplates	Boolean	Whether or not this category be used to group templates.
Color	String	Color of the content category to be used as a background.
CreatedAt	Datetime	The date and time the content category was created.
Name	String	The name of the content category.
UpdatedAt	Datetime	The date and time the content category was last updated.
LinksSelf	String	Link self.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
Type	String	Types.

Get details of a record that maps content to a content category.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM ContentCategoryMemberships WHERE Id = 1

SELECT * FROM ContentCategoryMemberships WHERE Id IN (1, 2)

SELECT * FROM ContentCategoryMemberships WHERE Id >= 1

SELECT * FROM ContentCategoryMemberships WHERE Id < 2

SELECT * FROM ContentCategoryMemberships WHERE Id <= 2

SELECT * FROM ContentCategoryMemberships WHERE Id >= 1 AND Id <= 10

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of content category memberships.
CreatedAt	Datetime	The date and time the content category membership was created.
UpdatedAt	Datetime	The date and time the content category membership was last updated.
ContentCategoryId	Integer	The content category Id.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
Type	String	Types.

A record that maps content to a content category.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM ContentCategoryOwnerships WHERE Id = 1

SELECT * FROM ContentCategoryOwnerships WHERE Id IN (1, 2)

SELECT * FROM ContentCategoryOwnerships WHERE Id >= 1

SELECT * FROM ContentCategoryOwnerships WHERE Id < 2

SELECT * FROM ContentCategoryOwnerships WHERE Id <= 2

SELECT * FROM ContentCategoryOwnerships WHERE Id >= 1 AND Id <= 10

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of content category ownerships.
CreatedAt	Datetime	The date and time the content category ownership was created.
UpdatedAt	Datetime	The date and time the content category ownership was last updated.
ContentCategoryId	Integer	The content category Id.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
Type	String	Type.

An Outreach-suggested role or job duty played by a user in their organization.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Duties WHERE Id = 1

SELECT * FROM Duties WHERE Id IN (1, 2)

SELECT * FROM Duties WHERE Id >= 1

SELECT * FROM Duties WHERE Id <= 4

SELECT * FROM Duties WHERE Id > 1

SELECT * FROM Duties WHERE Id < 4

Columns

Name	Type	Description
Id [KEY]	Integer	Id of duty.
DutyType	String	The polymorphic type of the duty.
SymbolicName	String	The string constant used to refer to this duty which can be internationalized on the client.
Type	String	Type.

Get details of prospect email addresses.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• Email supports the '=,IN' operators.
• EmailType supports the '=,IN' operators.
• Status supports the '=,IN' operators.
• OrderValue supports the '=,>=,<=,>,<' operators.
• StatusChangedAt supports the '=,>=,<=,>,<' operators.
• UnsubscribedAt supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM EmailAddress WHERE Id = 1

SELECT * FROM EmailAddress WHERE Id IN (1, 2)

SELECT * FROM EmailAddress WHERE Id >= 1

SELECT * FROM EmailAddress WHERE Id <= 1

SELECT * FROM EmailAddress WHERE Id > 1

SELECT * FROM EmailAddress WHERE Id < 2

SELECT * FROM EmailAddress WHERE StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt >= '2022-01-25 01:02:02.0 ' AND StatusChangedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt = '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt < '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt > '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE UnsubscribedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE Email = 'vivek@gmail.com'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of Email Address.
BouncedAt	Datetime	The date and time the email was bounced.
CreatedAt	Datetime	The date and time the email address was created.
Email	String	The raw email address value.
EmailType	String	Type of email address.
OrderValue	Integer	Ordered position in list of emails.
Status	String	The status of the email.
StatusChangedAt	Datetime	Time the status was updated.
UnsubscribedAt	Datetime	Time a mailing was unsubscribed using this address.
UpdatedAt	Datetime	The date and time the email address was last updated.
LinksSelf	String	Link self.
ProspectId	Integer	Prospect's Id.
ProspectType	String	Relationship type.
Type	String	Type.

Get details of application events, capturing details around the initiator, recipient.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• Name supports the '=,IN' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• EventAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Events WHERE Id = 1

SELECT * FROM Events WHERE Id IN (1, 2)

SELECT * FROM Events WHERE Id >= 1

SELECT * FROM Events WHERE Id <= 1

SELECT * FROM Events WHERE Id > 1

SELECT * FROM Events WHERE Id < 2

SELECT * FROM Events WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE EventAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE Name IN ('task_updated', 'task_owner_changed')

Columns

Name	Type	Description
Id [KEY]	Integer	Id of Email Address.
Body	String	The event body.
CreatedAt	Datetime	The date and time the event was created.
EventAt	Datetime	The date and time the event occurred.
ExternalUrl	String	The external URL associated with this event.
Name	String	The name of the event that took place.
Payload	String	The transmitted data for the event.
RequestCity	String	The city where the request that created the event was made.
RequestDevice	String	The type of device on which the request that created the event was made.
RequestHost	String	Name of the host from which the request was made.
RequestProxied	Boolean	A boolean value indicating whether or not the request was proxied.
RequestRegion	String	Name of the region from which the request was made.
LinksSelf	String	Link self.
MailingId	Integer	Mailing Id.
ProspectId	Integer	Prospect's Id.
ProspectType	String	Prospect's type.
UserId	Integer	User's Id.
Type	String	Type.

Get details of a record favorited by a particular user.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• TargetType supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Favorites WHERE Id = 1

SELECT * FROM Favorites WHERE Id IN (1, 2)

SELECT * FROM Favorites WHERE Id >= 1

SELECT * FROM Favorites WHERE Id <= 1

SELECT * FROM Favorites WHERE Id > 1

SELECT * FROM Favorites WHERE Id < 2

SELECT * FROM Favorites WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE TargetType = 'Prospect'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of favorites.
CreatedAt	Datetime	The date and time the favorite was created.
TargetType	String	The type of record that was favorited.
UpdatedAt	Datetime	The date and time the favorite was last updated.
LinksSelf	String	Links self.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
UserId	Integer	User's Id.
UserType	String	User's type.
Type	String	Type.

Alternative email name for a mailbox.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM MailAliases WHERE Id = 1

SELECT * FROM MailAliases WHERE Id IN (1, 2)

SELECT * FROM MailAliases WHERE Id >= 1

SELECT * FROM MailAliases WHERE Id <= 1

SELECT * FROM MailAliases WHERE Id > 1

SELECT * FROM MailAliases WHERE Id < 2

SELECT * FROM MailAliases WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of mail alias.
CanSend	Boolean	Whether or not this alias can send email.
CreatedAt	Datetime	The date the alias was created.
Email	String	The email alias.
UpdatedAt	Datetime	The date the alias was last updated.
Type	String	Type.

Get details of email mailboxes.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Email supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.
• UserId supports the '=,IN,>=,<=,>,<' operator.

For example, the following query is processed server side:

SELECT * FROM Mailbox WHERE Id = 1

SELECT * FROM Mailbox WHERE Id IN (1, 2)

SELECT * FROM Mailbox WHERE Id >= 1

SELECT * FROM Mailbox WHERE Id <= 1

SELECT * FROM Mailbox WHERE Id > 1

SELECT * FROM Mailbox WHERE Id < 2

SELECT * FROM Mailbox WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE UserId = 1

Columns

Name	Type	Description
Id [KEY]	Integer	Id of mailbox.
AuthId	Integer	The Auth Id associated with the mailbox.
CreatedAt	Datetime	The date and time the mailbox was created.
Editable	Boolean	A boolean value to indicate if the user has the permission to edit mailbox fields.
Email	String	The email address of the mailbox.
EmailProvider	String	The mail service provider.
EmailSignature	String	The default signature in HTML to be appended to sent email messages.
EwsEndpoint	String	The url of the Exchange Web Service.
EwsSslVerifyMode	Integer	The SSL verify mode represented as an integer the EWS connection will used.
ExchangeVersion	String	The version of Exchange.
ImapHost	String	The address of the IMAP host used for syncing.
ImapPort	Integer	The port number the IMAP server is using.
ImapSsl	Boolean	A boolean value indicating whether or not the IMAP connection will use SSL.
MaxEmailsPerDay	Integer	The maximum number of in and out emails per day.
MaxMailingsPerDay	Integer	The maximum number of emails the application can send in a day from this mailbox.
MaxMailingsPerWeek	Integer	The maximum number of emails the application can send within a week from this mailbox.
OptOutMessage	String	The message displayed on the unsubscribe confirmation page seen after clicking the unsubscribe link in the email.
OptOutSignature	String	The message below the signature in HTML.
ProspectEmailExclusions	String	A list of email address patterns to be excluded from syncing.
ProviderId	Integer	The Id of the provider associated with this calendar.
ProviderType	String	Email provider type.
SendDisabled	Boolean	A boolean value indicating whether or not sending is disabled from this mailbox.
SendErroredAt	Datetime	The date and time the most recent send error occurred.
SendMaxRetries	Integer	The maximum number of times to auto-retry a delivery when it fails.
SendMethod	String	The method used for sending email.
SendPeriod	Integer	The amount of time in seconds that the number of sendThreshold emails can be sent.
SendPermanentErrorAt	Datetime	The date and time the most recent send error occurred.
SendRequiresSync	Boolean	A boolean value indicating whether or not the mailbox is required to be recently synced before sending.
SendSuccessAt	Datetime	The date and time the most recent successful email send occurred.
SendThreshold	Integer	The maximum number of email sends per the sendPeriod amount of time.
SmtpHost	String	The address of the SMTP host used for sending.
SmtpPort	Integer	The port number the SMTP server is using.
SmtpSsl	Boolean	A boolean value indicating whether or not the SMTP connection will use SSL.
SmtpUsername	String	The username for the SMTP account.
SyncActiveFrequency	Integer	The amount of time in seconds between syncing when the user is actively using the application.
SyncDisabled	Boolean	A boolean value indicating whether or not syncing is disabled from this mailbox.
SyncErroredAt	Datetime	The date and time the most recent sync error occurred.
SyncFinishedAt	Datetime	The date and time the most recent sync finished.
SyncMethod	String	The method used for syncing email.
SyncOutreachFolder	Boolean	A boolean value indicating whether or not the folder for syncing is named Outreach instead of Inbox.
SyncPassiveFrequency	Integer	The amount of time in seconds between syncing when the user is not actively using the application.
SyncSuccessAt	Datetime	The date and time the most recent successful email sync occurred.
UpdatedAt	Datetime	The date and time the mailbox was last updated.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator type.
UserId	Integer	The Id of the user associated with this mailbox.
Username	String	The username of the email account.
Type	String	Type.

Get details of mailings.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• BouncedAt supports the '=,>=,<=,>,<' operators.
• ClickedAt supports the '=,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• DeliveredAt supports the '=,>=,<=,>,<' operators.
• MailingType supports the '=,IN' operators.
• MessageId supports the '=,IN' operators.
• NotifyThreadScheduledAt supports the '=,>=,<=,>,<' operators.
• NotifyThreadStatus supports the '=' operator.
• OpenedAt supports the '=,>=,<=,>,<' operators.
• RetryAt supports the '=,>=,<=,>,<' operators.
• RepliedAt supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.
• ScheduledAt supports the '=,>=,<=,>,<' operators.
• State supports the '=,IN' operator.
• StateChangedAt supports the '=,>=,<=,>,<' operators.
• UnsubscribedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Mailings WHERE Id = 1

SELECT * FROM Mailings WHERE Id IN (1, 2)

SELECT * FROM Mailings WHERE Id >= 1

SELECT * FROM Mailings WHERE Id <= 1

SELECT * FROM Mailings WHERE Id > 1

SELECT * FROM Mailings WHERE Id < 2

SELECT * FROM Mailings WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of mailing.
BodyHtml	String	The mailing custom email body represented in HTML.
BodyText	String	The plain-text representation of the bodyHTML field.
BouncedAt	Datetime	The date and time the email was bounced.
ClickCount	Integer	The total number of times links within the email were clicked.
ClickedAt	Datetime	The most recent date and time a link was clicked.
CreatedAt	Datetime	The date and time the mailing was created.
DeliveredAt	Datetime	The date and time the email was delivered.
ErrorBacktrace	String	Technical details explaining the mailing error.
ErrorReason	String	A summary explaining the mailing error.
FollowUpTaskScheduledAt	Datetime	The date and time of when a follow-up task should be due for this mailing.
FollowUpTaskType	String	The type of follow-up task to create.
MailboxAddress	String	The email address the mailing was sent from.
MailingType	String	A description of the type of the emailing.
MarkedAsSpamAt	Datetime	The date and time the email was marked as spam.
MessageId	String	The MIME content MessageId of the delivered message.
NotifyThreadCondition	String	The condition of when to bump this mailing to the top of the user inbox.
NotifyThreadScheduledAt	Datetime	The date and time of when this mailing should be bumped to the top of the user inbox.
NotifyThreadStatus	String	The status of the bump. Possible values are 'pending', 'sent', 'skipped', etc.
OpenCount	Integer	The total number of times the email was opened.
OpenedAt	Datetime	The most recent date and time the email was opened.
OverrideSafetySettings	Boolean	A boolean value indicating whether or not users can override submission if template variables have not all been replaced.
References	String	A list of references for the mailing taken from the email header.
RepliedAt	Datetime	The date and time the email was replied to.
RetryAt	Datetime	The date and time the email will retry to send.
RetryCount	Integer	The number of times the email has been retried to send.
RetryInterval	Integer	The amount of time in seconds between retry attempts.
ScheduledAt	Datetime	The date and time the email is scheduled to send.
State	String	The current state of the mailing. Possible values are 'bounced', 'delivered', 'delivering', 'drafted', 'failed', 'opened', 'placeholder', 'queued', 'replied', 'scheduled', etc.
StateChangedAt	Datetime	The date and time the state last changed.
Subject	String	The subject line of the email.
TrackLinks	Boolean	A boolean value indicating whether or not the mailing is tracking link clicks.
TrackOpens	Boolean	A boolean value indicating whether or not the mailing is tracking email opens.
UnsubscribedAt	Datetime	The date and time the recipient unsubscribed from the mailing sequence.
UpdatedAt	Datetime	The date and time the mailing was last updated.
LinksSelf	String	Links self.
MailboxId	Integer	Id of mailbox.
MailboxType	String	Mailbox type.
OpportunityId	Integer	Opportunity's Id.
ProspectId	Integer	Prospect's Id.
ProspectType	String	Prospect's type.
SequenceId	Integer	Sequence Id.
SequenceStateId	Integer	SequenceState Id.
SequenceStepId	Integer	SequenceStep Id.
TaskId	Integer	Task's Id.
Type	String	Type.

Get details of opportunity for a sale or pending deal.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• ExternalCreatedAt supports the '=,>=,<=,>,<' operators.
• MapLink supports the '=,IN' operators.
• MapStatus supports the '=,IN' operators.
• Name supports the '=,IN' operators.
• Probability supports the '=,IN,>=,<=,>,<' operators.
• SharingTeamId supports the '=,IN' operators.
• TouchedAt supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Opportunities WHERE Id = 1

SELECT * FROM Opportunities WHERE Id IN (1, 2)

SELECT * FROM Opportunities WHERE Id >= 1

SELECT * FROM Opportunities WHERE Id <= 1

SELECT * FROM Opportunities WHERE Id > 1

SELECT * FROM Opportunities WHERE Id < 2

SELECT * FROM Opportunities WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of opportunities.
Amount	Integer	The amount the opportunity is worth..
CloseDate	Datetime	The date the opportunity is expected to close.
CreatedAt	Datetime	The date and time the mailing was created.
CurrencyType	String	The ISO code of the currency this opportunity is in.
Description	String	A description of the opportunity.
ExternalCreatedAt	Datetime	The date the opportunity was created in the external system.
MapLink	String	A link to the SamePlan MAP (Mutual Action Plan) associated with this opportunity.
MapNextSteps	String	The next event in the timeline that has yet to be completed for the SamePlan MAP.
MapStatus	String	The status of the SamePlan MAP (Mutual Action Plan) based on how well both parties are trending towards the plan.
Name	String	The name of the opportunity.
NextStep	String	The next step to take for the opportunity.
OpportunityType	String	The type of opportunity.
Probability	Integer	The chances of the opportunity succeeding represented as a percentage.
ProspectingRepId	String	The ID of the sales rep that prospects the opportunity.
SharingTeamId	String	The ID of the sharing team associated with this object. Access is currently in beta.
Tags	String	Tags associated with the opportunity.
TouchedAt	Datetime	The last time an event happened for an opportunity.
UpdatedAt	Datetime	The date the opportunity was last updated.
LinksSelf	String	Links Self.
AccountId	Integer	Account Id.
AccountType	String	Account type.
CreatorId	Integer	Creator Id.
CreatorDataType	String	Creator type.
OpportunityStageId	Integer	opportunityStage Id.
OpportunityStageType	String	OpportunityStage Type.
OwnerId	Integer	Owner Id.
OwnerType	String	Owner Type.
StageId	Integer	Stages Id.
StageType	String	Stages Type.
UpdaterId	Integer	Updater Id.
UpdaterType	String	Updater Type.
Type	String	Opportunities type.

Get details of prospect roles and associated with an opportunity.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Role supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM OpportunityProspectRoles WHERE Id = 1

SELECT * FROM OpportunityProspectRoles WHERE Id IN (1, 2)

SELECT * FROM OpportunityProspectRoles WHERE Id >= 1

SELECT * FROM OpportunityProspectRoles WHERE Id <= 1

SELECT * FROM OpportunityProspectRoles WHERE Id > 1

SELECT * FROM OpportunityProspectRoles WHERE Id < 2

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of opportunity prospect role.
CreatedAt	Datetime	The date and time the role was created.
Primary	Boolean	A boolean value indicating if this prospect is the primary contact within an opportunity.
Role	String	A string value representing the role.
UpdatedAt	Datetime	The date and time the role was last updated.
ProspectId	Integer	Prospect's Id.
OpportunityId	Integer	Opportunity's Id.

The stage an opportunity is in.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Name supports the '=,IN' operators.
• OrderValue supports the '=' operator.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM OpportunityStages WHERE Id = 1

SELECT * FROM OpportunityStages WHERE Id IN (1, 2)

SELECT * FROM OpportunityStages WHERE Id >= 1

SELECT * FROM OpportunityStages WHERE Id <= 1

SELECT * FROM OpportunityStages WHERE Id > 1

SELECT * FROM OpportunityStages WHERE Id < 2

SELECT * FROM OpportunityStages WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE Name = 'Prospecting'

SELECT * FROM OpportunityStages WHERE OrderValue = 0

Columns

Name	Type	Description
Id [KEY]	Integer	Id of opportunity stage.
CreatedAt	Datetime	The date and time the opportunity stage was created.
Color	String	The color used to label and highlight the opportunity stage.
Name	String	The name of the opportunity stage.
OrderValue	Integer	The Order Value of the opportunity stage.
UpdatedAt	Datetime	The date and time the opportunity stage was last updated.
CreatorId	Integer	Creator Id.
OpportunityLinks	String	The opportunities currently associated with the opportunity stage.

A descriptor of a person used for categorizing prospects.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Name supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Personas WHERE Id = 1

SELECT * FROM Personas WHERE Id IN (1, 2)

SELECT * FROM Personas WHERE Id >= 1

SELECT * FROM Personas WHERE Id <= 1

SELECT * FROM Personas WHERE Id > 1

SELECT * FROM Personas WHERE Id < 2

SELECT * FROM Personas WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE Name = 'Prospecting'

SELECT * FROM Personas WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of persona.
CreatedAt	Datetime	The date and time the persona was created.
Description	String	A description of the persona.
Name	String	The name of the persona.
UpdatedAt	Datetime	The date and time the persona was last updated.
LinksSelf	String	Link self.
ProspectsLinks	String	The prospects with this persona.
Type	String	Type.

Get details of prospect phone numbers.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• Number supports the '=,IN' operators.
• Order supports the '=,>=,<=,>,<' operator.
• PhoneType supports the '=' operator.
• Status supports the '=' operator.
• StatusChangedAt supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM PhoneNumbers WHERE Id = 1

SELECT * FROM PhoneNumbers WHERE Id IN (1, 2)

SELECT * FROM PhoneNumbers WHERE Id >= 1

SELECT * FROM PhoneNumbers WHERE Id <= 1

SELECT * FROM PhoneNumbers WHERE Id > 1

SELECT * FROM PhoneNumbers WHERE Id < 2

SELECT * FROM PhoneNumbers WHERE StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt >= '2022-01-25 01:02:02.0 ' AND StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt = '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt < '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt > '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE Number = '+919876543210'

SELECT * FROM PhoneNumbers WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE PhoneType = 'work'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of phone numbers.
CountryCode	String	The country code.
CreatedAt	Datetime	The date and time the phone number was created.
Extension	String	Phone number extension.
Number	String	The phone number.
OrderValue	Integer	Ordered position in list of numbers.
PhoneType	String	Type of phone. Possible values are 'mobile', 'work', 'home', 'voip', 'other', etc.
RawNumber	String	Unformatted phone number.
Status	String	The status of the number.
StatusChangedAt	Datetime	Time the status was updated.
UpdatedAt	Datetime	The date and time the phone number was last updated.
LinksSelf	String	Link self.
ProspectId	Integer	Prospect's Id.
ProspectType	String	Prospect type.
Type	String	Type.

Controls what you can see and do within Outreach.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• SpecialId supports the '=,IN' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Name supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Profiles WHERE Id = 1

SELECT * FROM Profiles WHERE Id IN (1, 2)

SELECT * FROM Profiles WHERE Id >= 1

SELECT * FROM Profiles WHERE Id <= 1

SELECT * FROM Profiles WHERE Id > 1

SELECT * FROM Profiles WHERE Id < 2

SELECT * FROM Profiles WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE Name = 'Admin'

SELECT * FROM Profiles WHERE Name IN ('Admin', 'Default')

SELECT * FROM Profiles WHERE SpecialId IN ('Admin', 'Default')

Columns

Name	Type	Description
Id [KEY]	Integer	Id of profile.
CreatedAt	Datetime	The date and time the team was created.
IsAdmin	Boolean	Flag that indicates whether the profile provides admin access.
Name	String	The name of the profile.
SpecialId	String	The special Id flag assigned to the profile.
UpdatedAt	Datetime	The date and time the team was last updated.
LinksSelf	String	Links self.
Type	String	type.

Get Details of Prospects.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Emails supports the '=,IN' operators.
• EngagedAt supports the '=,>=,<=,>,<' operators.
• EngagedScore supports the '=,>=,<=,>,<' operators.
• ExternalSource supports the '=,IN' operators.
• FirstName supports the '=,IN' operators.
• GithubUsername supports the '=,IN' operators.
• LastName supports the '=,IN' operators.
• LinkedInId supports the '=,IN' operators.
• LinkedInSlug supports the '=,IN' operators.
• SharingTeamId supports the '=,IN' operators.
• StackOverflowId supports the '=,IN' operators.
• TimeZone supports the '=,IN' operators.
• Title supports the '=,IN' operators.
• TouchedAt supports the '=,>=,<=,>,<' operators.
• TwitterUsername supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Prospects WHERE Id = 1

SELECT * FROM Prospects WHERE Id IN (1, 2)

SELECT * FROM Prospects WHERE Id >= 1

SELECT * FROM Prospects WHERE Id <= 1

SELECT * FROM Prospects WHERE Id > 1

SELECT * FROM Prospects WHERE Id < 2

SELECT * FROM Prospects WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE EngagedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE Emails = 'test@gmail.com'

SELECT * FROM Prospects WHERE FirstName = 'test'

SELECT * FROM Prospects WHERE LastName = 'test'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of Prospects.
AccountName	String	Name of prospects.
AddedAt	String	The date and time the prospect was added to any system.
AddressCity	String	The prospects city.
AddressCountry	String	The prospects country.
AddressState	String	The prospects state.
AddressStreet	String	The prospects street address.
AddressStreet2	String	The prospects second street address.
AddressZip	String	The prospects postal code.
AngelListUrl	String	The prospects AngelList URL.
AvailableAt	String	The date and time the prospect is available to contact again.
CallOptedOut	Boolean	Whether the prospect is opted out of calling or opted out in general if granular opt-out is not enabled.
CallsOptedAt	String	A string that represents whether a prospect has opted into or out of calls.
CallsOptStatus	String	The date and time the prospect opted in out of calls.
CampaignName	String	The name of the campaign the prospect is associated with.
ClickCount	Integer	The number of clicks the prospect has made since the last touch point.
Company	String	The name of the company the prospect works at If associated with an account this is the name of the account.
CompanyFollowers	String	The company Follwers.
CompanyFoundedAt	String	The date and time when company founded at.
CompanyIndustry	String	company Industry.
CompanyLinkedIn	String	company LinkedIn.
CompanyLinkedInEmployees	String	companyLinkedIn Employees.
CompanyLocality	String	company Locality.
CompanyNatural	String	company Natural.
CompanySize	String	company Size.
CompanyStartDate	String	company StartDate.
CompanyType	String	company Type.
ContactHistogram	String	The last 12 months of email contact history with the prospect with the current month being the last element.
CreatedAt	Datetime	The date and time the prospect was created.
DateOfBirth	String	The date the prospect was born.
Degree	String	The degrees the prospect has received.
EmailOptedOut	Boolean	Whether the prospect is opted out of email or opted out in general if granular opt-out is not enabled.
Emails	String	A list of email addresses associated with the prospect.
EmailsOptedAt	String	he date and time the prospect opted in out of emails.
EmailsOptStatus	String	The date and time the prospect opted in out of emails.
EngagedAt	Datetime	The date and time the prospect last engaged.
EngagedScore	Double	A number representing the quality of the lead based on the number of the prospects opens ,clicks and mailing replies.
EventName	String	The name of the event the prospect was met at.
ExternalId	String	A custom ID for the prospect often referencing an ID in an external system.
ExternalOwner	String	A custom owner for the prospect often referencing an ownering in an external system.
ExternalSource	String	The source of the resources creation.
FacebookUrl	String	The prospects Facebook URL.
FirstName	String	The first name of the prospect.
Gender	String	The gender of the prospect.
GithubUrl	String	The prospects GitHub URL.
GithubUsername	String	The prospects GitHub username.
GooglePlusUrl	String	The prospects Google+ URL..
GraduationDate	String	The graduation date of the prospect.
HomePhones	String	A list of home phone numbers associated with the prospect.
JobStartDate	String	The starting date of the prospects current job.
LastName	String	The last name of the prospect.
LinkedInConnections	String	The number of connections on the prospects LinkedIn profile.
LinkedInId	String	The prospects LinkedIn ID.
LinkedInSlug	String	The prospects LinkedIn slug.
LinkedInUrl	String	The prospects LinkedIn URL.
MiddleName	String	The middle name of the prospect.
MobilePhones	String	A list of mobile phone numbers associated with the prospect.
Name	String	The full name of the prospect.
Nickname	String	The nickname of the prospect.
Occupation	String	The occupation of the prospect.
OpenCount	Integer	The number of opens the prospect has made since the last touch point.
OptedOut	Boolean	A boolean value representing whether this prospect is currently opted out of all mailings.
OptedOutAt	String	The date and time the prospect opted out of emails.
OtherPhones	String	A list of other phone numbers associated with the prospect.
PersonalNote1	String	A note field related to the prospect.
PersonalNote2	String	A second note field related to the prospect.
PreferredContact	String	The preferred contact method for the prospect.
QuoraUrl	String	The prospects Quora URL.
Region	String	The primary geographic region of the prospect.
ReplyCount	Integer	The number of replies the prospect has made since the last touch point.
School	String	The schools the prospect has attended.
Score	String	A custom score given to measure the quality of the lead.
SharingTeamId	String	The ID of the sharing team associated with this object.
Source	String	A custom source representing where the lead was first acquired..
Specialties	String	description of the prospects specialties.
StackOverflowId	String	The prospects StackOverflow ID.
StackOverflowUrl	String	The prospects StackOverflow URL.
StageName	String	Stage Name.
Tags	String	A list of tag values associated with the account.
TimeZone	String	The prospects current timezone preferably in the IANA format.
TimeZoneIana	String	The prospects current IANA timezone if available.
TimeZoneInferred	String	The prospects current inferred IANA timezone if available.
Title	String	The title of the prospect.
TouchedAt	Datetime	The date and time the prospect was last touched.
TrashedAt	String	The date a prospect was soft deleted.
TwitterUrl	String	The prospects Twitter URL.
TwitterUsername	String	The prospects Twitter username.
UpdatedAt	Datetime	The date and time the prospect was last updated.
VoipPhones	String	A list of voip phone numbers associated with the prospect.
WebsiteUrl1	String	The URL of the prospects website.
WebsiteUrl2	String	The value of the prospects second website URL field.
WebsiteUrl3	String	The value of the prospects third website URL field.
WorkPhones	String	A list of work phone numbers associated with the prospect.
LinksSelf	String	Link Self.
AccountId	Integer	Account Id.
AccountType	String	Account Type.
BatchesLinks	String	Batches Links.
CallsLinks	String	Calls Link.
CreatorId	Integer	Creator Id.
CreatorType	String	Creator Type.
TasksLinks	String	task links releated.
OwnerId	Integer	Owner Id.
OwnerType	String	Owner Type.
SequenceStatesLinks	String	SequenceStates Links.
UpdaterId	Integer	Updater Id.
UpdaterType	String	Updater Type.
Type	String	Type.

Record for a recipient for some communication, such as email.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Recipients WHERE Id = 1

SELECT * FROM Recipients WHERE Id IN (1, 2)

SELECT * FROM Recipients WHERE Id >= 1

SELECT * FROM Recipients WHERE Id <= 1

SELECT * FROM Recipients WHERE Id > 1

SELECT * FROM Recipients WHERE Id < 2

Columns

Name	Type	Description
Id [KEY]	Integer	Id of Recipient.
CreatedAt	Datetime	The date and time the team was created.
EmailHash	String	Hash of email for recipient.
RecipientType	String	The type of action for the communcation to the recipient.
UpdatedAt	Datetime	The date and time the team was last updated.
Value	String	The recipient contact information.
LinksSelf	String	Link self.
Type	String	Type.

Get details of where you fall within your organizations structure.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• Name supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Roles WHERE Id = 1

SELECT * FROM Roles WHERE Id IN (1, 2)

SELECT * FROM Roles WHERE Id >= 1

SELECT * FROM Roles WHERE Id <= 1

SELECT * FROM Roles WHERE Id > 1

SELECT * FROM Roles WHERE Id < 2

SELECT * FROM Roles WHERE Name = 'test'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of roles.
CreatedAt	Datetime	The date and time the team was created.
Name	String	The name of the role.
UpdatedAt	Datetime	The date and time the team was last updated.
LinksSelf	String	Link self.
ParentRoleLinks	String	Parent role links.
Type	String	Type.

A reusable set of behaviors to be applied to sequences.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• AutoResumeOotoProspects supports the '=' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• IncludeUnsubscribeLinks supports the '=' operator.
• Name supports the '=,IN' operators.
• PermitDuplicateProspects supports the '=,IN' operators.
• SequenceExclusivity supports the '=,IN' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Rulesets WHERE Id = 1

SELECT * FROM Rulesets WHERE Id IN (1, 2)

SELECT * FROM Rulesets WHERE Id >= 1

SELECT * FROM Rulesets WHERE Id <= 1

SELECT * FROM Rulesets WHERE Id > 1

SELECT * FROM Rulesets WHERE Id < 2

SELECT * FROM Rulesets WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE AutoResumeOotoProspects = 'false'

SELECT * FROM Rulesets WHERE PermitDuplicateProspects = 'disallow'

SELECT * FROM Rulesets WHERE SequenceExclusivity = 'none'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of ruleset.
ApplyCompletedStageIn	Integer	The amount of time in seconds after the sequence has completed before the completedStage will be applied to the Prospect.
AutoResumeOotoProspects	Boolean	A boolean value indicating whether or not out-of-the-office Prospects will be automatically resumed.
AutoResumeOotoProspectsExpiresIn	Integer	The maximum amount of time in seconds to wait before opted-out Prospect will be resumed.
AutoResumeOotoProspectsIn	Integer	The default amount of time in seconds to wait before opted-out Prospects will be resumed.
CallOptOutAction	String	Determines if prospect can be added to sequences if they are opted out of calling.
ClicksNeededBeforeCallTaskCreated	Integer	The number of email clicks needed before a call task will be automatically created. This feature will be disabled unless a value is set.
CreatedAt	Datetime	The date and time the ruleset was created.
EmailOptOutAction	String	Determines if prospect can be added to sequences if they are opted out of emails.
IncludeUnsubscribeLinks	Boolean	A boolean value specifying whether or not to include unsubscribe links within emails.
MeetingBookedAction	String	Determines if a prospect is marked as finished when a meeting is booked.
MinimumProspectTouchedInterval	Integer	The minimum number of seconds that must elapse between when a Prospect was last contacted and when they may be added to a sequence.
Name	String	The name of the ruleset.
OotoAutoExtractionEnabled	Boolean	A boolean value determining whether to use out of the office return date auto extraction.
OpensNeededBeforeCallTaskCreated	Integer	The number of email opens needed before a call task will be automatically created.
PermitDuplicateProspects	String	A value determining whether a Prospect may be added to this Sequence multiple times or not. Possible values are 'allow', 'disallow', 'only_if_inactive', etc.
SequenceExclusivity	String	A value determining whether Prospects may be added to multiple different Sequences. Possible values are 'all_sequences', 'exclusive_sequences', 'none', etc.
SmsOptOutAction	String	Determines if prospect can be added to sequences if they are opted out of SMS.
SmsReceivedAction	String	Determines if a prospect is marked as finished when a text message is received.
StepOverridesEnabled	Boolean	A boolean value determining whether to allow users to customize step templates when adding to sequence.
OwnerId	Integer	Owner Id.
SequenceStatesLinks	String	Sequence states links.
UpdatedAt	Datetime	The date and time the ruleset was last updated.
LinksSelf	String	Link self.
Type	String	Type.

Get details of sequences.

Select

The connector will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=,IN,>=,<=,>,<' operators.
• ClickCount supports the '=,>=,<=,>,<' operators.
• CreatedAt supports the '=,>=,<=,>,<' operators.
• DeliverCount supports the '=,>=,<=,>,<' operators.
• Name supports the '=,IN' operators.
• EnabledAt supports the '=,>=,<=,>,<' operators.
• LastUsedAt supports the '=,>=,<=,>,<' operators.
• LockedAt supports the '=,>=,<=,>,<' operators.
• OpenCount supports the '=,>=,<=,>,<' operators.
• ReplyCount supports the '=,>=,<=,>,<' operators.
• ThrottleCapacity supports the '=,>=,<=,>,<' operators.
• ThrottleMaxAddsPerDay supports the '=,>=,<=,>,<' operators.
• UpdatedAt supports the '=,>=,<=,>,<' operators.
• ShareType supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Sequences WHERE Id = 1

SELECT * FROM Sequences WHERE Id IN (1, 2)

SELECT * FROM Sequences WHERE Id >= 1

SELECT * FROM Sequences WHERE Id <= 1

SELECT * FROM Sequences WHERE Id > 1

SELECT * FROM Sequences WHERE Id < 2

SELECT * FROM Sequences WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE DeliverCount = 0

SELECT * FROM Sequences WHERE Name = 'test'

SELECT * FROM Sequences WHERE ThrottleMaxAddsPerDay = 1

SELECT * FROM Sequences WHERE ShareType = 'private'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of sequence template.
AutomationPercentage	Double	The percentage of auto_email sequence steps in this sequence.
BounceCount	Integer	The total count of bounced mailings during this sequence.
ClickCount	Integer	The total count of clicked mailings from this sequence.
CreatedAt	Datetime	The date and time the sequence was created.
DeliverCount	Integer	The total count of delivered mailings from this sequence.
Description	String	A custom description for the sequence.
DurationInDays	Integer	The total number of days it takes to get through this sequence.
Enabled	Boolean	A boolean value determining whether the sequence is enabled or not.
EnabledAt	Datetime	The date and time the sequence was enabled or null if currently disabled.
FailureCount	Integer	The total count of failed mailings from this sequence.
LastUsedAt	Datetime	The date and time the sequence was last used.
Locked	Boolean	A boolean value determining whether the sequence is locked or not.
LockedAt	Datetime	The date and time the sequence was locked or null if currently unlocked.
MaxActivations	Integer	The maximum number of prospects that can be associated with the sequence.
Name	String	The name or the sequence.
NegativeReplyCount	Integer	The total count of negative reply mailings from this sequence.
NeutralReplyCount	Integer	The total count of neutral reply mailings from this sequence.
NumContactedProspects	Integer	The total count of prospects who have been either called or emailed.
NumRepliedProspects	Integer	The total count of prospects who have been marked as replied.
OpenCount	Integer	The total count of opened mailings from this sequence.
OptOutCount	Integer	The total count of opted out mailings from this sequence.
PositiveReplyCount	Integer	The total count of positive reply mailings from this sequence.
PrimaryReplyAction	String	The action to take when the primary prospect replies. The allowed values are finish, continue, pause.
PrimaryReplyPauseDuration	Integer	The duration in seconds to pause for before automatically finishing after a reply from the primary prospect if the primaryReplyAction is pause.
ReplyCount	Integer	The total count of replied mailings from this sequence.
ScheduleCount	Integer	The total count of scheduled mailings from this sequence.
ScheduleIntervalType	String	The schedule interval type.
SecondaryReplyAction	String	The action to take when someone other than the primary prospect replies. The allowed values are finish, continue, pause.
SecondaryReplyPauseDuration	Integer	The duration in seconds to pause for before automatically finishing after a reply from anyone other than the primary prospect if the secondaryReplyAction is pause.
SequenceStepCount	Integer	The total number of sequence steps in this sequence.
SequenceType	String	The sequence type must be either date or interval. The allowed values are date, interval.
ShareType	String	The sequence share type. Possible values are 'private', 'read_only', 'shared', etc.
Tags	String	A list of tag values associated with the sequence.
ThrottleCapacity	Integer	The maximum number of associated sequence states per user that can be active at a one time.
ThrottleMaxAddsPerDay	Integer	The maximum number of associated sequence states per user that can be added to the sequence each day.
ThrottlePaused	Boolean	A boolean value determining whether the throttling of sequence states is paused or not.
ThrottlePausedAt	Datetime	The date and time the sequence state throttling was paused or null if not currently paused.
Transactional	Boolean	A boolean value determining whether prospect opt out preferences are respected.
UpdatedAt	Datetime	The date and time the sequence was last updated.
LinksSelf	String	Link self.
CreatorId	Integer	Creator Id.
OwnerId	Integer	Owner Id.
SequenceStatesLinks	String	Sequence states links.
UpdaterId	Integer	Updater Id.
RulesetId	Integer	Ruleset Id.
Type	String	Type.