How to Build an ETL App for Dotmailer 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 Dotmailer-connected applications and pipelines for extracting, transforming, and loading Dotmailer data. This article shows how to connect to Dotmailer with the CData Python Connector and use petl and pandas to extract, transform, and load Dotmailer data.

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

Connecting to Dotmailer Data

Connecting to Dotmailer 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 Dotmailer Profile on disk (e.g. C:\profiles\Dotmailer.apip). Next, set the ProfileSettings connection property to the connection string for Dotmailer (see below).

Dotmailer API Profile Settings

Create an API user in the Dotdigital platform under Setup > Access > API Users > New User. Your RegionId can be found in your account URL (e.g.,

r1

r1.dotdigitalgroup.com

After installing the CData Dotmailer Connector, follow the procedure below to install the other required modules and start accessing Dotmailer 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 Dotmailer 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 Dotmailer Connector to create a connection for working with Dotmailer data.

cnxn = mod.connect("Profile=C:\profiles\Dotmailer.apip;ProfileSettings='User=your_api_username;Password=your_api_password;RegionId=your_region_id';")

Create a SQL Statement to Query Dotmailer

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

sql = "SELECT Name, Type FROM Account WHERE Type = 'ApiUserRecord'"

Extract, Transform, and Load the Dotmailer Data

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

Loading Dotmailer Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

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

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

With the CData API Driver for Python, you can work with Dotmailer 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 Dotmailer 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\Dotmailer.apip;ProfileSettings='User=your_api_username;Password=your_api_password;RegionId=your_region_id';")

sql = "SELECT Name, Type FROM Account WHERE Type = 'ApiUserRecord'"

table1 = etl.fromdb(cnxn,sql)

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

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