Skip to main content

Authorization

Follow this guide to create a new Amplitude credential that will allow Nexla to authenticate to and exchange data with your Amplitude account.
amplitude_api_auth.png

Amplitude

Prerequisites​

Before creating an Amplitude credential, you'll need to obtain API credentials from your Amplitude project settings. The Amplitude Export API uses Basic Authentication with an API Key and Secret Key.

Amplitude Account Setup​

To obtain the required API credentials for Amplitude:

  1. Sign in to Amplitude: Navigate to https://amplitude.com/ and sign in to your Amplitude account. If you don't have an account, you can create one by clicking Sign up and following the registration process.

  2. Access Project Settings: Once signed in, navigate to your Amplitude project. Click on your profile icon in the top right corner, then select Settings from the menu, or navigate directly to your project settings.

  3. Navigate to API Keys: In the project settings, look for the API Keys or Project Settings section. This section contains your API credentials for accessing the Amplitude Export API.

  4. Obtain API Key and Secret Key: In the API Keys section, you'll find:

    • API Key: Your project's API key (also known as the API Key ID)
    • Secret Key: Your project's secret key (also known as the API Secret)

  5. Copy Credentials: Copy both the API Key and Secret Key immediately. Store these credentials securely, as you'll need them when creating the credential in Nexla.

Amplitude API credentials are project-specific. Each Amplitude project has its own API Key and Secret Key. Ensure you're using the credentials from the correct project. The API Key and Secret Key are used together for Basic Authentication in API requests. For complete information about Amplitude API authentication, see the Amplitude API Authentication Documentation.

Data Residency Region​

Amplitude supports different data residency regions, which affect the base URL for API requests:

  • Standard: Uses https://amplitude.com as the base URL (default)
  • EU: Uses https://analytics.eu.amplitude.com as the base URL for EU data residency

Select the appropriate region based on where your Amplitude project data is stored. This information is typically available in your Amplitude project settings.

API Access Requirements​

Amplitude Export API access requires:

  • Valid Amplitude Account: You must have an active Amplitude account
  • Project Access: You must have access to the Amplitude project
  • API Key: Your project's API key from project settings
  • Secret Key: Your project's secret key from project settings

The Amplitude Export API uses Basic Authentication, where the API Key is used as the username and the Secret Key is used as the password. All API requests must use HTTPS.

For complete information about Amplitude Export API authentication and getting started, see the Amplitude Export API Documentation.

Create an Amplitude Credential​

  • To create a new Amplitude credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Amplitude

AmplitudeCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Data Residency Region Configuration​

  1. Data Residency Region: Select your Amplitude data residency region from the Data Residency Region pulldown menu. Available options are:

    • Standard: For standard data residency (base URL: https://amplitude.com)
    • EU: For EU data residency (base URL: https://analytics.eu.amplitude.com)

    This selection determines the base URL that will be used for API requests.

API Key Configuration​

  1. API Key: Enter your Amplitude API Key in the API Key field. This is your project's API key from the Amplitude project settings. The API Key is used as the username in Basic Authentication.

  2. Secret Key: Enter your Amplitude Secret Key in the Secret Key field. This is your project's secret key from the Amplitude project settings. The Secret Key is used as the password in Basic Authentication.

The API Key and Secret Key are sensitive credentials that provide access to your Amplitude project data. Keep these credentials secure and never share them publicly or commit them to version control systems. The credentials are used together for Basic Authentication in all Amplitude API requests.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.