Skip to main content

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

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.

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.

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:

Field

Description

API Key Enter your Klaviyo API key. For information about obtaining an API key, visit https://help.klaviyo.com/hc/en-us/ar…unt-s-API-Keys .
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.

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.

Menu

Description

Report

Select the Klaviyo report you want to run. The following reports are available:

Report Name

Description

Campaign Information

Returns summary information for the selected campaign.

Campaigns in Account

Returns a list of all the campaigns you’ve created.

Campaign Messages

Returns a list of campaigns messages information in your account.

Campaign Recipient Estimation

Returns a list of estimated recipient count for the provided campaign IDs in your account.

Campaign Values Report

Returns the campaign analytic values data.

Export Event Data

Returns metrics about event data broken down by selected event property.

Flows

Returns information about flows in your account.

Flow Messages

Returns the flow message of a flow.

Flow Series

Returns the requested flow analytics series data.

Flow Values Report

Returns the flow analytics values of the data.

List All Templates

Returns a list of all email templates you’ve created.

List Exclusions or Unsubscribes for a List

Returns exclusions or unsubscribes for a selected list. Includes the person’s email address and the reason for/time of the exclusion.

List of Metrics

Returns a list of metrics in Klaviyo.

List Of Timeline Of All Events

Returns a batched timeline of all events in your Klaviyo account.

List Of Timeline Of All Events Append Only

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.

Listing a Person’s Complete Event Timeline

Returns a batched timeline of all events for a specified person.

Listing a Person’s Complete Event Timeline (With Extra Properties)

Returns a batched timeline of all events for a specified person with extra properties.

Listing a Person’s Complete Event Timeline (with Person’s Data)

Returns a batched timeline of all events for a specified person, with that person’s data.

Listing The Event Timeline For A Particular Metric

Returns a batched timeline for one specific type of metric.

Listing The Event Timeline For A Particular Metric (With Extra Properties)

Returns a batched timeline for one specific type of metric, with extra properties.

Listing The Event Timeline For A Particular Metric (With Person’s Data)

Returns a batched timeline for one specific type of metric with a person’s data.

Lists in Account

Returns a list of accounts.

Segments In Account

Returns a list of all the segments in your account.

Tags

Returns a list of all the tags in your account.

Tags For Campaigns

Returns a list of all tags that belong to the given campaign.

Campaign Selection

This field only appears when you select the Tags For Campaigns report or the Campaign Recipient Estimation report.

You can select any one of the three options from the drop-down list:

  • All Campaigns - Fetches all the campaigns.
  • Specific Campaigns - When you select this option, it shows the available list of campaigns from the Campaigns field. You can select the specific campaigns.
  • Enter Campaigns - When you select this option, the Enter Campaigns text box appears. You can enter the campaigns which are not available in the Campaigns field.

Campaign

This field only appears when you select the Campaign Information report.

Select the campaign for which you want to retrieve the information. You can select only one campaign from the list of available campaigns.

Campaigns

This field only appears when you select the Tags For Campaigns report or the Campaign Recipient Estimation report.

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.

Enter Campaigns

This field appears when you select the Enter Campaigns option from the Campaign Selection drop-down list.

Enter the Comma Separated campaign IDs.
To fetch the campaign IDs, run the ‘Campaigns In Account’ report and paste the comma-separated IDs without spaces. (For example: 123abc,789xyz).

List

Select the list you want to retrieve information for.

Person ID

Enter the ID of the person you want to retrieve information for.

Metric

Select the metric type you want to retrieve information for.

Type

Select whether you want to filter results by list or segment. If you select No Selection , all results are shown.

Event Property

Select the property to segment the data.

Select the granularity

Select the granularity.

Measurement

Select the measurement keys.

Duration

Select the duration for the report (a Single Date, or a Date Range).

Report Date

Select report date using relative or specific dates. Relative meaning number of days from today or a specific date using the date selector.

Select Specific Date

Select the report date using the date selector.

Days back

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.

Start Date

Select report start date using relative or specific dates. Relative meaning number of days from today or a specific date using the date selector.

Select Specific Start Date

Select the report date using the date selector.

Days back to start from

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.

End Date

Select report end date using relative or specific dates. Relative meaning number of days from today or a specific date using the date selector.

Select Specific End Date

Select the report date using the date selector.

Days back to end at

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.

Select Status of Flow Message to Retrieve

Select the status of the Flow Message.

The following options appear when you select the drop-down list:

  • Retrieve data for all Flow Messages
  • Select specific Flow Message

Select Flows

This option appears when you select the Select specific Flow Message option from the Select Status of Flow Message to Retrieve drop-down list.

Select from the list of available flows. You need to select at least one flow.

Action Flows

This option appears when you select at least one flow.
Select from the list of available action flows. You need to select at least one action flow.

Flow Message IDs

Select the Flows Message IDs. You need to select at least one flow message ID.

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.