diff --git a/docs/integrations/sources/klaviyo.md b/docs/integrations/sources/klaviyo.md index fa98df3f76b0..f66377bd5c7b 100644 --- a/docs/integrations/sources/klaviyo.md +++ b/docs/integrations/sources/klaviyo.md @@ -1,10 +1,43 @@ # Klaviyo -## Sync overview +This page contains the setup guide and reference information for the Klaviyo source connector. -This source can sync data for the [Klaviyo API](https://apidocs.klaviyo.com/reference/api-overview). It supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run. +## Prerequisites -### Output schema +* Klaviyo Private API Key + +## Setup guide +### Step 1: Set up Klaviyo + +Please follow these [steps](https://help.klaviyo.com/hc/en-us/articles/115005062267-How-to-Manage-Your-Account-s-API-Keys#your-private-api-keys3) to obtain Private API Key for your account. + +### Step 2: Set up the connector in Airbyte + +### For Airbyte Cloud: + +1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account. +2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**. +3. On the Set up the source page, enter the name for the Klaviyo connector and select **Klaviyo** from the Source type dropdown. +4. Enter you private API key from Prerequisites +5. Enter the date you want your sync to start from +6. Submit the form + +### For Airbyte OSS: +1. Navigate to the Airbyte Open Source dashboard +2. Set the name for your source +4. Enter you private API key from Prerequisites +5. Enter the date you want your sync to start from +6. Click **Set up source** + +## Supported sync modes + +The Klaviyo source connector supports the following[ sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): + - Full Refresh | Overwrite + - Full Refresh | Append + - Incremental Sync | Append + - Incremental Sync | Deduped History + +## Supported Streams This Source is capable of syncing the following core Streams: @@ -14,7 +47,13 @@ This Source is capable of syncing the following core Streams: * [Lists](https://apidocs.klaviyo.com/reference/lists#get-lists-deprecated) * [Metrics](https://apidocs.klaviyo.com/en/reference/get-metrics) -### Data type mapping +## Performance considerations + +The connector is restricted by normal Klaviyo [requests limitation](https://apidocs.klaviyo.com/reference/api-overview#rate-limits). + +The Klaviyo connector should not run into Klaviyo API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully. + +## Data type map | Integration Type | Airbyte Type | Notes | |:-----------------|:-------------|:------| @@ -23,32 +62,7 @@ This Source is capable of syncing the following core Streams: | `array` | `array` | | | `object` | `object` | | -### Features - -| Feature | Supported?\(Yes/No\) | Notes | -|:------------------|:---------------------|:----------------------------------| -| Full Refresh Sync | Yes | | -| Incremental Sync | Yes | Only Events and Global Exclusions | -| Namespaces | No | | - -### Performance considerations - -The connector is restricted by normal Klaviyo [requests limitation](https://apidocs.klaviyo.com/reference/api-overview#rate-limits). - -The Klaviyo connector should not run into Klaviyo API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully. - -## Getting started - -### Requirements - -* Klaviyo Private API Key - -### Setup guide - - -Please follow these [steps](https://help.klaviyo.com/hc/en-us/articles/115005062267-How-to-Manage-Your-Account-s-API-Keys#your-private-api-keys3) to obtain Private API Key for your account. - -## CHANGELOG +## Changelog | Version | Date | Pull Request | Subject | |:--------|:-----------|:-----------------------------------------------------------|:------------------------------------------------------------------------------------------|