Amplitude Connector Setup Guide
This article describes how to set up the Amplitude connector.
API Information
This connector uses the following vendor API:
- API Name: Amplitude HTTP API
- API Version: v2
- API Endpoint:
https://api2.amplitude.com/2/httpapi
- Documentation: Amplitude HTTP API
Connector Actions
Action Name | AudienceStream | EventStream |
---|---|---|
Send Event | ✓ | ✓ |
Send Event (Non-Batched) | ✓ | ✓ |
Configure Settings
Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article.
After adding the connector, configure the following settings:
- API Key
Located under Settings -> Projects. - Server Endpoint
Please provide the Amplitude endpoint.
Supported endpoints:
Standard Server:https://api2.amplitude.com/2/httpapi
EU Residency Server:https://api.eu.amplitude.com/2/httpapi
If not provided, Standard Server endpoint will be used by default.
Click Done when you are finished configuring the connector.
Action Settings — Parameters and Options
Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.
The following section describes how to set up parameters and options for each action.
Action — Send Event (Batched)
The Send Events (Batched) action should not be used if realtime processing is required.
Batch Limits
This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:
- Max number of requests: 2000
- Max time since oldest request: 10 minutes
- Max size of requests: 1 MB
Parameters
Parameter | Description |
---|---|
Event Type | (Required) |
API Key Override | |
Server Endpoint Override | |
Android ID | |
App Version | |
Carrier | |
City | |
Country | |
Designated Market Area | |
Device Brand | |
Device ID | |
Device IP Address | |
Device Manufacturer | |
Device Model | |
Event ID | |
Google Play Services Advertising ID | |
iOS Identifier for Advertiser | |
iOS Identifier for Vendor | |
Insert ID | |
Language | |
Location Latitude | |
Location Longitude | |
OS Name | |
OS Version | |
Platform | |
Price | |
Product ID | |
Quantity | |
Region | |
Revenue | |
Revenue Type | |
Session ID | |
Time | |
User ID | |
Event Properties | A dictionary of key-value pairs that represent additional data to be sent along with the event. Empty values are skipped and not included. |
User Properties | A dictionary of key-value pairs that represent additional data tied to the user. Each distinct value will show up as a user segment on the Amplitude dashboard. Empty values are skipped and not included. |
Groups | Enterprise only. A dictionary of key-value pairs that represent groups of users. See this excerpt in our Javascript SDK for more information on groups. Empty values are skipped and not included. |
Template Variables | Provide template variables as data input (see: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name ).Nested template variables are typically built from data layer list attributes. |
Templates | Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). |
Action — Send Event (Non-Batched)
Parameters
Parameter | Description |
---|---|
Event Type | (Required) |
API Key Override | |
Server Endpoint Override | |
Android ID | |
App Version | |
Carrier | |
City | |
Country | |
Designated Market Area | |
Device Brand | |
Device ID | |
Device IP Address | |
Device Manufacturer | |
Device Model | |
Event ID | |
Google Play Services Advertising ID | |
iOS Identifier for Advertiser | |
iOS Identifier for Vendor | |
Insert ID | |
Language | |
Location Latitude | |
Location Longitude | |
OS Name | |
OS Version | |
Platform | |
Price | |
Product ID | |
Quantity | |
Region | |
Revenue | |
Revenue Type | |
Session ID | |
Time | |
User ID | |
Event Properties | A dictionary of key-value pairs that represent additional data to be sent along with the event. Empty values are skipped and not included. |
User Properties | A dictionary of key-value pairs that represent additional data tied to the user. Each distinct value will show up as a user segment on the Amplitude dashboard. Empty values are skipped and not included. |
Groups | Enterprise only. A dictionary of key-value pairs that represent groups of users. See this excerpt in our Javascript SDK for more information on groups. Empty values are skipped and not included. |
Template Variables | Provide template variables as data input (see: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name ).Nested template variables are typically built from data layer list attributes. |
Templates | Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ;). |
This page was last updated: November 10, 2022