Use JayDeBeApi to access Klaviyo Data in Python

Access Klaviyo data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Klaviyo and the JayDeBeApi module to work with remote Klaviyo data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Klaviyo and visualize Klaviyo data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Klaviyo data in Python using SQL.

To authenticate to Klaviyo, provide an API Key. You can generate or view your API keys under 'My Account'

1. Navigate to 'Settings' > 'API Keys'
2. Click 'Create API Key'.
3. Name your API key and choose the desired scopes.

To connect in your CData solutions, set API Key to your Klaviyo API key.

If you wish to use OAuth authentication, refer to the Help documenation.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Klaviyo JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.klaviyo.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:klaviyo:APIKey=my_api_key;"

Access Klaviyo data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.klaviyo.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Klaviyo:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:klaviyo:APIKey=my_api_key;"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.klaviyo.jar"

conn = jaydebeapi.connect(
 "cdata.jdbc.klaviyo.KlaviyoDriver",
 jdbc_url,
 [username, password],
 jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Campaigns;")


results = cursor.fetchall()
for row in results:
 print(row)

cursor.close()
conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for Klaviyo and start working with your live Klaviyo data in Python. Reach out to our Support Team if you have any questions.