Klaviyo

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.

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 a Source in Hevo:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipeline List View.

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

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

    Source settings

    1. Pipeline Name: A unique name for your Pipeline.
    2. Private API Key: The private API key for your Klaviyo account.
    3. Historical Sync Duration: The duration for which the past data must be ingested.
  5. Click TEST & CONTINUE.

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

Historical Data: All past data for campaigns is fetched for the specified historical sync duration, when the Pipeline is created. Historical data for the event object is not supported.

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.

You can set the frequency of incremental data ingestion to any value between 1 hour to 48 hours. Default frequency is 6 hours.

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:

Klaviyo Schema

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.
Last updated on 10 Nov 2020