Amplitude
What Is Amplitude?
Amplitude is a product analytics platform that helps businesses understand user behavior across digital products. It provides insights and advanced analytics to track user interactions, measure user engagement, and optimize product experiences. Amplitude's features include event tracking, user segmentation, cohort analysis, and A/B testing. It enables data-driven decision-making by offering powerful visualizations and integrations with other tools. Businesses use Amplitude to enhance customer retention, improve user acquisition, and drive growth through data-informed strategies.
Product Type: Analytics
Integration Type: Starter Kit
Event Source Type: Web, Mobile Browser, and Mobile App
Event Scope: Full-Funnel Events
Capabilities
- Sends server-side event data to Amplitude, eliminating the need for a client-side Amplitude tag.
- Reduces client-side load, helping improve site speed and performance.
- Supports full-funnel events including page, product, cart, and order lifecycle actions.
- Enriches events with user, device, campaign, and geolocation properties.
- Supports batching of events for delivery.
Considerations
- If you are using this integration for the EU, contact your MetaRouter support team. They will assist you in adjusting the integration to serve the EU endpoint.
- The API URL defaults to
https://api2.amplitude.comand must be changed tohttps://api.eu.amplitude.comfor EU data residency. - Additional identifiers such as geolocation fields (
location_lat,location_lng,country,region,city,dma) and mobile advertising IDs (idfa,idfv,adid,android_id) can be added as Global or Event Specific mappings to improve user match rates when available. - The
identifyevent is sent to Amplitude'sidentifyendpoint using a GET request. The following GET constraints apply to that event:- In our testing, requests above ~20,000 characters in the URL began to fail. While this isn't a formally documented limit, it may be a practical constraint to consider when using this integration.
- All values must be URL-encoded and arrays pipe-delimited.
- One request per event; batching not supported.
- Complex lists (e.g., products) must be pipe-delimited.
Starter Kit Setup Guide
1. Gather Credentials
- Refer to Amplitude's guide on API Authentication to obtain your API Key.
2. Add an Amplitude Integration
- From the integration library, add an Amplitude integration. Then, fill out the Connection Parameters:
| Connection Parameter | Description |
|---|---|
API_KEY | API key from your Amplitude account. |
API_URL | Default API URL set to https://api2.amplitude.com. Change to https://api.eu.amplitude.com for EU residency. |
3. Configure Event Mapping
- MetaRouter provides all of the event mappings that Amplitude integrations typically require. You may add custom events, parameters, or mappings in accordance with Amplitude's API documentation.
4. Deploy to Pipeline
- In the Pipelines tab, add your Amplitude integration.
- Select the correct integration revision.
- Click Add Integration to finalize deployment.
Event Mappings
Global
Global mappings will be applied to all events. If your parameter names do not match the Expected Inputs provided, you will need to overwrite the Inputs provided with your own.
| Output Key | Description | Expected Input |
|---|---|---|
partner_id Required | String: The partner ID associated with the event. | Enrichment – 'metarouter' |
Event Specific
Identify
| Output Key | Description | Expected Input |
|---|---|---|
api_key Required | String: Amplitude API key. | $$API_KEY$$ |
identification Required | Object: User identification object containing various properties. | Expression – builds identification object from user, device, and campaign data |
Page
| Output Key | Description | Expected Input |
|---|---|---|
event_type Required | String: A unique identifier for the event. | Enrichment – 'Loaded a Page' |
user_id Required | String: A readable ID specified by you. | userId |
device_id Required | String: A device-specific identifier. | anonymousId |
insert_id | String: A unique identifier for the event. | messageId |
event_properties.category | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.category |
event_properties.name | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.name |
user_properties.user_id | Object: A dictionary of key-value pairs representing data tied to the user. | userId |
user_properties.device_id | Object: A dictionary of key-value pairs representing data tied to the user. | anonymousId |
app_version | String: The current version of your application. | context.app.version |
os_name | String: The name of the mobile operating system or browser that the user is using. | context.os.name |
os_version | String: The version of the mobile operating system or browser the user is using. | context.os.version |
device_manufacturer | String: The device manufacturer that the user is using. | context.device.manufacturer |
device_model | String: The device model that the user is using. | context.device.model |
carrier | String: The carrier that the user is using. | context.network.carrier |
ip | String: The IP address of the user. | context.ip |
user_agent | String: The user agent string of the browser. | context.userAgent |
user_properties.utm_source | Object: UTM source parameter for tracking. | context.campaign.source |
user_properties.utm_medium | Object: UTM medium parameter for tracking. | context.campaign.medium |
user_properties.utm_campaign | Object: UTM campaign parameter for tracking. | context.campaign.name |
user_properties.utm_term | Object: UTM term parameter for tracking. | context.campaign.term |
user_properties.utm_content | Object: UTM content parameter for tracking. | context.campaign.content |
user_properties.referrer | Object: Referrer URL of the page. | context.page.referrer |
platform | String: Derived platform (iOS, Android, or Web). | Expression – derived from context.device.type |
user_properties.referring_domain | Object: Domain parsed from the referrer URL. | Expression – parsed from context.page.referrer |
user_properties.gclid | Object: Google click ID from the page URL. | Expression – from context.page.url |
user_properties.dclid | Object: Display click ID from the page URL. | Expression – from context.page.url |
user_properties.fbclid | Object: Facebook click ID from the page URL. | Expression – from context.page.url |
Products Searched
| Output Key | Description | Expected Input |
|---|---|---|
event_type Required | String: A unique identifier for the event. | Enrichment – 'Search Completed' |
user_id Required | String: A readable ID specified by you. | userId |
device_id Required | String: A device-specific identifier. | anonymousId |
insert_id | String: A unique identifier for the event. | messageId |
event_properties.keywords | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.query |
user_properties.user_id | Object: A dictionary of key-value pairs representing data tied to the user. | userId |
user_properties.device_id | Object: A dictionary of key-value pairs representing data tied to the user. | anonymousId |
app_version | String: The current version of your application. | context.app.version |
os_name | String: The name of the mobile operating system or browser that the user is using. | context.os.name |
os_version | String: The version of the mobile operating system or browser the user is using. | context.os.version |
device_manufacturer | String: The device manufacturer that the user is using. | context.device.manufacturer |
device_model | String: The device model that the user is using. | context.device.model |
carrier | String: The carrier that the user is using. | context.network.carrier |
ip | String: The IP address of the user. | context.ip |
user_agent | String: The user agent string of the browser. | context.userAgent |
user_properties.utm_source | Object: UTM source parameter for tracking. | context.campaign.source |
user_properties.utm_medium | Object: UTM medium parameter for tracking. | context.campaign.medium |
user_properties.utm_campaign | Object: UTM campaign parameter for tracking. | context.campaign.name |
user_properties.utm_term | Object: UTM term parameter for tracking. | context.campaign.term |
user_properties.utm_content | Object: UTM content parameter for tracking. | context.campaign.content |
user_properties.referrer | Object: Referrer URL of the page. | context.page.referrer |
platform | String: Derived platform (iOS, Android, or Web). | Expression – derived from context.device.type |
user_properties.referring_domain | Object: Domain parsed from the referrer URL. | Expression – parsed from context.page.referrer |
user_properties.gclid | Object: Google click ID from the page URL. | Expression – from context.page.url |
user_properties.dclid | Object: Display click ID from the page URL. | Expression – from context.page.url |
user_properties.fbclid | Object: Facebook click ID from the page URL. | Expression – from context.page.url |
Product List Viewed
| Output Key | Description | Expected Input |
|---|---|---|
event_type Required | String: A unique identifier for the event. | Enrichment – 'product_list_viewed' |
user_id Required | String: A readable ID specified by you. | userId |
device_id Required | String: A device-specific identifier. | anonymousId |
insert_id | String: A unique identifier for the event. | messageId |
event_properties.list_category | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.category |
event_properties.list_id | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.list_id |
user_properties.user_id | Object: A dictionary of key-value pairs representing data tied to the user. | userId |
user_properties.device_id | Object: A dictionary of key-value pairs representing data tied to the user. | anonymousId |
app_version | String: The current version of your application. | context.app.version |
os_name | String: The name of the mobile operating system or browser that the user is using. | context.os.name |
os_version | String: The version of the mobile operating system or browser the user is using. | context.os.version |
device_manufacturer | String: The device manufacturer that the user is using. | context.device.manufacturer |
device_model | String: The device model that the user is using. | context.device.model |
carrier | String: The carrier that the user is using. | context.network.carrier |
ip | String: The IP address of the user. | context.ip |
user_properties.utm_source | Object: UTM source parameter for tracking. | context.campaign.source |
user_properties.utm_medium | Object: UTM medium parameter for tracking. | context.campaign.medium |
user_properties.utm_campaign | Object: UTM campaign parameter for tracking. | context.campaign.name |
user_properties.utm_term | Object: UTM term parameter for tracking. | context.campaign.term |
user_properties.utm_content | Object: UTM content parameter for tracking. | context.campaign.content |
user_properties.referrer | Object: Referrer URL of the page. | context.page.referrer |
platform | String: Derived platform (iOS, Android, or Web). | Expression – derived from context.device.type |
user_properties.referring_domain | Object: Domain parsed from the referrer URL. | Expression – parsed from context.page.referrer |
user_properties.gclid | Object: Google click ID from the page URL. | Expression – from context.page.url |
user_properties.dclid | Object: Display click ID from the page URL. | Expression – from context.page.url |
user_properties.fbclid | Object: Facebook click ID from the page URL. | Expression – from context.page.url |
Product Viewed
| Output Key | Description | Expected Input |
|---|---|---|
event_type Required | String: A unique identifier for the event. | Enrichment – 'product_viewed' |
user_id Required | String: A readable ID specified by you. | userId |
device_id Required | String: A device-specific identifier. | anonymousId |
insert_id | String: A unique identifier for the event. | messageId |
event_properties.product_name | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.name |
event_properties.product_sku | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.sku |
event_properties.product_id | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.product_id |
event_properties.product_category | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.category |
event_properties.product_price | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.price |
user_properties.user_id | Object: A dictionary of key-value pairs representing data tied to the user. | userId |
user_properties.device_id | Object: A dictionary of key-value pairs representing data tied to the user. | anonymousId |
app_version | String: The current version of your application. | context.app.version |
os_name | String: The name of the mobile operating system or browser that the user is using. | context.os.name |
os_version | String: The version of the mobile operating system or browser the user is using. | context.os.version |
device_manufacturer | String: The device manufacturer that the user is using. | context.device.manufacturer |
device_model | String: The device model that the user is using. | context.device.model |
carrier | String: The carrier that the user is using. | context.network.carrier |
ip | String: The IP address of the user. | context.ip |
user_properties.utm_source | Object: UTM source parameter for tracking. | context.campaign.source |
user_properties.utm_medium | Object: UTM medium parameter for tracking. | context.campaign.medium |
user_properties.utm_campaign | Object: UTM campaign parameter for tracking. | context.campaign.name |
user_properties.utm_term | Object: UTM term parameter for tracking. | context.campaign.term |
user_properties.utm_content | Object: UTM content parameter for tracking. | context.campaign.content |
user_properties.referrer | Object: Referrer URL of the page. | context.page.referrer |
platform | String: Derived platform (iOS, Android, or Web). | Expression – derived from context.device.type |
user_properties.referring_domain | Object: Domain parsed from the referrer URL. | Expression – parsed from context.page.referrer |
user_properties.gclid | Object: Google click ID from the page URL. | Expression – from context.page.url |
user_properties.dclid | Object: Display click ID from the page URL. | Expression – from context.page.url |
user_properties.fbclid | Object: Facebook click ID from the page URL. | Expression – from context.page.url |
Product Added
| Output Key | Description | Expected Input |
|---|---|---|
event_type Required | String: A unique identifier for the event. | Enrichment – 'product_added' |
user_id Required | String: A readable ID specified by you. | userId |
device_id Required | String: A device-specific identifier. | anonymousId |
insert_id | String: A unique identifier for the event. | messageId |
event_properties.product_name | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.name |
event_properties.product_sku | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.sku |
event_properties.product_id | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.product_id |
event_properties.product_category | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.category |
event_properties.product_price | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.price |
event_properties.product_quantity | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.quantity |
user_properties.user_id | Object: A dictionary of key-value pairs representing data tied to the user. | userId |
user_properties.device_id | Object: A dictionary of key-value pairs representing data tied to the user. | anonymousId |
app_version | String: The current version of your application. | context.app.version |
os_name | String: The name of the mobile operating system or browser that the user is using. | context.os.name |
os_version | String: The version of the mobile operating system or browser the user is using. | context.os.version |
device_manufacturer | String: The device manufacturer that the user is using. | context.device.manufacturer |
device_model | String: The device model that the user is using. | context.device.model |
carrier | String: The carrier that the user is using. | context.network.carrier |
ip | String: The IP address of the user. | context.ip |
user_properties.utm_source | Object: UTM source parameter for tracking. | context.campaign.source |
user_properties.utm_medium | Object: UTM medium parameter for tracking. | context.campaign.medium |
user_properties.utm_campaign | Object: UTM campaign parameter for tracking. | context.campaign.name |
user_properties.utm_term | Object: UTM term parameter for tracking. | context.campaign.term |
user_properties.utm_content | Object: UTM content parameter for tracking. | context.campaign.content |
user_properties.referrer | Object: Referrer URL of the page. | context.page.referrer |
platform | String: Derived platform (iOS, Android, or Web). | Expression – derived from context.device.type |
user_properties.referring_domain | Object: Domain parsed from the referrer URL. | Expression – parsed from context.page.referrer |
user_properties.gclid | Object: Google click ID from the page URL. | Expression – from context.page.url |
user_properties.dclid | Object: Display click ID from the page URL. | Expression – from context.page.url |
user_properties.fbclid | Object: Facebook click ID from the page URL. | Expression – from context.page.url |
Cart Viewed
| Output Key | Description | Expected Input |
|---|---|---|
event_type Required | String: A unique identifier for the event. | Enrichment – 'cart_viewed' |
user_id Required | String: A readable ID specified by you. | userId |
device_id Required | String: A device-specific identifier. | anonymousId |
insert_id | String: A unique identifier for the event. | messageId |
event_properties.cart_id | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.cart_id |
event_properties.total_cart_size | Object: The total number of items in the cart. | Expression – counts properties.products |
event_properties.total_cart_value | Object: The total value of items in the cart. | Expression – sums price × quantity across properties.products |
user_properties.user_id | Object: A dictionary of key-value pairs representing data tied to the user. | userId |
user_properties.device_id | Object: A dictionary of key-value pairs representing data tied to the user. | anonymousId |
app_version | String: The current version of your application. | context.app.version |
os_name | String: The name of the mobile operating system or browser that the user is using. | context.os.name |
os_version | String: The version of the mobile operating system or browser the user is using. | context.os.version |
device_manufacturer | String: The device manufacturer that the user is using. | context.device.manufacturer |
device_model | String: The device model that the user is using. | context.device.model |
carrier | String: The carrier that the user is using. | context.network.carrier |
ip | String: The IP address of the user. | context.ip |
user_properties.utm_source | Object: UTM source parameter for tracking. | context.campaign.source |
user_properties.utm_medium | Object: UTM medium parameter for tracking. | context.campaign.medium |
user_properties.utm_campaign | Object: UTM campaign parameter for tracking. | context.campaign.name |
user_properties.utm_term | Object: UTM term parameter for tracking. | context.campaign.term |
user_properties.utm_content | Object: UTM content parameter for tracking. | context.campaign.content |
user_properties.referrer | Object: Referrer URL of the page. | context.page.referrer |
platform | String: Derived platform (iOS, Android, or Web). | Expression – derived from context.device.type |
user_properties.referring_domain | Object: Domain parsed from the referrer URL. | Expression – parsed from context.page.referrer |
user_properties.gclid | Object: Google click ID from the page URL. | Expression – from context.page.url |
user_properties.dclid | Object: Display click ID from the page URL. | Expression – from context.page.url |
user_properties.fbclid | Object: Facebook click ID from the page URL. | Expression – from context.page.url |
Order Completed
| Output Key | Description | Expected Input |
|---|---|---|
event_type Required | String: A unique identifier for the event. | Enrichment – 'order_completed' |
user_id Required | String: A readable ID specified by you. | userId |
device_id Required | String: A device-specific identifier. | anonymousId |
insert_id | String: A unique identifier for the event. | messageId |
user_properties.user_id | Object: A dictionary of key-value pairs representing data tied to the user. | userId |
user_properties.device_id | Object: A dictionary of key-value pairs representing data tied to the user. | anonymousId |
app_version | String: The current version of your application. | context.app.version |
os_name | String: The name of the mobile operating system or browser that the user is using. | context.os.name |
os_version | String: The version of the mobile operating system or browser the user is using. | context.os.version |
device_manufacturer | String: The device manufacturer that the user is using. | context.device.manufacturer |
device_model | String: The device model that the user is using. | context.device.model |
carrier | String: The carrier that the user is using. | context.network.carrier |
ip | String: The IP address of the user. | context.ip |
user_agent | String: The user agent string of the browser. | context.userAgent |
event_properties.cart_id | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.cart_id |
event_properties.total_cart_size | Object: The total number of items in the cart. | Expression – counts properties.products |
event_properties.total_cart_value | Object: The total value of items in the cart. | Expression – sums price × quantity across properties.products |
event_properties.promo_code_applied | Object: The promo code applied to the order. | properties.coupon |
event_properties.order_total | Object: The total value of the order. | properties.total |
event_properties.total_discounts | Object: The total discounts applied to the order. | properties.discount |
event_properties.order_id | Object: A dictionary of key-value pairs representing properties sent along with the event. | properties.order_id |
event_properties.total_shipping | Object: The total shipping cost of the order. | properties.shipping |
event_properties.total_tax | Object: The total tax applied to the order. | properties.tax |
event_properties.$revenue | Float: Order revenue for Amplitude revenue tracking. | Expression – from properties.revenue |
user_properties.utm_source | Object: UTM source parameter for tracking. | context.campaign.source |
user_properties.utm_medium | Object: UTM medium parameter for tracking. | context.campaign.medium |
user_properties.utm_campaign | Object: UTM campaign parameter for tracking. | context.campaign.name |
user_properties.utm_term | Object: UTM term parameter for tracking. | context.campaign.term |
user_properties.utm_content | Object: UTM content parameter for tracking. | context.campaign.content |
user_properties.referrer | Object: Referrer URL of the page. | context.page.referrer |
platform | String: Derived platform (iOS, Android, or Web). | Expression – derived from context.device.type |
user_properties.referring_domain | Object: Domain parsed from the referrer URL. | Expression – parsed from context.page.referrer |
user_properties.gclid | Object: Google click ID from the page URL. | Expression – from context.page.url |
user_properties.dclid | Object: Display click ID from the page URL. | Expression – from context.page.url |
user_properties.fbclid | Object: Facebook click ID from the page URL. | Expression – from context.page.url |
Default
| Output Key | Description | Expected Input |
|---|---|---|
event_type | String: A unique identifier for the event. | event |
user_id | String: A readable ID specified by you. | userId |
device_id | String: A device-specific identifier. | anonymousId |
insert_id | String: A unique identifier for the event. | messageId |
event_properties | Object: The full properties object sent along with the event. | properties |
user_properties.user_id | Object: A dictionary of key-value pairs representing data tied to the user. | userId |
user_properties.device_id | Object: A dictionary of key-value pairs representing data tied to the user. | anonymousId |
app_version | String: The current version of your application. | context.app.version |
os_name | String: The name of the mobile operating system or browser that the user is using. | context.os.name |
os_version | String: The version of the mobile operating system or browser the user is using. | context.os.version |
device_manufacturer | String: The device manufacturer that the user is using. | context.device.manufacturer |
device_model | String: The device model that the user is using. | context.device.model |
carrier | String: The carrier that the user is using. | context.network.carrier |
ip | String: The IP address of the user. | context.ip |
user_agent | String: The user agent string of the browser. | context.userAgent |
user_properties.utm_source | Object: UTM source parameter for tracking. | context.campaign.source |
user_properties.utm_medium | Object: UTM medium parameter for tracking. | context.campaign.medium |
user_properties.utm_campaign | Object: UTM campaign parameter for tracking. | context.campaign.name |
user_properties.utm_term | Object: UTM term parameter for tracking. | context.campaign.term |
user_properties.utm_content | Object: UTM content parameter for tracking. | context.campaign.content |
user_properties.referrer | Object: Referrer URL of the page. | context.page.referrer |
platform | String: Derived platform (iOS, Android, or Web). | Expression – derived from context.device.type |
user_properties.referring_domain | Object: Domain parsed from the referrer URL. | Expression – parsed from context.page.referrer |
user_properties.gclid | Object: Google click ID from the page URL. | Expression – from context.page.url |
user_properties.dclid | Object: Display click ID from the page URL. | Expression – from context.page.url |
user_properties.fbclid | Object: Facebook click ID from the page URL. | Expression – from context.page.url |
Required & Recommended Identifiers
These identifiers must be mapped to Amplitude in order for successful user matching to occur. Without these IDs, any events sent to Amplitude will be rejected. For your convenience, required and recommended IDs are mapped as Global parameters to ensure they are added to every event.
| Attribute | Example | Sync Injector Required? |
|---|---|---|
user_id Required | user_123456 | No |
device_id Required | abc123xyz | No |
insert_id Recommended | d290f1ee-6c54-4b01-90e6-d701748f0851 | No |
app_version Recommended | 1.0.0 | No |
platform Recommended | iOS | No |
os_name Recommended | iOS | No |
os_version Recommended | 13.3.1 | No |
carrier Recommended | AT&T | No |
device_model Recommended | iPhone 11 | No |
device_manufacturer Recommended | Apple | No |
ip Recommended | 192.168.0.1 | No |
user_agent Recommended | Mozilla/5.0 (iPhone; CPU iPhone OS 13_3_1 like Mac OS X) AppleWebKit/605.1.15 | No |
Integration Validation
- Coordinate with your Amplitude representative to confirm that events are being received and processed correctly on their backend.
Additional Amplitude Documentation
Updated 6 days ago