> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Klaviyo Connector

## Intro

Klaviyo allows e-commerce marketers to target, personalize, measure, and optimize email and Facebook campaigns. To learn more about the Klaviyo API, visit their page ([https://www.klaviyo.com/docs](https://www.klaviyo.com/docs "https://www.klaviyo.com/docs") ).

You connect to your Klaviyo account in the Data Center. This topic discusses the fields and menus specific to the Klaviyo connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").

## Prerequisites

To connect to your Klaviyo account and create a DataSet, you must have a Klaviyo API key. For information about obtaining an API key, visit [https://help.klaviyo.com/hc/en-us/ar...unt-s-API-Keys](https://help.klaviyo.com/hc/en-us/articles/115005062267-Manage-Your-Account-s-API-Keys "https://help.klaviyo.com/hc/en-us/articles/115005062267-Manage-Your-Account-s-API-Keys").

## Connecting to Your Klaviyo Account

This section enumerates the options in the **Credentials** and **Details** panes on the Klaviyo Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").

## Credentials Pane

This pane contains fields for entering credentials to connect to your Klaviyo account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"> API Key </td><td colspan="1" rowspan="1"> Enter your Klaviyo API key. For information about obtaining an API key, visit <a href="https://help.klaviyo.com/hc/en-us/articles/115005062267-Manage-Your-Account-s-API-Keys" target="_blank" title="https://help.klaviyo.com/hc/en-us/articles/115005062267-Manage-Your-Account-s-API-Keys"> [https://help.klaviyo.com/hc/en-us/ar...unt-s-API-Keys](https://help.klaviyo.com/hc/en-us/ar...unt-s-API-Keys) </a>. </td></tr></tbody></table>

Once you have entered valid Klaviyo credentials, you can use the same account any time you go to create a new Klaviyo DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Manage Connector Accounts](https://domo-support.domo.com/s/article/360042926054?language=en_US "Manage Connector Accounts").

## Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the Klaviyo report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p><b> Report Name </b></p></td><td colspan="1" rowspan="1"><p><b> Description </b></p></td></tr><tr><td colspan="1" rowspan="1"><p> Campaign Information </p></td><td colspan="1" rowspan="1"><p> Returns summary information for the selected campaign. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Campaigns in Account </p></td><td colspan="1" rowspan="1"><p> Returns a list of all the campaigns you've created. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Campaign Messages </p></td><td colspan="1" rowspan="1"><p> Returns a list of campaigns messages information in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Campaign Recipient Estimation </p></td><td colspan="1" rowspan="1"><p> Returns a list of estimated recipient count for the provided campaign IDs in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Campaign Values Report </p></td><td colspan="1" rowspan="1"><p> Returns the campaign analytic values data. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Export Event Data </p></td><td colspan="1" rowspan="1"><p> Returns metrics about event data broken down by selected event property. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Flows </p></td><td colspan="1" rowspan="1"><p> Returns information about flows in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Flow Messages </p></td><td colspan="1" rowspan="1"><p> Returns the flow message of a flow. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Flow Series </p></td><td colspan="1" rowspan="1"><p> Returns the requested flow analytics series data. </p></td></tr><tr><td colspan="1" rowspan="1"><p /><p> Flow Values Report </p><p /></td><td colspan="1" rowspan="1"><p> Returns the flow analytics values of the data. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List All Templates </p></td><td colspan="1" rowspan="1"><p> Returns a list of all email templates you've created. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List Exclusions or Unsubscribes for a List </p></td><td colspan="1" rowspan="1"><p> Returns exclusions or unsubscribes for a selected list. Includes the person's email address and the reason for/time of the exclusion. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List of Metrics </p></td><td colspan="1" rowspan="1"><p> Returns a list of metrics in Klaviyo. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List Of Timeline Of All Events </p></td><td colspan="1" rowspan="1"><p> Returns a batched timeline of all events in your Klaviyo account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List Of Timeline Of All Events Append Only </p></td><td colspan="1" rowspan="1"><p> Returns a batched timeline of all events in your Klaviyo account. This report works in Append mode only and fetches the data after the last successful run, assuming that the end date offset is 1. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Listing a Person's Complete Event Timeline </p></td><td colspan="1" rowspan="1"><p> Returns a batched timeline of all events for a specified person. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Listing a Person's Complete Event Timeline (With Extra Properties) </p></td><td colspan="1" rowspan="1"><p> Returns a batched timeline of all events for a specified person with extra properties. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Listing a Person's Complete Event Timeline (with Person's Data) </p></td><td colspan="1" rowspan="1"><p> Returns a batched timeline of all events for a specified person, with that person's data. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Listing The Event Timeline For A Particular Metric </p></td><td colspan="1" rowspan="1"><p> Returns a batched timeline for one specific type of metric. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Listing The Event Timeline For A Particular Metric (With Extra Properties) </p></td><td colspan="1" rowspan="1"><p> Returns a batched timeline for one specific type of metric, with extra properties. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Listing The Event Timeline For A Particular Metric (With Person's Data) </p></td><td colspan="1" rowspan="1"><p> Returns a batched timeline for one specific type of metric with a person's data. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Lists in Account </p></td><td colspan="1" rowspan="1"><p> Returns a list of accounts. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Segments In Account </p></td><td colspan="1" rowspan="1"><p> Returns a list of all the segments in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Tags </p></td><td colspan="1" rowspan="1"><div><div><div><div><div><div><div><div><div> Returns a list of all the tags in your account. </div></div></div></div></div></div></div></div></div></td></tr><tr><td colspan="1" rowspan="1"><p> Tags For Campaigns </p></td><td colspan="1" rowspan="1"><div><div><div><div><div><div><div><div><div> Returns a list of all tags that belong to the given campaign. </div></div></div></div></div></div></div></div></div></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Campaign Selection </p></td><td colspan="1" rowspan="1"><p> This field only appears when you select the <b> Tags For Campaigns </b> report or the <b> Campaign Recipient Estimation </b> report. </p><p> You can select any one of the three options from the drop-down list: </p><ul><li><b> All Campaigns </b> - Fetches all the campaigns. </li><li><b> Specific Campaigns </b> - When you select this option, it shows the available list of campaigns from the <b> Campaigns </b> field. You can select the specific campaigns. </li><li><b> Enter Campaigns </b> - When you select this option, the <b> Enter Campaigns </b> text box appears. You can enter the campaigns which are not available in the <b> Campaigns </b> field. </li></ul></td></tr><tr><td colspan="1" rowspan="1"><p> Campaign </p></td><td colspan="1" rowspan="1"><p> This field only appears when you select the <b> Campaign Information </b> report. </p><p> Select the campaign for which you want to retrieve the information. You can select only one campaign from the list of available campaigns. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Campaigns </p></td><td colspan="1" rowspan="1"><p> This field only appears when you select the <b> Tags For Campaigns </b> report or the <b> Campaign Recipient Estimation </b> report. </p><p> Select the campaign(s) for which you want to retrieve the information. You have the option to select multiple campaigns from the list of available campaigns. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Enter Campaigns </p></td><td colspan="1" rowspan="1"><p> This field appears when you select the <b> Enter Campaigns </b> option from the <b> Campaign Selection </b> drop-down list. </p><p> Enter the Comma Separated campaign IDs. <br /> To fetch the campaign IDs, run the 'Campaigns In Account' report and paste the comma-separated IDs without spaces. (For example: 123abc,789xyz). </p></td></tr><tr><td colspan="1" rowspan="1"><p> List </p></td><td colspan="1" rowspan="1"><p> Select the list you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Person ID </p></td><td colspan="1" rowspan="1"><p> Enter the ID of the person you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Metric </p></td><td colspan="1" rowspan="1"><p> Select the metric type you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Type </p></td><td colspan="1" rowspan="1"><p> Select whether you want to filter results by list or segment. If you select <b> No Selection </b>, all results are shown. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Event Property </p></td><td colspan="1" rowspan="1"><p> Select the property to segment the data. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select the granularity </p></td><td colspan="1" rowspan="1"><p> Select the granularity. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Measurement </p></td><td colspan="1" rowspan="1"><p> Select the measurement keys. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Duration </p></td><td colspan="1" rowspan="1"><p> Select the duration for the report (a Single Date, or a Date Range). </p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Date </p></td><td colspan="1" rowspan="1"><p> Select report date using relative or specific dates. Relative meaning number of days from today or a specific date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Date </p></td><td colspan="1" rowspan="1"><p> Select the report date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days back </p></td><td colspan="1" rowspan="1"><p> The number of days back that you would like to get data for. Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Start Date </p></td><td colspan="1" rowspan="1"><p> Select report start date using relative or specific dates. Relative meaning number of days from today or a specific date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1"><p> Select the report date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days back to start from </p></td><td colspan="1" rowspan="1"><p> The number of days back that you would like to get data from (start day). Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past. </p></td></tr><tr><td colspan="1" rowspan="1"><p> End Date </p></td><td colspan="1" rowspan="1"><p> Select report end date using relative or specific dates. Relative meaning number of days from today or a specific date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1"><p> Select the report date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days back to end at </p></td><td colspan="1" rowspan="1"><p> The number of days back that you would like to get data to (end day). Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Status of Flow Message to Retrieve </p></td><td colspan="1" rowspan="1"><p> Select the status of the Flow Message. </p><p> The following options appear when you select the drop-down list: </p><ul><li> Retrieve data for all Flow Messages </li><li> Select specific Flow Message </li></ul></td></tr><tr><td colspan="1" rowspan="1"><p> Select Flows </p></td><td colspan="1" rowspan="1"><p> This option appears when you select the <b> Select specific Flow Message </b> option from the <b> Select Status of Flow Message to Retrieve </b> drop-down list. </p><p> Select from the list of available flows. You need to select at least one flow. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Action Flows </p></td><td colspan="1" rowspan="1"><p> This option appears when you select at least one flow. <br /> Select from the list of available action flows. You need to select at least one action flow. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Flow Message IDs </p></td><td colspan="1" rowspan="1"><p> Select the Flows Message IDs. You need to select at least one flow message ID. </p></td></tr></tbody></table>

## Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").
