The tap-klaviyo Meltano extractor pulls data from Klaviyo that can then be sent to a destination using a loader.

Alternative variants #

Multiple variants of tap-klaviyo are available. This document describes the default hotgluexyz variant, which is recommended for new users.

Alternative variants are:

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

Using the Command Line Interface #

  1. Add the tap-klaviyo extractor to your project using meltano add : 

    meltano add extractor tap-klaviyo
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, learn how to get help.

Capabilities #

Settings #

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

API Key (api_key) #

Klaviyo API Key

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-klaviyo set api_key <api_key>

export TAP_KLAVIYO_API_KEY=<api_key>

User Agent (user_agent) #

Klaviyo user agent

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-klaviyo set user_agent <user_agent>

export TAP_KLAVIYO_USER_AGENT=<user_agent>

Start Date (start_date) #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-klaviyo set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_KLAVIYO_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Looking for help? #

If you're having trouble getting the tap-klaviyo extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!