Last modified November 14, 2017 by Shelly Wolfe

Amplitude

Amplitude iconAmplitude is an analytics platform that provides valuable insights into user behavior. The Amplitude Adaptor enables you to send user behavior data, events, and attribution information to Amplitude based on a user’s interaction with the mobile app.

Supported Actions

The Amplitude Adaptor supports the following outbound actions:

  • Send an attribution event
  • Send other events
  • Update Amplitude user profile with Swrve properties

There are two main steps involved in configuring the actions for the Amplitude adaptor:

  1. Create a custom event in the Swrve SDK for the user action you want to use to trigger the selected outbound action; for example, install_[campaign name].
  2. Create an Amplify rule that is triggered on receipt of the designated event and uses the outbound action to send events or user profile information to Amplitude.

Use Cases

Send Attribution

Send an attribution event to notify Amplitude of the channel through which the user was acquired. For example, the name of a paid referrer channel or campaign.

Track Event

Create events in Amplitude using Swrve data. This could be Swrve events or anything you wanted to track in Amplitude.

Update User Profile

Update user profile information in Amplitude with data collected by Swrve.


Adaptor Configuration

Step 1: To access the configuration settings, on the Amplitude Adaptor card, click Configure.

Step 2: Complete the following fields as required:

Field Description
API Key Your Amplitude application API key. To view this value, on the Amplitude user menu, select Settings > Projects.

Step 3: To save the configuration settings, click Save.

After you click Save, the status of the Adaptor changes to Active and the Deactivate button is available.


Rule Configuration

This section describes the fields that are included when creating a new rule. For most fields, you have the option to manually enter the value or to select a user property from the list to have Swrve automatically populate the value when the rule is processed. For more information on rules, see Creating Amplify Rules.

Send Attribution

Use the Send Attribution action to send attribution information to Amplitude. If Amplitude cannot match the attribution event to an existing user, they hold the data for up to 24 hours. If Amplitude can’t match a user to that event within 24 hours (using IDFA or ADID), they will drop the data.

Complete the following fields:

Field Required / Optional Description
Event Type Required The event type being sent. You should prefix the event type with your company’s name in brackets. For example, [YOUR COMPANY] Install.
Platform Required The user’s platform, either iOS or Android.
Identifier for Advertiser Required (iOS only) The Apple Identifier for Advertiser (IDFA). For iOS devices, you can send either the IDFA or the IDFV but you must send at least one.
Google Play Services ADID Required (Android only) The Google Advertising ID.
Identifier for Vendor Optional (iOS only) The Identifier for Vendor (IDFV). For iOS devices, you can send either the IDFA or the IDFV but you must send at least one.
Android ID Optional (Android only) The Android ID.
User Properties Optional A dictionary of attribution properties for the user. You should prefix the value with your company’s name in brackets.

Track Event

Use the Track Event action to register events with Amplitude. Complete the following fields:

Field Required / Optional Description
User ID Required The user identifier specified by you. For example, a username or internal unique identifier used to track your user that is shared between Swrve and Amplitude. This value is required if Device ID is blank.
Device ID Required A device-specific identifier. This value is required if User ID is blank.
Event Type Required A unique identifier for your event. Amplitude reserves the use of the following names:

  • [Amplitude] Start Session
  • [Amplitude] End Session
  • [Amplitude] Revenue
  • [Amplitude] Revenue (Verified)
  • [Amplitude] Revenue (Unverified)
  • [Amplitude] Merged User
Event Properties Optional A dictionary of key-value pairs that represent additional data you want to send with the event.
User Properties Optional A dictionary of key-value pairs that represent additional data tied to the user. Each distinct value is displayed as a user segment on the Amplitude dashboard.
Time Optional The timestamp of the event in milliseconds since epoch.
App Version Optional The current version of the app the user has installed.
Language Optional The language the user has set.
Revenue Optional The revenue generated by the event.
Latitude Optional The user’s latitude.
Longitude Optional The user’s longitude.
IP Address Optional The user’s IP address.
Identifier for Advertiser Optional The Apple Identifier for Advertiser (IDFA).
Google Play Services ADID Optional The Google Advertising ID.

Update User Profile

Use the Update User Profile action to update the user profile information in Amplitude with data collected by Swrve. Complete the following fields:

Field Required / Optional Description
User ID Required The user identifier specified by you. For example, a username or internal unique identifier used to track your user that is shared between Swrve and Amplitude. This value is required if Device ID is blank.
Device ID Required A device-specific identifier. This value is required if User ID is blank.
User Properties Required A dictionary of key-value pairs that represent additional data tied to the user. Each distinct value is displayed as a user segment on the Amplitude dashboard.
App Version Required The current version of the app the user has installed.
Platform1 Optional The user’s platform.
OS or Browser Name1 Optional The user’s mobile operating system (OS) or browser.
OS or Browser Version1 Optional The user’s mobile OS or browser version.
Device Brand1 Optional The user’s device brand.
Device Manufacturer1 Optional The user’s device manufacturer.
Device Model1 Optional The user’s device model.
Device Type1 Optional The user’s device type.
Note: Do not use this field if you’re already using Device Brand, Device Manufacturer, and Device Model.
Carrier1 Optional The user’s mobile network operator.
Country2 Optional The user’s country.
Region2 Optional The user’s geographical region.
City2 Optional The user’s city.
Designated Market Area2 Optional The user’s Designated Market Area (DMA).
Language Optional The language the user has set.
Paying User Optional The paying status of the user.
Start Version Optional The initial version of the app that the user installed.

1 You must update all of these fields (Platform, OS or Browser Name, OS or Browser Version, Device Brand, Device Manufacturer, Device Model, Device Type, Carrier) at the same time. If you set any one of these fields, it resets all of the others if they are not also set in the same event.

2 You must update all of these fields (Country, Region, City, DMA) at the same time. If you set any one of these fields, it resets all of the others if they are not also set in the same event.