You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Analytics React Native Amplitude Plugin

Amplitude is an event tracking and segmentation platform for your web and mobile apps. By analyzing the actions your users perform, you can gain a better understanding to drive retention, engagement, and conversion.

Getting started

Before you start, go to your Amplitude workspace. Click Settings in the bottom left, then click Projects in the left menu. Select your Project. Copy the Amplitude API Key and Secret Key for the project.
From the Segment web app, click Catalog, then click Destinations.
Find the Destinations Actions item in the left navigation, and click it.
Click the "Amplitude" item to select it and click Configure.
Choose which of your sources to connect the destination to. (You can connect more sources to the destination later.)

Once you have a mapping, you can follow the steps in the Destinations Actions documentation on Customizing mappings.

The Amplitude React Native plugin doesn't send events to Amplitude from the client side. It instead adds Amplitude session data and then sends it server side from the Amplitude Actions destination.

Adding the dependency

Using NPM:

npm install --save @segment/analytics-react-native-plugin-amplitude-session

Using Yarn:

yarn add @segment/analytics-react-native-plugin-amplitude-session

Using the plugin in your app

Follow the instructions for adding plugins on the main Analytics client:

In your code where you initialize the analytics client call the .add(plugin) method with an AmplitudeSessionPlugin instance:

1import { createClient } from '@segment/analytics-react-native';
2
3import { AmplitudeSessionPlugin } from '@segment/analytics-react-native-plugin-amplitude-session';
4
5const segmentClient = createClient({
6  writeKey: 'SEGMENT_KEY'
7});
8
9segmentClient.add({ plugin: new AmplitudeSessionPlugin() });

Log purchases in existing destination instances

Initially, the Log Event Action was reporting purchases to Amplitude for all events containing a products array, even if the products were just added to cart. This inflated the LTV Chart in Amplitude.

To resolve this, purchase reporting takes place in a new Action called Log Purchase.

For instances created prior to before the Log Purchases action was released, you need to manually add the Log Purchases Action to report purchases to Amplitude.

To manually add the Log Purchases Action:

Add a new Mapping for the Log Purchases Action. The default trigger for this action is Order Completed events.
Modify the Trigger if you need to report purchases for any other events.
Modify the Trigger of Log Event to exclude these same events. This helps you to avoid sending the same event twice.
Enable the Log Purchases mapping.

Connection modes for Amplitude (Actions) destination

The Amplitude (actions) destination does not offer a device-mode connection mode. With the Actions-framework version of the destination, you do not need the device-mode connection.

Most previous deployments of the Amplitude Segment destination used the device-mode connection to use the session_id tracking feature. The new Actions-framework Amplitude destination, includes session ID tracking by default. This means you don't need to bundle any software to run on the user's device, or write any code. It also means that you can use more of the Segment platform features on data going to Amplitude, such as Protocols filtering and transformations, and Profiles Identity Resolution.

Device ID mappings

The Amplitude destination requires that each event include either a Device ID or a User ID. If a User ID isn't present, Amplitude uses the a Device ID, and vice versa, if a Device ID isn't present, Amplitude uses the User ID.

By default, Segment maps the Segment property context.device.id to the Amplitude property Device ID. If context.device.id isn't available, Segment maps the property anonymousId to the Amplitude Device ID. The Actions interface indicates this with the following contents of the Device ID field: coalesce( context.device.id anonymousId ).

Amplitude (Actions) uses Amplitude's HTTP API v2

(warning)

Classic Amplitude was built on Amplitude's now-deprecated HTTP API v1

If you used Amplitude Classic in cloud-mode, you'll notice different responses from Amplitude to calls you make with the destination.

You configure the Amplitude (Actions) destination through Filters and Actions. Consult the following table for information about configuring your Amplitude (Actions) destination similarly to your classic Amplitude destination.

Contact Segment support if you find features missing from the Amplitude (Actions) destination that were available in the classic Amplitude destination.

Amplitude settings mapping

Amplitude Classic Destination Setting	How to enable in Amplitude (Actions)
CONNECTION SETTINGS
API Key clouddevice-webdevice-mobile	Global Setting
Version Name device-web	Action field App Version. Defaults to `context.app.version`.
Connection Mode clouddevice-webdevice-mobile	Actions support Cloud mode connections
PAGE AND SCREEN
Track all pages to Amplitude clouddevice-webdevice-mobile	Subscription Page Calls When enabled, Amplitude (Actions) tracks all Page calls by default
Track all Screens clouddevice-webdevice-mobile	Subscription Page Calls When enabled, Amplitude (Actions) tracks all Screen calls by default
Track Categorized Pages to Amplitude clouddevice-webdevice-mobile	Subscription Page Calls Add a Trigger filter condition to check that Event Property category exists
Track Named Pages to Amplitude clouddevice-webdevice-mobile	Subscription Page Calls Add a Trigger filter condition to check that Event Property name exists
TRAITS
Group Type Trait clouddevice-webdevice-mobile	Subscription Group Identify User. Select a value in the Group Type actions field. This field is mandatory in Amplitude (Actions). In the Amplitude Classic destination, ommiting a value for property field resulted in Amplitude creating a group called `[Segment] Group`.
Group Value Trait clouddevice-webdevice-mobile	Subscription Group Identify User. Select a value in the Group Value actions field. This field is mandatory in Amplitude actions. In the Amplitude Classic destination, ommiting a value for this property resulted in an alpha-numeric value.
OTHER SETTINGS
Batch Events device-web	Use Batch Endpoint field on the Log Event action
Prefer Anonymous Device ID clouddevice-webdevice-mobile	Actions field Device ID. Replace the contents of the field with your preferred value.
Secret Key clouddevice-webdevice-mobile	Global Setting
Enable Alias cloud	Use the Map User action. The Map User action is not enabled by default. Add a new Subscription to access the Map User action.
Send to Batch Endpoint cloud	Use Batch Endpoint field on the Log Event action
Track Referrer to Amplitude device-web	Update the User Properties mapping to send `context.page.referrer`.
Track Revenue per Product clouddevice-webdevice-mobile	Actions field Track Revenue Per Product. Available in any subscription that uses the Log Event action. <br /> In Amplitude (Actions), this setting elevates `revenue` to a top-level property. This allows revenue data to pass through to Amplitude's LTV reports.
Track UTM Properties to Amplitude clouddevice-web	Supported by default. See the UTM Properties section to view the mappings.
Use Advertising ID for Device ID clouddevice-webdevice-mobile	Actions field Device ID. Update the value so your preferred field appears first in the `coalesce()` function.
Send Custom Language and Country Properties	Actions fields Language and Country These fields are set by default with values from the context object.

Advanced Amplitude (Actions) settings

Increment traits

The traitsToIncrement setting increases a user property by some numerical value. If the user property does not have a value set yet, Segment initializes it with a value of 0. The trait must have a numerical value so it can be incremented.

In the following example, the Amplitude User property friendCount equals 4.

1"traits" : {"$add": {"friendCount": 3} }
2"traits" : {"$add": {"friendCount": 1} }