How to Build an ETL App for Intercom Data in Python with CData

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData API Driver for Python and the petl framework, you can build Intercom-connected applications and pipelines for extracting, transforming, and loading Intercom data. This article shows how to connect to Intercom with the CData Python Connector and use petl and pandas to extract, transform, and load Intercom data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Intercom data in Python. When you issue complex SQL queries from Intercom, the driver pushes supported SQL operations, like filters and aggregations, directly to Intercom and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Intercom Data

Connecting to Intercom data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Start by setting the Profile connection property to the location of the Intercom Profile on disk (e.g. C:\profiles\Intercom.apip). Next, set the ProfileSettings connection property to the connection string for Intercom (see below).

Intercom API Profile Settings

In the Intercom Developer Hub, go to Configure > Authentication and select your workspace to obtain an Access Token. For OAuth, register an app and retrieve the Client ID and Secret from the app's Basic Information page.

After installing the CData Intercom Connector, follow the procedure below to install the other required modules and start accessing Intercom through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install petl
pip install pandas

Build an ETL App for Intercom Data in Python

Once the required modules and frameworks are installed, we are ready to build our ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import petl as etl
import pandas as pd
import cdata.api as mod

You can now connect with a connection string. Use the connect function for the CData Intercom Connector to create a connection for working with Intercom data.

cnxn = mod.connect("Profile=C:\profiles\Intercom.apip;ProfileSettings='APIKey=your_access_token';")

Create a SQL Statement to Query Intercom

Use SQL to create a statement for querying Intercom. In this article, we read data from the Admins entity.

sql = "SELECT Id, Type FROM Admins WHERE Email = '[email protected]'"

Extract, Transform, and Load the Intercom Data

With the query results stored in a DataFrame, we can use petl to extract, transform, and load the Intercom data. In this example, we extract Intercom data, sort the data by the Type column, and load the data into a CSV file.

Loading Intercom Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'Type')

etl.tocsv(table2,'admins_data.csv')

With the CData API Driver for Python, you can work with Intercom data just like you would with any database, including direct access to data in ETL packages like petl.

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to Intercom data. Reach out to our Support Team if you have any questions.

Full Source Code

import petl as etl
import pandas as pd
import cdata.api as mod

cnxn = mod.connect("Profile=C:\profiles\Intercom.apip;ProfileSettings='APIKey=your_access_token';")

sql = "SELECT Id, Type FROM Admins WHERE Email = '[email protected]'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'Type')

etl.tocsv(table2,'admins_data.csv')