Amplitude
This page guides you through setting up the Amplitude source connector to sync data for the Amplitude API.
Prerequisite
To set up the Amplitude source connector, you'll need your Amplitude API Key and Secret Key.
Set up the Amplitude source connector
- Log into your Airbyte Cloud or Airbyte Open Source account.
- Click Sources and then click + New source.
- On the Set up the source page, select Amplitude from the Source type dropdown.
- Enter a name for your source.
- For API Key and Secret Key, enter the Amplitude API key and secret key.
- 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.
- Click Set up source.
Supported Streams
The Amplitude source connector supports the following streams:
- Active Users Counts (Incremental sync)
- Annotations
- Average Session Length (Incremental sync)
- Cohorts
- Events (Incremental sync)
If there are more endpoints you'd like Airbyte to support, please create an issue.
Supported sync modes
The Amplitude source connector supports the following sync modes:
- Full Refresh
- Incremental
Connector-specific features
There are two data region servers supported by Airbyte:
- Standard Server
- EU Residency Server
The Standard Server will be the default option until you change it in the Optional fields.
Performance considerations
The Amplitude connector ideally should gracefully handle Amplitude API limitations under normal usage. Create an issue if you see any rate limit issues that are not automatically retried successfully.
Reference
Config fields reference
Field
Type
Property name
string
api_key
string
secret_key
string
start_date
string
data_region
integer
request_time_range
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.3.7 | 2024-02-12 | 35162 | Manage dependencies with Poetry. |
| 0.3.6 | 2023-10-23 | 31702 | Base image migration: remove Dockerfile and use the python-connector-base image |
| 0.3.5 | 2023-09-28 | 30846 | Add support of multiple cursor date formats |
| 0.3.4 | 2023-09-28 | 30831 | Add user friendly error description on 403 error |
| 0.3.3 | 2023-09-21 | 30652 | Update spec: declare start_date type as date-time |
| 0.3.2 | 2023-09-18 | 30525 | Fix KeyError while getting data_region from config |
| 0.3.1 | 2023-09-15 | 30471 | Fix Event stream: Use start_time instead of cursor in the case of more recent |
| 0.3.0 | 2023-09-13 | 30378 | Switch to latest CDK version |
| 0.2.4 | 2023-05-05 | 25842 | added missing attrs in events schema, enabled default availability strategy |
| 0.2.3 | 2023-04-20 | 25317 | Refactor Events Stream, use pre-YAML version based on Python CDK |
| 0.2.2 | 2023-04-19 | 25315 | Refactor to only fetch date_time_fields once per request |
| 0.2.1 | 2023-02-03 | 25281 | Reduce request_time_range to 4 hours |
| 0.2.0 | 2023-02-03 | 22362 | Migrate to YAML |
| 0.1.24 | 2023-03-28 | 21022 | Enable event stream time interval selection |
| 0.1.23 | 2023-03-02 | 23087 | Specified date formatting in specification |
| 0.1.22 | 2023-02-17 | 23192 | Skip the stream if start_date is specified in the future. |
| 0.1.21 | 2023-02-01 | 21888 | Set AvailabilityStrategy for streams explicitly to None |
| 0.1.20 | 2023-01-27 | 21957 | Handle null values and empty strings in date-time fields |
| 0.1.19 | 2022-12-09 | 19727 | Remove data_region as required |
| 0.1.18 | 2022-12-08 | 19727 | Add parameter to select region |
| 0.1.17 | 2022-10-31 | 18684 | Add empty series validation for AverageSessionLength stream |
| 0.1.16 | 2022-10-11 | 17854 | Add empty series validation for ActtiveUsers steam |
| 0.1.15 | 2022-10-03 | 17320 | Add validation start_date filed if it's in the future |
| 0.1.14 | 2022-09-28 | 17326 | Migrate to per-stream states. |
| 0.1.13 | 2022-08-31 | 16185 | Re-release on new airbyte_cdk==0.1.81 |
| 0.1.12 | 2022-08-11 | 15506 | Changed slice day window to 1, instead of 3 for Events stream |
| 0.1.11 | 2022-07-21 | 14924 | Remove additionalProperties field from spec |
| 0.1.10 | 2022-06-16 | 13846 | Try-catch the BadZipFile error |
| 0.1.9 | 2022-06-10 | 13638 | Fixed an infinite loop when fetching Amplitude data |
| 0.1.8 | 2022-06-01 | 13373 | Fixed the issue when JSON Validator produces errors on date-time check |
| 0.1.7 | 2022-05-21 | 13074 | Removed time offset for Events stream, which caused a lot of duplicated records |
| 0.1.6 | 2022-04-30 | 12500 | Improve input configuration copy |
| 0.1.5 | 2022-04-28 | 12430 | Added HTTP error descriptions and fixed Events stream fail caused by 404 HTTP Error |
| 0.1.4 | 2021-12-23 | 8434 | Update fields in source-connectors specifications |
| 0.1.3 | 2021-10-12 | 6375 | Log Transient 404 Error in Events stream |
| 0.1.2 | 2021-09-21 | 6353 | Correct output schemas on cohorts, events, active_users, and average_session_lengths streams |
| 0.1.1 | 2021-06-09 | 3973 | Add AIRBYTE_ENTRYPOINT for kubernetes support |
| 0.1.0 | 2021-06-08 | 3664 | New Source: Amplitude |