Learn more
 

Ready to get started?

Connect to live data from Klaviyo with the API Driver

Connect to Klaviyo

In this article

Related articles

Create a Data Access Object for Klaviyo Data using JDBI


A brief overview of creating a SQL Object API for Klaviyo data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Klaviyo integrates connectivity to live Klaviyo data in Java applications. By pairing these technologies, you gain simple, programmatic access to Klaviyo data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Klaviyo data.

Create a DAO for the Klaviyo Campaigns Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyCampaignsDAO { //request specific data from Klaviyo (String type is used for simplicity) @SqlQuery("SELECT Name FROM Campaigns WHERE Status = :status") String findNameByStatus(@Bind("status") String status); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Klaviyo

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Klaviyo.

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

Klaviyo API Profile Settings

To authenticate to Klaviyo, you will needto provide an API Key. You can generate or view your API keys under 'My Account' > 'Setting' > 'API Key' > 'Create API Key'. Set the API Key to your Klaviyo Key in the ProfileSettings connection property.

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.api.jar

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

A connection string for Klaviyo will typically look like the following:

jdbc:api:Profile=C:\profiles\Klaviyo.apip;ProfileSettings='APIKey=my_api_key';

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Klaviyo.apip;ProfileSettings='APIKey=my_api_key';"); MyCampaignsDAO dao = dbi.open(MyCampaignsDAO.class); //do stuff with the DAO dao.close();

Read Klaviyo Data

With the connection open to Klaviyo, simply call the previously defined method to retrieve data from the Campaigns entity in Klaviyo.

//disply the result of our 'find' method String name = dao.findNameByStatus("draft"); System.out.println(name);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Klaviyo by integrating with the CData JDBC Driver for Klaviyo. Download a free trial and work with live Klaviyo data in custom Java applications today.