Klaviyo (v1) | Stitch Documentation

Klaviyo is supported by the Singer community
This integration is powered by Singer's Klaviyo tap. For support, visit the GitHub repo or join the Singer Slack.

Klaviyo feature snapshot

A high-level look at Stitch's Klaviyo (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status	Released on December 14, 2017	Supported by	Singer Community
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-klaviyo
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Klaviyo

Step 1: Create a Klaviyo API key

Sign into your Klaviyo account.
Click the user menu (top right corner of the page), then click Account.
On the Account page, click Settings > API Keys.
On the API Keys page, click the Create API Key button to create an API key.
In the Label column, click the pencil icon next to the API key you just created.
Enter a label for the API key. For example: Stitch integration.
Click Save API Key.

Klaviyo API key

Keep this page open for now - you’ll need it to complete the setup in Stitch.

Step 2: Add Klaviyo as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Klaviyo icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

For example, the name “Stitch Klaviyo” would create a schema called stitch_klaviyo in the destination. Note: Schema names cannot be changed after you save the integration.
In the API Key field, paste the Klaviyo API key you created in Step 1.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Klaviyo integration. This means that:

For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

Change this setting if you want to replicate data beyond Klaviyo’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Klaviyo integrations support the following replication scheduling methods:

Replication Frequency
Anchor Scheduling
Advanced Scheduling using Cron (Unlimited or Unlimited Plus plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements for selection and replication.

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Klaviyo integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’s Tables to Replicate tab, locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
Repeat this process for all the tables and columns you want to replicate.
When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Important: Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections. Refer to the Select All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click the Tables to Replicate tab.
In the list of tables, click the box next to the Table Names column.
In the menu that displays, click Track all Tables and Fields:
Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Klaviyo, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

Klaviyo table reference

Schemas and versioning

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for version 1 of this integration.

This is the latest version of the Klaviyo integration.

Table and column names in your destination

Depending on your destination, table and column names may not appear as they are outlined below.

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

bounce

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	id	API endpoint :	Get metrics info

The bounce table contains metrics related to Bounced Email events.

bounce table schema

id
STRING

The bounced email event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

object
STRING

person
OBJECT

Click to expand person

email
STRING

bounce (table), person (attribute)

statistic_id
STRING

uuid
STRING

campaigns

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	id
API endpoint :	Get campaigns

The campaigns table contains info about the campaigns in your Klaviyo account.

campaigns table schema

id
STRING

The campaign ID.

campaign_type
STRING

created
STRING

excluded_lists
ARRAY

Click to expand excluded_lists

id
STRING

The list ID.

Reference:

campaigns.excluded_lists.id
campaigns.lists.id
lists.id

created
STRING

name
STRING

object
STRING

person_count
INTEGER

type
STRING

updated
STRING

campaigns (table), excluded_lists (attribute)

from_email
STRING

from_name
STRING

is_segmented
BOOLEAN

lists
ARRAY

Click to expand lists

id
STRING

The list ID.

Reference:

campaigns.excluded_lists.id
campaigns.lists.id
lists.id

created
STRING

name
STRING

object
STRING

person_count
INTEGER

type
STRING

updated
STRING

campaigns (table), lists (attribute)

message_type
STRING

name
STRING

num_recipients
INTEGER

object
STRING

send_time
DATE-TIME

sent_at
DATE-TIME

status_id
INTEGER

status_label
STRING

subject
STRING

template_id
STRING

type
STRING

updated
STRING

click

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	id	API endpoint :	Get metrics info

The click table contains metrics related to Clicked Email events.

click table schema

id
STRING

The clicked email event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

object
STRING

person
OBJECT

Click to expand person

email
STRING

click (table), person (attribute)

statistic_id
STRING

uuid
STRING

dropped_email

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	id	API endpoint :	Get metrics info

The dropped_email table contains metrics related to Clicked Email events.

dropped_email table schema

id
STRING

The dropped email event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

object
STRING

person
OBJECT

Click to expand person

email
STRING

dropped_email (table), person (attribute)

statistic_id
STRING

uuid
STRING

global_exclusions

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	email
API endpoint :	Get global exclusions

The global_exclusions table contains info about the global exclusions in your Klaviyo account.

global_exclusions table schema

email
STRING

object
STRING

reason
STRING

timestamp
STRING

lists

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	id
API endpoint :	Get lists

The lists table contains info about the lists in your Klaviyo account.

lists table schema

id
STRING

The list ID.

created
STRING

name
STRING

object
STRING

person_count
INTEGER

type
STRING

updated
STRING

mark_as_spam

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	id	API endpoint :	Get metrics info

The mark_as_spam table contains metrics related to Marked Email as Spam events.

mark_as_spam table schema

id
STRING

The marked as spam event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

object
STRING

person
OBJECT

Click to expand person

email
STRING

mark_as_spam (table), person (attribute)

statistic_id
STRING

uuid
STRING

open

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	id	API endpoint :	Get metrics info

The open table contains metrics related to Opened Email events.

open table schema

id
STRING

The opened email event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

object
STRING

person
OBJECT

Click to expand person

email
STRING

open (table), person (attribute)

statistic_id
STRING

uuid
STRING

receive

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	id	API endpoint :	Get metrics info

The receive table contains metrics related to Received Email events.

receive table schema

id
STRING

The received email event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

object
STRING

person
OBJECT

Click to expand person

email
STRING

receive (table), person (attribute)

statistic_id
STRING

uuid
STRING

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	None	API endpoint :	Get metrics info

The subscribe_list table contains metrics related to Subscribed to List events.

subscribe_list table schema

id
STRING

The subscribe to list event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

object
STRING

person
OBJECT

statistic_id
STRING

uuid
STRING

unsubscribe

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	None	API endpoint :	Get metrics info

The unsubscribe table contains metrics related to Unsubscribed events.

unsubscribe table schema

id
STRING

The unsubscribe event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

object
STRING

person
OBJECT

Click to expand person

email
STRING

unsubscribe (table), person (attribute)

statistic_id
STRING

uuid
STRING

unsub_list

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	None	API endpoint :	Get metrics info

The unsub_list table contains metrics related to Unsubscribed from List events.

unsub_list table schema

id
STRING

The unsubscribe to list event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

Click to expand event_properties

$event_id
STRING

List
STRING

unsub_list (table), event_properties (attribute)

object
STRING

person
OBJECT

Click to expand person

email
STRING

unsub_list (table), person (attribute)

statistic_id
STRING

uuid
STRING

update_email_preferences

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	timestamp
Primary Key :	None	API endpoint :	Get metrics info

The update_email_preferences table contains metrics related to Updated Email Preferences events.

update_email_preferences table schema

id
STRING

The update email preferences event ID.

timestamp
INTEGER

datetime
STRING

event_name
STRING

event_properties
OBJECT

Click to expand event_properties

$event_id
STRING

List
STRING

update_email_preferences (table), event_properties (attribute)

object
STRING

person
OBJECT

Click to expand person

email
STRING

update_email_preferences (table), person (attribute)

statistic_id
STRING

uuid
STRING

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Third-Party Downtime Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues