Skip to main content

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

  1. Log into your Airbyte Cloud or Airbyte Open Source 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.
  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

The Amplitude source connector supports the following streams:

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

Expand to review
VersionDatePull RequestSubject
0.3.122024-06-0639103Use CheckpointMixin for state management
0.3.112024-06-0438988[autopull] Upgrade base image to v1.2.1
0.3.102024-04-1936631Updating to 0.80.0 CDK
0.3.92024-04-1236631schema descriptions
0.3.82024-03-1235987Unpin CDK version
0.3.72024-02-1235162Manage dependencies with Poetry.
0.3.62023-10-2331702Base image migration: remove Dockerfile and use the python-connector-base image
0.3.52023-09-2830846Add support of multiple cursor date formats
0.3.42023-09-2830831Add user friendly error description on 403 error
0.3.32023-09-2130652Update spec: declare start_date type as date-time
0.3.22023-09-1830525Fix KeyError while getting data_region from config
0.3.12023-09-1530471Fix Event stream: Use start_time instead of cursor in the case of more recent
0.3.02023-09-1330378Switch to latest CDK version
0.2.42023-05-0525842added missing attrs in events schema, enabled default availability strategy
0.2.32023-04-2025317Refactor Events Stream, use pre-YAML version based on Python CDK
0.2.22023-04-1925315Refactor to only fetch date_time_fields once per request
0.2.12023-02-0325281Reduce request_time_range to 4 hours
0.2.02023-02-0322362Migrate to YAML
0.1.242023-03-2821022Enable event stream time interval selection
0.1.232023-03-0223087Specified date formatting in specification
0.1.222023-02-1723192Skip the stream if start_date is specified in the future.
0.1.212023-02-0121888Set AvailabilityStrategy for streams explicitly to None
0.1.202023-01-2721957Handle null values and empty strings in date-time fields
0.1.192022-12-0919727Remove data_region as required
0.1.182022-12-0819727Add parameter to select region
0.1.172022-10-3118684Add empty series validation for AverageSessionLength stream
0.1.162022-10-1117854Add empty series validation for ActtiveUsers steam
0.1.152022-10-0317320Add validation start_date filed if it's in the future
0.1.142022-09-2817326Migrate to per-stream states.
0.1.132022-08-3116185Re-release on new airbyte_cdk==0.1.81
0.1.122022-08-1115506Changed slice day window to 1, instead of 3 for Events stream
0.1.112022-07-2114924Remove additionalProperties field from spec
0.1.102022-06-1613846Try-catch the BadZipFile error
0.1.92022-06-1013638Fixed an infinite loop when fetching Amplitude data
0.1.82022-06-0113373Fixed the issue when JSON Validator produces errors on date-time check
0.1.72022-05-2113074Removed time offset for Events stream, which caused a lot of duplicated records
0.1.62022-04-3012500Improve input configuration copy
0.1.52022-04-2812430Added HTTP error descriptions and fixed Events stream fail caused by 404 HTTP Error
0.1.42021-12-238434Update fields in source-connectors specifications
0.1.32021-10-126375Log Transient 404 Error in Events stream
0.1.22021-09-216353Correct output schemas on cohorts, events, active_users, and average_session_lengths streams
0.1.12021-06-093973Add AIRBYTE_ENTRYPOINT for kubernetes support
0.1.02021-06-083664New Source: Amplitude