Klaviyo
This page contains the setup guide and reference information for the Klaviyo source connector.
Prerequisites
- Klaviyo account
- Klaviyo Private API key
Setup guide
Step 1: Set up Klaviyo
- Create a Klaviyo account
- Create a Private API key. Make sure you selected all scopes corresponding to the streams you would like to replicate. You can find which scope is required for a specific stream by navigating to the relevant API documentation for the streams Airbyte supports.
Step 2: Set up the Klaviyo connector in Airbyte
- Log into your Airbyte Cloud account.
- Click Sources and then click + new source.
- On the Set up the source page, select Klaviyo from the Source type dropdown.
- Enter a name for the Klaviyo connector.
- For Api Key, enter the Klaviyo Private API key.
- For Start Date, enter the date in YYYY-MM-DD format. The data added on and after this date will be replicated. This field is optional - if not provided, all data will be replicated.
- Click Set up source.
Supported sync modes
The Klaviyo source connector supports the following sync modes:
Supported Streams
- Campaigns
- Campaigns Detailed
- Email Templates
- Events
- Events Detailed
- Flows
- GlobalExclusions
- Lists
- Lists Detailed
- Metrics
- Profiles
Performance considerations
The connector is restricted by Klaviyo requests limitation.
The Klaviyo connector should not run into Klaviyo API limitations under normal usage. Create an issue if you encounter any rate limit issues that are not automatically retried successfully.
Stream Campaigns Detailed contains fields estimated_recipient_count and campaign_message in addition to info from the Campaigns stream. Additional time is needed to fetch extra data.
Stream Lists Detailed contains field profile_count in addition to info from the Lists stream. Additional time is needed to fetch extra data due to Klaviyo API limitation.
Stream Events Detailed contains field name for metric relationship - addition to info.
Data type map
| Integration Type | Airbyte Type |
|---|---|
string | string |
number | number |
array | array |
object | object |
Reference
Config fields reference
Field
Type
Property name
string
api_key
string
start_date
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 2.7.3 | 2024-07-06 | 40770 | Update dependencies |
| 2.7.2 | 2024-06-26 | 40401 | Update dependencies |
| 2.7.1 | 2024-06-22 | 40032 | Update dependencies |
2.7.0 | 2024-06-08 | 00000 | Add events_detailed stream |
2.6.4 | 2024-06-06 | 38879 | Implement CheckpointMixin for handling state in Python streams |
2.6.3 | 2024-06-04 | 38935 | [autopull] Upgrade base image to v1.2.1 |
2.6.2 | 2024-05-08 | 37789 | Move stream schemas and spec to manifest |
2.6.1 | 2024-05-07 | 38010 | Add error handler for 5XX status codes |
2.6.0 | 2024-04-19 | 37370 | Add streams campaigns_detailed and lists_detailed |
2.5.0 | 2024-04-15 | 36264 | Migrate to low-code |
2.4.0 | 2024-04-11 | 36989 | Update Campaigns schema |
2.3.0 | 2024-03-19 | 36267 | Pin airbyte-cdk version to ^0 |
2.2.0 | 2024-02-27 | 35637 | Fix predictive_analytics field in stream profiles |
2.1.3 | 2024-02-15 | 35336 | Added type transformer for the profiles stream. |
2.1.2 | 2024-02-09 | 35088 | Manage dependencies with Poetry. |
2.1.1 | 2024-02-07 | 34998 | Add missing fields to stream schemas |
2.1.0 | 2023-12-07 | 33237 | Continue syncing streams even when one of the stream fails |
2.0.2 | 2023-12-05 | 33099 | Fix filtering for archived records stream |
2.0.1 | 2023-11-08 | 32291 | Add logic to have regular checkpointing schedule |
2.0.0 | 2023-11-03 | 32128 | Use the latest API for streams campaigns, email_templates, events, flows, global_exclusions, lists, and metrics |
1.1.0 | 2023-10-23 | 31710 | Make start_date config field optional |
1.0.0 | 2023-10-18 | 31565 | added new known fields for 'events' stream |
0.5.0 | 2023-10-19 | 31611 | Add date-time format for datetime field in Events stream |
0.4.0 | 2023-10-18 | 31562 | Add archived field to Flows stream |
0.3.3 | 2023-10-13 | 31379 | Skip streams that the connector no longer has access to |
0.3.2 | 2023-06-20 | 27498 | Do not store state in the future |
0.3.1 | 2023-06-08 | 27162 | Anonymize check connection error message |
0.3.0 | 2023-02-18 | 23236 | Add Email Templates stream |
0.2.0 | 2023-03-13 | 22942 | Add Profiles stream |
0.1.13 | 2023-02-13 | 22942 | Specified date formatting in specification |
0.1.12 | 2023-01-30 | 22071 | Fix Events stream schema |
0.1.11 | 2023-01-27 | 22012 | Set AvailabilityStrategy for streams explicitly to None |
0.1.10 | 2022-09-29 | 17422 | Update CDK dependency |
0.1.9 | 2022-09-28 | 17304 | Migrate to per-stream state. |
0.1.6 | 2022-07-20 | 14872 | Increase test coverage |
0.1.5 | 2022-07-12 | 14617 | Set max_retries = 10 for lists stream. |
0.1.4 | 2022-04-15 | 11723 | Enhance klaviyo source for flows stream and update to events stream. |
0.1.3 | 2021-12-09 | 8592 | Improve performance, make Global Exclusions stream incremental and enable Metrics stream. |
0.1.2 | 2021-10-19 | 6952 | Update schema validation in SAT |