Klaviyo

On This Page

Klaviyo is an e-mail marketing platform with email and SMS marketing automation.

You can replicate data from your Klaviyo account to the Destination database or data warehouse using Hevo Pipelines.

For creating Pipelines using this Source, Hevo provides you a fully managed BigQuery data warehouse as a possible Destination. This option remains available till the time you set up your first BigQuery Destination irrespective of any other Destinations that you may have. With the managed warehouse, you are only charged the cost that Hevo incurs for your project in Google BigQuery. The invoice is generated at the end of each month and payment is recovered as per the payment instrument you have set up. You can now create your Pipeline and directly start analyzing your Source data. Read Hevo Managed Google BigQuery.

Prerequisites

  • An active Klaviyo account from which data is to be ingested.

  • The Klaviyo API Key to allow Hevo to connect to your Klaviyo account.

Configuring Klaviyo as a Source

Perform the following steps to configure Klaviyo as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Klaviyo.

  4. In the Configure your Klaviyo Source page, specify the following:

    Source settings

    • Pipeline Name: A unique name for your Pipeline.

    • Private API Key: The private API key for your Klaviyo account.

    • Historical Sync Duration: The duration for which the past data must be ingested.

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.

Generating the API Key in Klaviyo

Perform the following steps to create an API key:

  1. Log in to your Klaviyo account.

  2. In the top right, click the drop-down next to your username, and then click Account.

    Account tab

  3. In the Account page, click Settings in the tab bar, and then, click API Keys.

    API drop-down option

  4. In the Private API Keys section, click Create API Key.

    Create API Key

    An API key is created without a label.

    New API Key without Label

  5. (Optional) Update the API key name:

    1. Click the Edit icon next to the Label field for the API to provide a name for it.

    2. In the Update API Key Label dialog, enter a name and click Save API Key.

      Add Key Label

You can see the API Key with its name in the Private API Keys section. You will use this API key to configure Klaviyo in your Hevo Pipeline.

API Key added to the list

Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
6 Hrs 1 Hr 48 Hrs 1-48

Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data: Historical data for the event object can be configured based on the user input. For the remaining objects, Hevo re-ingests all the data.

  • Incremental Data: Once the historical data is ingested, each subsequent run of the Pipeline:

    • Fetches new or incremental data for the event object.

    • Re-ingests all the Events for all the other objects.

      Note: For each distinct campaign, the Campaign Recipient(s) is fetched only once.

Source Considerations

  • The Change Position option is possible only for the Event object. You can modify the date/time to a past value to re-load data since then.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination:

Data Model

Hevo uses the following data model to ingest data from your Klaviyo account:

Object Description
Campaign Details of a campaign including its type, status, and schedule for sending the mails for it. Each Event may be associated to a Campaign, which further has a list of users associated with it.
Campaign Recipient Recipient(s) associated with a Campaign.
Event One or more Events associated with a Metric, in a timeline format, which are ingested by the Pipeline.
List of Events:
-Bounced Email
-Clicked Email
-Dropped Email
-Marked Email as Spam
-Opened Email
-Received Email
-Subscribed to List
-Unsubscribed
-Unsubscribed from List
-Updated Email Preferences
-Custom Tracking
List The users that are subscribers of a given Campaign.
List Exclusions Any un-subscribers from a Campaign. Corresponding to each List, a List Exclusion object is created.
Metric The list of metrics that are captured on Klaviyo.
For example: Email Open, Website Visit
Person The profile associated with an Event.

Limitations

  • None.

Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Apr-18-2022 NA Updated the historical data point in the Data Replication section to correctly reflect how historical data is ingested for every object.
Oct-25-2021 NA Added the Pipeline frequency information in the Data Replication section.
Jul-26-2021 NA Added a note in the Overview section about Hevo providing a fully-managed Google BigQuery Destination for Pipelines created with this Source.
Last updated on 09 May 2022
Was this page helpful?