Use JayDeBeApi to access Omnisend Data in Python

Access Omnisend data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData API Driver for JDBC and the JayDeBeApi module to work with remote Omnisend 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 Omnisend and visualize Omnisend 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 Omnisend data in Python using SQL.

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

Omnisend API Profile Settings

Navigate to your Omnisend account integrations at https://app.omnisend.com/#/my-account/integrations/api-keys to generate an API key.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.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:api:Profile=C:\profiles\Omnisend.apip;ProfileSettings='APIKey=your_api_key';"

Access Omnisend 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.api.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 Omnisend:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:api:Profile=C:\profiles\Omnisend.apip;ProfileSettings='APIKey=your_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.api.jar"

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

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


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 API Driver for JDBC and start working with your live Omnisend data in Python. Reach out to our Support Team if you have any questions.