Amplitude

expo-analytics-amplitude provides access to Amplitude mobile analytics which allows you track and log various events and data. This module wraps Amplitude's iOS and Android SDKs. For a great example of usage, see the Expo app source code.

Please note: Session tracking may not work correctly when running Experiences in the main Expo app. It will work correctly if you create a standalone app. For example, the version logged when running experiences in the Expo app will be the Expo app version. Whereas in standalone apps, the version set in app.json is used. For more information see this issue on GitHub.

Platform Compatibility

Android Device	Android Emulator	iOS Device	iOS Simulator	Web

Installation

Terminal

→ expo install expo-analytics-amplitude

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

API

import * as Amplitude from 'expo-analytics-amplitude';

Methods

`Amplitude.clearUserPropertiesAsync()`

Clear properties set by setUserPropertiesAsync().

Returns

Promise<void>

`Amplitude.initializeAsync(apiKey)`

Arguments

Name	Type	Description
apiKey	`string`	Your Amplitude application's API key.

Initializes Amplitude with your Amplitude API key. If you're having trouble finding your API key, see step 4 of these instructions.

Returns

Promise<void>

`Amplitude.logEventAsync(eventName)`

Arguments

Name	Type	Description
eventName	`string`	The event name.

Log an event to Amplitude. For more information about what kind of events to track, see here.

Returns

Promise<void>

`Amplitude.logEventWithPropertiesAsync(eventName, properties)`

Arguments

Name	Type	Description
eventName	`string`	The event name.
properties	`Record<string, any>`	A map of custom properties.

Log an event to Amplitude with custom properties. For more information about what kind of events to track, see here.

Returns

Promise<void>

`Amplitude.setGroupAsync(groupType, groupNames)`

Arguments

Name	Type	Description
groupType	`string`	The group name, e.g. "sports".
groupNames	`string[]`	An array of group names, e.g. ["tennis", "soccer"]. Note: The iOS and Android Amplitude SDKs allow you to use a string or an array of strings. We only support an array of strings. Just use an array with one element if you only want one group name.

Add the current user to a group. For more information, see here for iOS and see here for Android.

Returns

Promise<void>

`Amplitude.setTrackingOptionsAsync(options)`

Arguments

Name	Type	Description
options	`AmplitudeTrackingOptions`	Options object for what should not be tracked. The table below describes what properties the object may contain. All properties are expected to be booleans. For example, passing `disableCarrier: true` disables tracking the device's carrier.

By default, the Amplitude SDK will track several user properties such as carrier and city. You can use this method to customize and disable individual fields.

Note: These configurations will prevent default properties from being tracked on newly

created projects, where data has not yet been sent. Please contact platform@amplitude.com if you would like default properties blocked (moving forward) on projects with existing data.

Returns

Promise<void>

`Amplitude.setUserIdAsync(userId)`

Arguments

Name	Type	Description
userId	`null \| string`	User ID for the current user. Can be set to `null` (e.g. when the user is logging out).

Assign a user ID to the current user. If you don't have a system for user IDs you don't need to call this. See this page for details.

Returns

Promise<void>

`Amplitude.setUserPropertiesAsync(userProperties)`

Arguments

Name	Type	Description
userProperties	`Record<string, any>`	A map of custom properties.

Set properties for the current user. See here for details.

Returns

Promise<void>

Interfaces

`AmplitudeTrackingOptions`

Name	Type	Description
disableAdid (optional)	`boolean`	-
disableCarrier (optional)	`boolean`	Disable tracking of the device's carrier.
disableCity (optional)	`boolean`	Disable tracking of the user's city.
disableCountry (optional)	`boolean`	Disable tracking of the user's country.
disableDMA (optional)	`boolean`	Disable tracking of the user's DMA.
disableDeviceBrand (optional)	`boolean`	Disable tracking of the device brand.
disableDeviceManufacturer (optional)	`boolean`	Disable tracking of the device manufacturer.
disableDeviceModel (optional)	`boolean`	Disable tracking of the device model.
disableIDFV (optional)	`boolean`	Disable tracking of the user's IDFV.
disableIPAddress (optional)	`boolean`	Disable tracking of the user's IP address.
disableLanguage (optional)	`boolean`	Disable tracking of the device's language.
disableLatLng (optional)	`boolean`	Disable tracking of the user's current latitude and longitude coordinates.
disableOSName (optional)	`boolean`	Disable tracking of the device's OS name.
disableOSVersion (optional)	`boolean`	Disable tracking of the device's OS version.
disablePlatform (optional)	`boolean`	Disable tracking of the device's platform.
disableRegion (optional)	`boolean`	Disable tracking of the user's region.
disableVersionName (optional)	`boolean`	Disable tracking of the app version the user is on for your app.