diff --git a/docs/integrations/sources/amplitude.md b/docs/integrations/sources/amplitude.md index d267da413a62a..6bc9546a35d70 100644 --- a/docs/integrations/sources/amplitude.md +++ b/docs/integrations/sources/amplitude.md @@ -1,38 +1,24 @@ # Amplitude -This page contains the setup guide and reference information for the `Amplitude` source connector. -This source can sync data for the [Amplitude API](https://developers.amplitude.com/docs/http-api-v2). +This page guides you through setting up the Amplitude source connector to sync data for the [Amplitude API](https://developers.amplitude.com/docs/http-api-v2). -## Prerequisites +## Prerequisite -Before you begin replicating the data from `Amplitude`, please follow this guide to obtain your credentials [How to get your API key and Secret key](https://help.amplitude.com/hc/en-us/articles/360058073772-Create-and-manage-organizations-and-projects#view-and-edit-your-project-information). -Once you have your credentials, you now can use them in order to setup the connection in Airbyte. +To set up the Amplitude source connector, you'll need your Amplitude [`API Key` and `Secret Key`](https://help.amplitude.com/hc/en-us/articles/360058073772-Create-and-manage-organizations-and-projects#view-and-edit-your-project-information). -## Setup guide -### Step 1: Set up Amplitude source -You would need to obtain your Amplitude `API Key` and `Secret Key` using this [guide](https://help.amplitude.com/hc/en-us/articles/360058073772-Create-and-manage-organizations-and-projects#view-and-edit-your-project-information) to set up the connector in Airbyte. +## Set up the Amplitude source connector -### Step 2: Set up Amplitude source connector in Airbyte - -### For OSS Airbyte: -1. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. -2. On the Set up the `source` page, enter the name for the `Amplitude` connector and select **Amplitude** from the Source type dropdown. -3. Enter your `API Key` and `Secret Key` to corresponding fields -4. Enter the `Start Date` as the statrting point for your data replication. -5. Click on `Check Connection` to finish configuring the Amplitude source. - -### 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 `Amplitude` connector and select **Amplitude** from the Source type dropdown. -4. Enter your `API Key` and `Secret Key` to corresponding fields -5. Enter the `Start Date` as the statrting point for your data replication. -6. Click on `Check Connection` to finish configuring the Amplitude source. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +2. Click **Sources** and then click **+ New source**. +3. On the Set up the source page, select **Amplitude** from the Source type dropdown. +4. Enter a name for your source. +5. For **API Key** and **Secret Key**, enter the Amplitude [API key and secret key](https://help.amplitude.com/hc/en-us/articles/360058073772-Create-and-manage-organizations-and-projects#view-and-edit-your-project-information). +6. For **Replication Start Date**, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. +7. Click **Set up source**. ## Supported Streams -Several output streams are available from this source: +The Amplitude source connector supports the following streams: * [Active Users Counts](https://developers.amplitude.com/docs/dashboard-rest-api#active-and-new-user-counts) \(Incremental sync\) * [Annotations](https://developers.amplitude.com/docs/chart-annotations-api#get-all-annotations) @@ -44,16 +30,14 @@ If there are more endpoints you'd like Airbyte to support, please [create an iss ## Supported sync modes -The `Amplitude` source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): +The Amplitude source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): -| Feature | Supported? | -|:------------------|:-----------| -| Full Refresh Sync | Yes | -| Incremental Sync | Yes | +- Full Refresh +- Incremental -### Performance considerations +## Performance considerations -The Amplitude connector should gracefully handle Amplitude 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. +The Amplitude connector ideally should gracefully handle Amplitude API limitations under normal usage. [Create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully. ## Changelog diff --git a/docs/integrations/sources/hubspot.md b/docs/integrations/sources/hubspot.md index 97be9b1e0cb45..2e59a95224970 100644 --- a/docs/integrations/sources/hubspot.md +++ b/docs/integrations/sources/hubspot.md @@ -1,6 +1,6 @@ # HubSpot -This page guides you through the process of setting up the HubSpot source connector. +This page guides you through setting up the HubSpot source connector. ## Prerequisite @@ -39,8 +39,8 @@ You can use OAuth or an API key to authenticate your HubSpot account. If you cho 4. Enter a name for your source. 5. For **Start date**, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. 6. You can use OAuth or an API key to authenticate your HubSpot account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte OSS. - - To authenticate using OAuth for Airbyte Cloud, click **Authenticate your HubSpot account** to sign in with HubSpot and authorize your account. - - To authenticate using API key for Airbyte OSS, select **API key** from the Authentication dropdown and enter the [API key](https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key) for your HubSpot account. + - To authenticate using OAuth for Airbyte Cloud, ensure you have [set the appropriate scopes for HubSpot](#prerequisite) and then click **Authenticate your HubSpot account** to sign in with HubSpot and authorize your account. + - To authenticate using an API key for Airbyte OSS, select **API key** from the Authentication dropdown and enter the [API key](https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key) for your HubSpot account. :::note Check the [performance considerations](#performance-considerations) before using an API key. ::: @@ -119,6 +119,12 @@ Example of the output message when trying to read `workflows` stream with missin HubSpot's API will [rate limit](https://developers.hubspot.com/docs/api/usage-details) the amount of records you can sync daily, so make sure that you are on the appropriate plan if you are planning on syncing more than 250,000 records per day. +## Tutorials + +Now that you have set up the Mailchimp source connector, check out the following Hubspot tutorial: + +[Build a single customer view with open-source tools](https://airbyte.com/tutorials/single-customer-view) + ## Changelog | Version | Date | Pull Request | Subject | diff --git a/docs/integrations/sources/mailchimp.md b/docs/integrations/sources/mailchimp.md index 2fd0744aab173..7d8ad049d82be 100644 --- a/docs/integrations/sources/mailchimp.md +++ b/docs/integrations/sources/mailchimp.md @@ -1,67 +1,41 @@ # Mailchimp -This page guides you through the process of setting up the Mailchimp source connector. +This page guides you through setting up the Mailchimp source connector. -## Prerequisites +## Prerequisite -For API Key authorization: -* Mailchimp account -* Mailchimp API key +You can use [OAuth](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/) or an API key to authenticate your Mailchimp account. If you choose to authenticate with OAuth, [register](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/#register-your-application) your Mailchimp account. -For OAuth2.0 authorization: -* Mailchimp registered app -* Mailchimp `client_id` -* Mailchimp `client_secret` - -## Step 1: Set up Mailchimp - -[Log in](https://login.mailchimp.com/) to Mailchimp account. -If you don't have a Mailchimp account already, you’ll need to [create](https://login.mailchimp.com/signup/) one in order to use the API. - -## Step 2: Set up the source connector in Airbyte - -**For Airbyte Cloud:** - -1. For using [OAuth2.0](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/) creds, -please [register](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/#register-your-application) -your Mailchimp account. -2. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account. -3. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. -4. On the source setup page, select **Mailchimp** from the Source type dropdown and enter a name for this connector. -5. Select `OAuth2.0` Authorization method, then click `Authenticate your account`. -6. Log in and Authorize to the Mailchimp account and click `Set up source`. - -**For Airbyte OSS:** - -1. For using an API key, [create an account](https://mailchimp.com/developer/marketing/guides/quick-start/#create-an-account) -in Mailchimp. -2. [Generate](https://mailchimp.com/developer/marketing/guides/quick-start/#generate-your-api-key) API key. -3. Go to local Airbyte page. -4. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. -5. On the Set up the source page, enter the name for the Mailchimp connector and select **Mailchimp** from the Source type dropdown. -6. Select `API key` Authorization method, then copy and paste your API key from step 2. -7. Click `Set up source`. +## Set up the Mailchimp source connector +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +2. Click **Sources** and then click **+ New source**. +3. On the Set up the source page, select **Mailchimp** from the Source type dropdown. +4. Enter a name for your source. +6. You can use OAuth or an API key to authenticate your Mailchimp account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte OSS. + - To authenticate using OAuth for Airbyte Cloud, ensure you have [registered your Mailchimp account](#prerequisite) and then click **Authenticate your Mailchimp account** to sign in with Mailchimp and authorize your account. + - To authenticate using an API key for Airbyte OSS, select **API key** from the Authentication dropdown and enter the [API key](https://mailchimp.com/developer/marketing/guides/quick-start/#generate-your-api-key) for your Mailchimp account. + :::note + Check the [performance considerations](#performance-considerations) before using an API key. + ::: +7. Click **Set up source**. ## Supported sync modes The Mailchimp source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-mode): + - Full Refresh - Incremental -We don't support Incremental Deletes for `Campaigns`, `Lists`, and `Email Activity` streams because -the Mailchimp doesn't give any information about deleted data in these streams. +Airbyte doesn't support Incremental Deletes for the `Campaigns`, `Lists`, and `Email Activity` streams because Mailchimp doesn't provide any information about deleted data in these streams. ## Performance considerations -At the time of this writing, [Mailchimp does not impose rate limits](https://mailchimp.com/developer/guides/marketing-api-conventions/#throttling) -on how much data is read from its API in a single sync process. However, Mailchimp enforces a maximum of 10 simultaneous -connections to its API. This means that Airbyte will not be able to run more than 10 concurrent syncs from Mailchimp -using API keys generated from the same account. +[Mailchimp does not impose rate limits](https://mailchimp.com/developer/guides/marketing-api-conventions/#throttling) on how much data is read from its API in a single sync process. However, Mailchimp enforces a maximum of 10 simultaneous connections to its API, which means that Airbyte is unable to run more than 10 concurrent syncs from Mailchimp using API keys generated from the same account. ## Supported streams -This source is capable of syncing the following tables and their data: +The Mailchimp source connector supports the following streams: **[Lists](https://mailchimp.com/developer/api/marketing/lists/get-list-info) Stream** @@ -231,10 +205,9 @@ This source is capable of syncing the following tables and their data: } ``` -## Connector-specific features & highlights +### A note on the primary keys -There is `id` primary key for `Lists` and `Campaigns` streams. -`Email Activity` hasn't primary key due to Mailchimp does not give it. +The `Lists` and `Campaigns` streams have `id` as the primary key. The `Email Activity` stream doesn't have a primary key because Mailchimp does not provide one. ## Data type mapping @@ -247,8 +220,10 @@ There is `id` primary key for `Lists` and `Campaigns` streams. | `string` | `string` | | ## Tutorials + Now that you have set up the Mailchimp source connector, check out the following Mailchimp tutorial: -* [Build a data ingestion pipeline from Mailchimp to Snowflake](https://airbyte.com/tutorials/data-ingestion-pipeline-mailchimp-snowflake) + +- [Build a data ingestion pipeline from Mailchimp to Snowflake](https://airbyte.com/tutorials/data-ingestion-pipeline-mailchimp-snowflake) ## Changelog diff --git a/docs/integrations/sources/zendesk-support.md b/docs/integrations/sources/zendesk-support.md index 19413e16b82f4..7974a94551f87 100644 --- a/docs/integrations/sources/zendesk-support.md +++ b/docs/integrations/sources/zendesk-support.md @@ -1,54 +1,35 @@ # Zendesk Support -This page guides you through the process of setting up the Zendesk Support source connector. +This page guides you through setting up the Zendesk Support source connector. -This source can sync data for the [Zendesk Support API](https://developer.zendesk.com/api-reference/apps/apps-support-api/introduction/). This Source Connector is based on a [Airbyte CDK](https://docs.airbyte.io/connector-development/cdk-python). Incremental sync are implemented on API side by its filters. +## Prerequisites -## Prerequisites (Airbyte Cloud) -* `Start Date` - the starting point for the data replication. -* `Subdomain` - This is your Zendesk subdomain that can be found in your account URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN is the value of your subdomain. -* Your Zendesk Account with configured permissions to fetch the data. +- Locate your Zendesk subdomain found in your account URL. For example, if your account URL is `https://{MY_SUBDOMAIN}.zendesk.com/`, then `MY_SUBDOMAIN` is your subdomain. +- (For Airbyte OSS) Find the email address associated with your Zendesk account. Also, generate an [API token](https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token) for the account. -## Prerequisites (Airbyte Open Source) -* `Start Date` - the starting point for the data replication. -* `Subdomain` - This is your Zendesk subdomain that can be found in your account URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN is the value of your subdomain. -* The `Email` used to register your Zendesk Account. -* The `API Token` generated for your Zendesk Account. +## Set up the Zendesk Support source connector -## Step 1: Set up Zendesk Support +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +2. Click **Sources** and then click **+ New source**. +3. On the Set up the source page, select **Zendesk Support** from the Source type dropdown. +4. Enter a name for your source. +5. For **Subdomain**, enter your [Zendesk subdomain](#prerequisites). +6. For **Start date**, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. +7. You can use OAuth or an API key to authenticate your Zendesk Support account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte OSS. + - To authenticate using OAuth for Airbyte Cloud, click **Authenticate your Zendesk Support account** to sign in with Zendesk Support and authorize your account. + - To authenticate using an API key for Airbyte OSS, select **API key** from the Authentication dropdown and enter your [API key](#prerequisites). Enter the **Email** associated with your Zendesk Support account. +8. Click **Set up source**. -1. Create your `Zendesk Account` or use existing one, check [this link](thttps://www.zendesk.com/register/#step-1) -2. Prepare the `API Token` for usage, check [this link](https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token) -3. Find your `Subdomain`, this could be found in your account URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where `MY_SUBDOMAIN` is the value of your subdomain. +## Supported sync modes -## Step 2: Set up the Zendesk Support source 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 source setup page, select **Zendesk Support** from the Source type dropdown and enter a name for this connector. -4. Fill in `Subdomain` value. -5. Click `Authenticate your account`. -6. Log in and Authorize to the Zendesk Support account. -7. Choose required `Start Date`. -8. Click `Set up source`. - -**For Airbyte OSS:** - -1. Go to local Airbyte page. -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 connector and select **Zendesk Support** from the Source type dropdown. -4. Enter `Subdomain` value. -5. In `Authentication *` section choose `API Token`. - * Enter your `API Token` - the value of the API token generated. See the [generating API Token](https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token) for more information. - * `Email` - the user email for your Zendesk account. -7. Choose required `Start Date`. -8. Click `Set up source`. +The Zendesk Support source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): + - Full Refresh - overwrite + - Full Refresh - append + - Incremental - append -### Supported Streams & Sync Modes +## Supported streams -This Source is capable of syncing the following core Streams: +The Zendesk Support source connector supports the following streams: * [Brands](https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#list-brands) * [Custom Roles](https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#list-custom-roles) @@ -69,19 +50,13 @@ This Source is capable of syncing the following core Streams: * [Ticket Metric Events](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metric_events/) * [Users](https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#incremental-user-export) - -The Zendesk Support source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): - - Full Refresh - overwrite - - Full Refresh - append - - Incremental - append - -### Performance considerations +## Performance considerations The connector is restricted by normal Zendesk [requests limitation](https://developer.zendesk.com/rest_api/docs/support/usage_limits). -The Zendesk connector should not run into Zendesk 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. +The Zendesk connector ideally should not run into Zendesk API limitations under normal usage. [Create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully. -### CHANGELOG +## Changelog | Version | Date | Pull Request | Subject | |:---------|:-----------|:---------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|