jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-21 19:11:14 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
baf4633ab8b51a55276115ea083837d8632fe217
airbyte/docs/integrations/sources/klaviyo.md

14 KiB
Raw Blame History

Klaviyo

This page contains the setup guide and reference information for the Klaviyo source connector.

Prerequisites

Setup guide

Step 1: Set up Klaviyo

  1. Create a Klaviyo account
  2. 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

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Klaviyo from the Source type dropdown.
  4. Enter a name for the Klaviyo connector.
  5. For Api Key, enter the Klaviyo Private API key.
  6. 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.
  7. Click Set up source.

For Airbyte Open Source:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Klaviyo from the Source type dropdown.
  4. Enter a name for the Klaviyo connector.

Supported sync modes

The Klaviyo source connector supports the following sync modes:

Supported Streams

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.

The Campaigns Detailed stream contains fields estimated_recipient_count and campaign_message in addition to info from the Campaigns stream. Additional time is needed to fetch extra data.

The Lists Detailed stream 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.

The Events Detailed stream contains field name for metric relationship - addition to info.

The Profiles stream can experience transient API errors under heavy load. In order to mitigate this, you can use the "Disable Fetching Predictive Analytics" setting to improve the success rate of syncs.

:::warning Using the "Disable Fetching Predictive Analytics" will stop records on the Profiles stream will no longer contain the predictive_analytics field and workflows depending on this field will stop working. :::

Data type map

Integration Type Airbyte Type
string string
number number
array array
object object

Changelog

Expand to review
Version Date Pull Request Subject
2.10.10 2024-10-14 46741 Add checkpointing to events stream to improve large syncs after clear data
2.10.9 2024-10-12 46787 Update dependencies
2.10.8 2024-10-05 46503 Update dependencies
2.10.7 2024-09-28 46174 Update dependencies
2.10.6 2024-09-21 45813 Update dependencies
2.10.5 2024-09-14 45530 Update dependencies
2.10.4 2024-09-07 45244 Update dependencies
2.10.3 2024-08-31 45064 Update dependencies
2.10.2 2024-08-30 44930 Fix typing in profiles stream for field attributes.location.region
2.10.1 2024-08-24 44628 Update dependencies
2.10.0 2024-08-18 44366 Add field[metrics] to events stream
2.9.4 2024-08-17 44317 Update dependencies
2.9.3 2024-08-12 43806 Update dependencies
2.9.2 2024-08-10 43613 Update dependencies
2.9.1 2024-08-03 43247 Update dependencies
2.9.0 2024-08-01 42891 Migrate to CDK v4.X and remove custom BackoffStrategy implementation
2.8.2 2024-07-31 42895 Add config option disable_fetching_predictive_analytics to prevent 503 Service Unavailable errors
2.8.1 2024-07-27 42664 Update dependencies
2.8.0 2024-07-19 42121 Migrate to CDK v3.9.0
2.7.8 2024-07-20 42185 Update dependencies
2.7.7 2024-07-08 40608 Update the events_detailed stream to improve efficiency using the events API
2.7.6 2024-07-13 41903 Update dependencies
2.7.5 2024-07-10 41548 Update dependencies
2.7.4 2024-07-09 41211 Update dependencies
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 39350 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 Add 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
Reference in New Issue View Git Blame Copy Permalink