Klaviyo: Import Users & Activity
Importing user and activity data from Klaviyo results in new users or existing user profiles supplemented with Klaviyo data. You can use this data to build and refine your existing Lytics audiences to power better, cross-channel campaigns.
Integration Details
- Implementation Type: Server-side.
- Implementation Technique: REST API.
- Frequency: Batch every hour.
- Resulting data: User profiles and raw event data.
This integration utilizes Klaviyo APIs to import user and campaign data. Once the import is started, the job will:
- Iterate through all the selected lists and for each:
- Get the lists's members.
- Iterate through all the members in a list and get the profile. If the member's profile has been updated since the last import, the member's profile is passed to
klaviyo_usersstream.
- For all the selected lists, get the activity metric data since the last import. Activity metrics are passed to
klaviyo_activitystream.
Fields
The following fields are included in the default mapping of the klaviyo_users stream. If you want to import custom user fields from Klaviyo, please contact your Lytics account manager.
| Source Field | Lytics User Field | Description | Type |
|---|---|---|---|
| $address1 | address_1 | Address Line 1 | string |
| $address2 | address_2 | Address Line 2 | string |
| $city | city | City | string |
| $country | country | string | |
| $first_name | first_name | First Name | string |
| $last_name | last_name | Last Name | string |
| $latitude | latitude | Latitude | string |
| $longitude | longitude | Longitude | string |
| $organization | organization | Organization | string |
| $phone_number | phone | Phone Number | string |
| $region | region | Region | string |
| $timezone | timezone | Timezone | string |
| $title | title | Title | string |
| $zip | zip | Zip | string |
| email($email) | email unique id | string | |
| id | ka_profile_id unique id | Klaviyo Profile Id | string |
| set(campaign_ids) | ka_campaign_ids | Klaviyo Campaigns | []string |
| set(list_ids) | ka_list_ids | Klaviyo Lists | []string |
| todate(updated) | ka_user_updated | Klaviyo Profile Updated | date |
The following fields are included in the default mapping of the klaviyo_activity stream:
| Source Field | Lytics User Field | Description | Type |
|---|---|---|---|
| Client Name | mail_client | Mail Client | string |
| Client OS Family | mail_client_os_family | Mail Client Operating System Family | string |
| Client OS | mail_client_os | Mail Client Operating System | string |
| Client Type | mail_client_type | Mail Client Type | string |
| Email Domain | emaildomain | Email Domain | string |
| count(event_name) | ka_clickct | Klaviyo Click Count | int |
| count(event_name) | ka_openct | Klaviyo Opened Email Count | int |
| count(event_name) | ka_recievedct | Klaviyo Recieved Email Count | int |
| count(event_name) | ka_unsubct | Klaviyo Unsubscribe Count | int |
| email(email) | string | ||
| epochms() | ka_recieved_ts | Klaviyo Recieved Email Time | date |
| epochms() | ka_unsub_ts | Klaviyo Unsubscribe Time | date |
| event_name | ka_email_event | Klaviyo Email Event | string |
| max(epochms()) | ka_lastclick_ts | Klaviyo Last Email Click | date |
| max(epochms()) | ka_lastopen_ts | Klaviyo Last Opened Email | date |
| max(epochms()) | last_active_ts | Last Active on Any Channel | date |
| min(epochms()) | ka_firstclick_ts | Klaviyo First Email Click | date |
| min(epochms()) | ka_firstopen_ts | Klaviyo First Opened Email | date |
| profile_id | ka_profile_id unique id | Klaviyo Profile Id | string |
| set(Subject) | ka_email_subject | Klaviyo Email Subject | []string |
| set(URL) | ka_email_url | Klaviyo Campaign URL | []string |
set(Campaign Name) | ka_campaign_name | Klaviyo Campaign Name | []string |
| set(campaign_id) | ka_campaign_ids | Klaviyo Campaign Ids | []string |
| valuect(event_name) | ka_email_eventct | Klaviyo Email Event Count | map[string]intsum |
| valuect(hash(urlmain(URL))) | hashedurls | Hashed URLs Visited | map[string]intsum |
| valuect(hourofday()) | ka_hourlyclick | Klaviyo Email Clicks By Hour | map[string]intsum |
| valuect(hourofday()) | ka_hourlyopen | Klaviyo Opened Emails By Hour | map[string]intsum |
Configuration
Follow these steps to set up and configure an import job for Klaviyo in the Lytics platform. If you are new to creating jobs in Lytics, see the Jobs Dashboard documentation for more information.
- Select Klaviyo from the list of providers.
- Select the Import Users and Activity Data job type from the list.
- Select the Authorization you would like to use or create a new one.
- Enter a Label to identify this job you are creating in Lytics.
- (Optional) Enter a Description for further context on your job.
- Complete the configuration steps for your job.
- From the Lists to Import input, select lists to import. Lists available to be imported from Klaviyo are located in the left column. Campaigns added to the right column will be imported to Lytics.
- (Optional) Select the Skip importing Klaviyo activity data checkbox to skip importing Klaviyo activity.
- (Optional) Select the Skip importing Klaviyo user profiles checkbox to skip importing Klaviyo users.
- (Optional) In the Start Date text box, enter the date to start importing Klaviyo user and activity data. Please use the format
yyyy-mm-dd, e.g.2021-01-25. - (Optional) Select the Keep Updated checkbox to continuously import data.
- Click Start Import.
