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

Unsupported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Klaviyo

Step 1: Create a Klaviyo API key

  1. Sign into your Klaviyo account.
  2. Click the user menu (top right corner of the page), then click Account.
  3. On the Account page, click Settings > API Keys.
  4. On the API Keys page, click the Create API Key button to create an API key.
  5. In the Label column, click the pencil icon next to the API key you just created.
  6. Enter a label for the API key. For example: Stitch integration.
  7. 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

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Klaviyo icon.

  4. 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.

  5. In the API Key field, paste the Klaviyo API key you created in Step 1.

Step 3: Define the historical sync

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

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:

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 tables to replicate

To complete the setup, you’ll need to select the tables you want to replicate to your destination.

Check out the Schema section to learn more about the available tables in Klaviyo and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. Repeat this process for all the tables you want to replicate.
  4. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

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.

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.

Klaviyo table reference

bounce

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

id

 API endpoint :

Metrics API

bounce table schema

id
STRING

The bounce ID.

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

timestamp
INTEGER

uuid
STRING

click

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

id

 API endpoint :

click table schema

id
STRING

The click ID.

Reference:

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

timestamp
INTEGER

uuid
STRING

dropped_email

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

id

 API endpoint :

Metrics API

dropped_email table schema

id
STRING

This is the dropped ID.

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

timestamp
INTEGER

uuid
STRING

global_exclusions

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

email
API endpoint :

Lists in Accounts

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

global_exclusions table schema

email
STRING

This is the of the globally excluded emails.

object
STRING

reason
STRING

timestamp
STRING

lists

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

None
API endpoint :

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

lists table schema

created
STRING

id
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 :
Primary Key :

id

 API endpoint :

Metrics API

mark_as_spam table schema

id
STRING

The spam ID.

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

timestamp
INTEGER

uuid
STRING

open

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

id

 API endpoint :

Metrics API

open table schema

id
STRING

This is the open ID.

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

timestamp
INTEGER

uuid
STRING

receive

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

id

 API endpoint :

Metrics API

receive table schema

id
STRING

This is the receive ID.

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

timestamp
INTEGER

uuid
STRING

subscribe_list

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

id

 API endpoint :

Metrics API

subscribe_list table schema

id
STRING

The subscribe ID.

datetime
STRING

event_name
STRING

event_properties
OBJECT

Click to expand event_properties

$event_id
STRING

List
STRING

subscribe_list (table), event_properties (attribute)

object
STRING

person
OBJECT

Click to expand person

email
STRING

subscribe_list (table), person (attribute)

statistic_id
STRING

timestamp
INTEGER

uuid
STRING

unsub_list

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

id

 API endpoint :

Metrics API

unsub_list table schema

id
STRING

This is the unsubscribe list ID.

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

timestamp
INTEGER

uuid
STRING

unsubscribe

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

None

 API endpoint :

Metrics API

unsubscribe table schema

id
STRING

The unsubscribe ID.

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

timestamp
INTEGER

uuid
STRING

update_email_preferences

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :
Primary Key :

id

 API endpoint :

API Metrics

update_email_preferences table schema

id
STRING

This is the update email ID.

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

timestamp
INTEGER

uuid
STRING

Related Troubleshooting
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.