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

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

Connecting to ConvertKit Data

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

ConvertKit API Profile Settings

Navigate to Account Settings > Advanced > API in your ConvertKit account to find both your API Key and API Secret.

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

cnxn = mod.connect("Profile=C:\profiles\ConvertKit.apip;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret';")

Create a SQL Statement to Query ConvertKit

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

sql = "SELECT Name, PlanType FROM Accounts WHERE PrimaryEmailAddress = '[email protected]'"

Extract, Transform, and Load the ConvertKit Data

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

Loading ConvertKit Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

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

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

With the CData API Driver for Python, you can work with ConvertKit 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 ConvertKit 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\ConvertKit.apip;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret';")

sql = "SELECT Name, PlanType FROM Accounts WHERE PrimaryEmailAddress = '[email protected]'"

table1 = etl.fromdb(cnxn,sql)

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

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