mParticle

Send data from Nami ML to mParticle.

Integrate Nami with mParticle so you can send data from Nami to other services that you use and build audiences based on Nami ML attributes.

📘

Our mParticle integration is available on our paid plans. Please contact us if you are interested in this feature.

📘

This is a server-side integration where Nami sends data directly to mParticle. There is minimal SDK work required to enable it. See the Customer ID section below.

mParticle Setup

Nami uses mParticle Act As Feeds where we send data separately for each platform (such as iOS and Android on mParticle). You'll need to repeat the steps below for each platform you want to configure to send data from Nami to mParticle.

  1. To get started, find our integration in https://app.mparticle.com/ by clicking on the Directory in the navigation, entering nami ml in the search box, hovering over our tile, and then clicking the Setup button.
13741374
  1. If this is the first time you've set up a Nami ML integration, you'll see a modal where you need to select the integration type as INPUT Feed by clicking the checkbox and then clicking the Configure button.
13741374

Creating a Nami ML feed for the first time.

📘

If you have previously setup a Nami ML feed, click the Go to Setup button on this screen to configure a new feed.

Jump to step 5 below to continue your setup.

13741374

Creating a feed after creating your first Nami ML feed.

  1. On the next screen, you'll need to enter a Configuration Name and Select a Platform from the dropdown. After you've selected a platform, click the Save & Open in Connections button. We recommend clearly naming your Configuration based on the platform as you'll end up with multiple feeds when you are done.
13741374
  1. On the next screen copy and save the Server to Server Key and the Server to Server Secret. You'll need these to set up mParticle in the Nami Control Center in the next section. Then click the Close button.
13741374
  1. To add an additional feed, navigate to Setup, Inputs and then click the Plus Button next to Nami ML.
13741374
  1. Then click the Plus Button that appears on the right side of the screen. Go back to step 3 and complete the configuration of the new feed.
13741374

👍

For most apps, you should have an iOS and an Android feed configured for Nami ML at this point.

Configure mParticle in the Nami Control Center

📘

In the Nami Control Center, you'll need to set up 1 mParticle integration for each platform your app uses. For most apps, you'll want to follow the steps below twice to set up one integration for iOS and one for Android.

  1. Log in to the Nami Control Center and Navigate to the Integrations screen. Then scroll down to All Integrations and click the mParticle tile.
13741374
  1. On the next screen toggle on Enable Integration. Then select Enable for events from only selected platform and choose your platform from the dropdown. Enter a Name, the Server to Server Key and Server to Server Secret that you generated in the previous section. Finally, select a value to use for the Customer ID in the dropdown.

👍

Most apps will use External ID for the Customer ID in this step. For more details on the Customer ID, jump ahead to the Customer ID section.

13831383

🚧

For step 2 in the image above, Enable for events from "Your App Name" App and all Platforms is a legacy configuration that should no longer be used for new mParticle feeds.

  1. Select the events you wish to send to mParticle in the last section of the screen by expanding and clicking the checkboxes. An overview of these data is provided in the next section. When complete click Add New Integration.
13831383
  1. Repeat these steps to set up each Platform Feed you created for mParticle.

👍

When finished, most apps should have 2 mParticle integrations configured at this point. One for iOS and one for Android.

Overview of data sent to mParticle

The following events generated by the Nami ML platform are currently available to be sent to mParticle. You may choose any subset of these events to be sent.

  • device.impression
  • device.transaction
  • user.journey.trial.converted
  • user.journey.trial.did_not_convert
  • user.journey.trial.started
  • user.subscription.cancelled
  • user.subscription.expired
  • user.subscription.in_grace_period
  • user.subscription.paused
  • user.subscription.purchased
  • user.subscription.renewal_in_grace_period
  • user.subscription.renewed
  • user.subscription.resumed

See our full list of Event Types here as well as more documentation on how to interpret each event.

mParticle Customer ID

mParticle uses a Customer ID field to define users in their platform. It is important that you properly set this ID in the Nami ML platform so that users in our platform are properly linked with users in mParticle.

There are 2 different IDs that are available to be used as the Customer ID.

  • Nami User ID This is Nami's internal ID that tracks a user in our platform. If you have no other identifier you may use this.
  • External ID This is the identifier that you set in the SDK with a call to setExternalIdentifier. We expect most customers to use the External ID for the mParticle Customer ID.

User Attributes

We provide the following user attributes on all user.* events sent to mParticle.

User AttributeDescription
namiml_active_entitlementsArray of entitlement_ref_id's for each active entitlement that the user currently has access to.
namiml_active_skusArray of sku_ref_id's for the associated purchases with each active entitlement the user currently has access to.
namiml_device_idsArray of UUIDs for each device that belongs to the user.
namiml_device_platformsArray of app_platform_id's for each device.
namiml_former_subscriberTrue if the user previously paid for a subscription and currently does not have an active subscription.
namiml_in_grace_periodTrue if the user is currently in grace period, false otherwise.
namiml_in_trial_periodTrue if the user is currently in a free trial, false otherwise.
namiml_in_intro_offer_periodTrue if the user is currently in an intro offer period, false otherwise.

For more information, see the documentation on mParticle's website.