Pull from Klaviyo¶

Klaviyo is an email platform for targeting, personalizing, measuring, and optimizing email and Facebook campaigns.

Klaviyo can send email engagement metrics to Amperity using the events API , which provides email events data for opens, clicks (for email and SMS), bounces, opt-ins, unsubscribes, custom metrics, and more .

This topic describes the steps that are required to pull email engagement metrics to Amperity from Klaviyo:

Get details
Add courier
Run courier
Review feed and domain table
Add to courier group

Get details¶

Klaviyo requires the following configuration details:

The API key for Klaviyo.

Tip

Use SnapPass to securely share configuration details for Klaviyo between your company and your Amperity representative.

Add courier¶

A courier brings data from an external system to Amperity.

To add a courier

From the Sources page, click Add Courier. The Add Source page opens.
Find, and then click the icon for Klaviyo. The Add Courier page opens.

This automatically selects klaviyo as the Credential Type.
Enter the name of the courier. For example: “Klaviyo”.
From the Credential field, select an existing credential or select Create a new credential.

To add a credential, enter the name of the credential, a description, the Klaviyo API key. Click Save.
Under Select Data, enable Email Metrics.
Click Create.

Run courier manually¶

Run the courier again. This time, because the load operations are present and the feeds are configured, the courier will pull data from Klaviyo.

To run the courier manually

From the Sources tab, open the menu for the courier with updated load operations that is configured for Klaviyo, and then select Run. The Run Courier dialog box opens.
Select the load option, either for a specific time period or all available data. Actual data will be loaded to a domain table because the feed is configured.
Click Run.

This time the notification will return a message similar to:
```
Completed in 5 minutes 12 seconds
```

Review feed and domain table¶

After running the Klaviyo courier a feed is created automatically with a pre-defined list of fields. You may apply semantic tags to these fields and you may make the domain table available to Stitch, depending on your use cases. A domain table named Klaviyo:Email metrics will be added.

The feed and domain table will pull in the following fields:

emailAddress (assigned the email-event/email semantic tag)
eventDateTime (assigned the email-event/event-datetime semantic tag)
eventType (assigned the email-event/event-type semantic tag)
eventUuid (assigned the pk semantic tag)
metricId
sendId (assigned the email-event/send-id semantic tag)

Add to courier group¶

From the Sources tab, click Add Courier Group. This opens the Create Courier Group dialog box.
Enter the name of the courier. For example: “Klaviyo”.
Add a cron string to the Schedule field to define a schedule for the orchestration group.

A schedule defines the frequency at which a courier group runs. All couriers in the same courier group run as a unit and all tasks must complete before a downstream process can be started. The schedule is defined using cron.

Cron syntax specifies the fixed time, date, or interval at which cron will run. Each line represents a job, and is defined like this:
```
┌───────── minute (0 - 59)
│ ┌─────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌────────────── month (1 - 12)
│ │ │ │ ┌─────────────── day of the week (0 - 6) (Sunday to Saturday)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │
* * * * * command to execute
```
For example, 30 8 * * * represents “run at 8:30 AM every day” and 30 8 * * 0 represents “run at 8:30 AM every Sunday”. Amperity validates your cron syntax and shows you the results. You may also use crontab guru to validate cron syntax.
Set Status to Enabled.
Specify a time zone.

A courier group schedule is associated with a time zone. The time zone determines the point at which a courier group’s scheduled start time begins. A time zone should be aligned with the time zone of system from which the data is being pulled.

Use the Use this time zone for file date ranges checkbox to use the selected time zone to look for files. If unchecked, the courier group will use the current time in UTC to look for files to pick up.

Note

The time zone that is chosen for an courier group schedule should consider every downstream business processes that requires the data and also the time zone(s) in which the consumers of that data will operate.
Add at least one courier to the courier group. Select the name of the courier from the Courier drop-down. Click + Add Courier to add more couriers.
Click Add a courier group constraint, and then select a courier group from the drop-down list.

A wait time is a constraint placed on a courier group that defines an extended time window for data to be made available at the source location.

Important

A wait time is not required for a bridge.

A courier group typically runs on an automated schedule that expects customer data to be available at the source location within a defined time window. However, in some cases, the customer data may be delayed and isn’t made available within that time window.
For each courier group constraint, apply any offsets.

A courier can be configured to look for files within range of time that is older than the scheduled time. The scheduled time is in Coordinated Universal Time (UTC), unless the “Use this time zone for file date ranges” checkbox is enabled for the courier group.

This range is typically 24 hours, but may be configured for longer ranges. For example, it’s possible for a data file to be generated with a correct file name and datestamp appended to it, but for that datestamp to represent the previous day because of how an upstream workflow is configured. A wait time helps ensure that the data at the source location is recognized correctly by the courier.

Warning

This range of time may affect couriers in a courier group whether or not they run on a schedule. A manually run courier group may not take its schedule into consideration when determining the date range; only the provided input day(s) to load data from are used as inputs.
Click Save.