Configure a Connection Profile

From the CData ribbon, click Get Data and select From Klaviyo connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Klaviyo Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to Klaviyo

To connect to Klaviyo, first choose an authentication method by setting the following property:

• AuthScheme: The type of authentication to use whe connecting to Klaviyo.

Depending on the selected method, additional connection properties are required. See below for configuration steps for each supported authentication type.

Accessing Custom Fields

By default, the add-in surfaces only system fields. To detect and include custom fields set IncludeCustomFields to true. When IncludeCustomFields is set to true the add-in scans RowScanDepth records to detect custom fields and determine their datatype. Set RowScanDepth to 0 to scan all records for custom field detection. Note that enabling custom fields and setting RowScanDepth to 0 or a large value may affect performance.

Accessing List_{ListName} and Segment_{SegmentName} as separate views

By default, the add-in surfaces only the system tables and Views. To model each List and Segment as a separate view, similar to the Klaviyo interface, set ListDynamicViews to true.

Authenticating to Klaviyo

You can authenticate to Klaviyo using either an API Key or OAuth PKCE.

API Key

First, generate an API Key, if you have not done so already:

1. Log in to your user account.
2. Navigate to the Private API Key creation page.
3. Click Create Private API Key.
4. Under Private API Key Name, assign a name to the key.
5. Under Select Access Level, choose the required access level. At minimum, Accounts: Read access is required for a successful Test Connection.
6. Click Create to generate the API Key. Copy and save the generated API Key, as it is only shown once.

Next, set the following properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to the value of the Private API Key that you generated.

OAuth PKCE

Set AuthScheme to OAuthPKCE.

Desktop Applications

To authenticate using OAuth PKCE you must create a custom OAuth application. See Creating a Custom OAuth App for instructions.

Get and Refresh the OAuth Access Token

After setting the following properties, you are ready to connect:

• OAuthClientId Set this to the client Id assigned when you registered your app.
• OAuthClientSecret Set this to the client secret assigned when you registered your app. This is optional if a secret was not generated during app registration.
• CallbackURL Set this to the redirect URI defined when you registered your app. For example: http://localhost:3333

When you connect, the add-in opens Klaviyo's OAuth endpoint in your default browser. Log in and grant permissions to the application.

The add-in refreshes the access token automatically when it expires.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Klaviyo you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

• Querying Data: Use the data selection wizard to pull data into a spreadsheet. You can also configure scheduled data refresh here.
• Using the Excel Add-In: Find other ways to interact with Klaviyo data, such as using the available CData Excel Functions.