Amplitude is a product analytics platform that helps teams understand how users interact with their products. It enables businesses to track user events, analyze behavior, build user cohorts, and use these insights to improve product experiences.
Hevo uses the Amplitude Export API, Taxonomy API, and Behavioral Cohorts API to replicate data from your Amplitude account to the Destination of your choice. To ingest data, you must provide Hevo with the API key and secret key of each Amplitude project you want to replicate.
Supported Features
| Feature Name | Supported |
|---|---|
| Capture deletes | Yes (for Event Type, Event Category, and Cohort objects) |
| History mode | No |
| Custom data (user-configured tables & fields) | No |
| Data blocking (skip objects and fields) | Yes |
| Resync (objects and Pipelines) | Yes |
| API configurable | No |
Prerequisites
-
You have an active Amplitude account from which data is to be ingested.
-
A user with the Manager or Admin role in the Amplitude projects you want to replicate, to generate and view the API key and secret key.
-
The API key and secret key of each Amplitude project to provide Hevo access to your Amplitude account data.
Obtain the API Key and Secret Key
Amplitude credentials are specific to each project. To connect Hevo to multiple projects, you must obtain the API key and secret key for each project.
Perform the following steps to obtain the credentials:
-
Log in to your Amplitude account as a user with the Manager or Admin role.
-
In the left navigation pane, click the settings icon, and then click Settings.
-
In the left navigation pane, under Connections, click API Keys.
-
On the API and Secrets Keys page, select the project from which you want to ingest data from the drop-down.
-
Click Generate API Key.
-
In the Generate New API Key pop-up window, specify a name for the API key in the API Key Name field, and click Create API Key.
-
Click the copy icon to copy the API key and save it securely like any other password.
-
Click the Secret Keys tab, and click the copy icon to copy the secret key for the project. Save it securely like any other password.
-
Repeat steps 4-8 for each project you want to replicate.
Use these credentials when configuring your Amplitude Source in Hevo. If the API key or secret key configured in the Pipeline is revoked or deleted manually from your Amplitude account, Hevo cannot authenticate with the Source. As a result, all active jobs for the Pipeline fail, and no data is replicated. To resume data replication, modify the Source configuration in the Pipeline with valid credentials. Once the updated credentials are saved, Hevo re-authenticates the Source, and data ingestion resumes from the last saved offset.
Configure Amplitude Analytics as a Source in your Pipeline
Perform the following steps to configure your Amplitude Analytics Source:
-
Click Pipelines in the Navigation Bar.
-
Click + Create Pipeline in the Pipelines List View.
-
On the Select Source Type page, select Amplitude Analytics.
-
On the Select Destination Type page, select the type of Destination you want to use.
-
On the Select Pipeline Type page, click Edge, and then click Continue.
This page appears only if the selected Destination type is supported in Edge and your Team has an existing Amplitude Analytics Pipeline with the same Destination type. Otherwise, you can proceed to create an Edge Pipeline.
-
In the Configure Source screen, specify the following:
-
Source Name: A unique name for your Source, not exceeding 255 characters. For example, Amplitude Analytics Source.
-
In the Connect to your Amplitude account section, click + Add Project to add an Amplitude project from which you want to ingest data. You can add up to 50 projects. Specify the following for each project:
-
Project Name: The name of the Amplitude project from which you are ingesting data. If you rename the project after creating the Pipeline, resync the corresponding object with Drop and Load.
-
API Key: The API key of the project.
-
Secret Key: The secret key of the project.
-
-
-
Click Test & Continue to test the connection to your Amplitude Analytics Source. Once the test is successful, you can proceed to set up your Destination.
Note: If projects are configured using the same name, clicking Test & Continue fails the Source configuration.
Data Replication
Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.
Hevo ingests the following types of data from your Source objects:
-
Historical Data: The first run of the Pipeline ingests all available historical data for the selected objects and loads it into the Destination.
-
Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.
For the following objects, Hevo ingests only the incremental data in subsequent Pipeline runs:
-
Event
-
Event Amplitude Attribution ID
-
User Cohort
For all other objects, Hevo ingests the entire data during each Pipeline run.
Amplitude enforces rate limits on the number of calls that can be made to its APIs. If a limit is exceeded, a rate limit exception occurs. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions.
Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.
Schema and Primary Keys
Hevo uses the following schema to upload the records to the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| Cohort | Contains the user segments defined in the Amplitude project based on shared behaviors or characteristics, including the segment’s name, description, size, the rules that decide which users belong to it, the owners and viewers who can access it, and the times it was created, last modified, and last recalculated. |
| Event | Contains individual user actions recorded in the Amplitude project, including the action type, the time it occurred, user and device details, location, and additional properties describing the action. It includes a child object, Event Amplitude Attribution ID. |
| Event Category | Contains the labels created in the Amplitude project to sort tracked user actions into related groups. |
| Event Type | Contains the kinds of user actions tracked in the Amplitude project, including each action’s name, display name, the total number of times it has been recorded, and whether it is hidden or deleted. |
| User Cohort | Contains records of which users belong to each user segment in the Amplitude project, including each user’s ID and the time the segment’s members were last recalculated. |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Handling of Deletes
Hevo uses a full data refresh approach to capture delete actions. During each Pipeline run, Hevo compares the data fetched from the Source object with the data present in the Destination table. If a record exists in the Destination but is no longer returned by the Source, the record is marked as deleted by setting the value of the metadata column __hevo__marked_deleted to True. This applies to the following objects:
-
Cohort
-
Event Category
-
Event Type
For all other objects, Hevo does not support capturing deletes.
Source Considerations
- Amplitude may take up to two hours to make newly received event data available for export. As a result, recent events may take up to two hours to appear in the Destination.