Nami Public Documentation
Sign In
Nami Documentation
Nami Documentation
  • Get Started
    • Overview
      • Key Concepts
      • Data Collection
      • Built for Privacy
    • Evaluating Nami
    • SDKs
      • Apple Native SDK
      • Android Native SDK
      • Amazon Native SDK
      • Roku Native SDK
      • React Native Cross-Platform SDK
      • Flutter Cross-Platform SDK
      • Unity Cross-Platform SDK
      • Release Notes
        • Find Nami SDK Version
    • Quickstart Guide
  • Subscription Management
    • Overview
    • Products
      • Archive Products
      • Sync Products
    • Entitlements
    • Customer Screen
    • Accounts and Login/Logout
    • Advanced Use Cases
      • Upgrades and Downgrades
      • Supported Purchase Change States by Platform
      • Restoring Purchases
      • Working with Consumable IAPs
  • No Code Paywalls
    • Overview
    • Paywall Creator
      • Using the Creator
      • Paywall Layout
      • Components
        • Editing, Deleting, Reordering
        • Hiding Components
        • Video
        • Collapse
      • Editable Properties
        • Focused Styling
        • Safe Area
      • Conditions
        • Notched Devices
        • Product Entitlements
      • Adding Products
      • Repeating Product Group
      • Product Fields
      • Capabilities
        • Featured Styling
        • Selected Styling
        • Custom Brand Fonts
        • Carousel
        • Trial Eligibility
        • Deeplink Button
        • Introductory Offer Eligibility
        • Login Check
        • Product Groups
        • Conditional Product Groups
        • Offer Eligibility and Purchasing
        • Screenreader Text
        • Personalization Tokens
        • Custom Variables
        • Multipage
        • Custom Data Source
        • Advanced Video Features
        • Product Error States
      • ❓FAQs
        • Designing Paywalls in Figma
        • Guide to Building a Paywall from Scratch
      • 🎁Releases
        • Roadmap
    • Paywall Templates
      • Pacific
      • Pacific Premium
      • Trident
      • Starfish
      • Mantis
      • Venice
      • Venice Premium
      • Honest
      • Catalina
      • Oyster
      • Puffin
      • Marina
      • Beluga
      • Driftwood
      • Lagoon
      • Pisces
      • Aquarius
      • Conch
      • Lionfish
      • Moray
      • Tetra
      • Lighthouse
      • Puffin Tablet
    • Managing Paywalls
      • Archiving a Paywall
      • Duplicate a Paywall
    • Paywall Smart Text
    • Pricing Eligibility States
    • Pricing Eligibility by Platform
    • Nami Paywalls in Different Languages
    • Legacy Paywalls
  • Campaigns
    • Placements
      • Create a Placement
      • Deeplink Placements
      • Archiving a Placement
      • Managing Lots of Placements
      • Export Placements
    • Campaigns
      • Campaign Filters
        • Campaign Use Cases
      • Archiving a Campaign
      • Scheduling a Campaign
      • Campaign Conversion Events
      • Managing Lots of Campaigns
      • Campaign Troubleshooting
    • A/B and Multivariate Testing
      • Selecting an A/B test winner
      • A/B Test Allocation
  • Integrations
    • All Integrations
    • Billing Platforms
      • Apple Integration
        • App Store Setup
          • Privacy Details
        • Platform Integration
        • App Store Server Notifications
        • Store Credentials
          • App Store Connect Shared Secret
          • Apple App Store Connect API
          • Apple In App Purchase
        • Add a Product
        • Platform Sync
        • SDK Integration
        • Troubleshooting
        • Testing and Development
          • Apple Testing Environments
          • Setting up Device Sandbox Test Environment
          • Setting up StoreKit config in Xcode
      • Google Integration
        • Google Play Store Setup
        • Platform Integration
        • Service Account
        • Real-time Developer Notifications
        • Add a Product
        • Platform Sync
        • SDK Setup
        • Troubleshooting
          • Supporting Android minSdkVersion 25 or lower
          • Requested product is not available for purchase
          • Unsupported Version of Play Billing
      • Amazon Appstore Integration
        • Create Amazon Android App
        • Platform Integration
        • Shared Key
        • Real-time Event Notifications
        • Add a Product
        • SDK Integration
        • Testing
      • Roku Integration
        • Platform Integration
        • API Key
        • Transaction Notifications
        • Add a Product
        • SDK Integration
      • Web Integration
    • Analytics Tools
      • Adobe Analytics
      • Amplitude
      • Google Analytics
      • mParticle
      • 3rd-Party Analytics
    • Subscription Management
      • Nami Subscription Management
      • Bring your Own Payment Code
    • CDP Integrations
      • Adobe CDP Integration
      • Amplitude CDP Integration
      • Custom CDP Integration
      • Generic CDP Integration
    • Other Integrations
      • Wicket Labs
      • Webhooks
        • Introduction to the Nami ML Event System
        • Event Types
          • Purchase Status Updates
          • Events for Upgrades, Downgrades, and Crossgrades
        • Event Subscriptions
        • Understanding Transferred Events and Accounts
      • API Access
    • Events Feed
  • Analytics
    • Using Charts
    • Paywall Analytics
      • Impressions
      • Paywall Conversion Rate
      • Sessions
      • Active Devices
    • Subscription Analytics
      • Revenue
      • MRR
      • Purchases
      • Trial Starts
  • Nami Account
    • Manage your Apps
      • Find your Nami App Platform ID
      • Setting up Legal Text for your Apps
    • Organization
      • Configuring Organization Security Policies
      • Billing
    • Invite your Team
      • Roles
    • Manage your Account
      • Two-Factor Authentication (2FA)
Powered by GitBook
On this page
  • mParticle Setup
  • Configure mParticle in the Nami Control Center
  • Overview of data sent to mParticle
  • mParticle Customer ID
  • User Attributes
  1. Integrations
  2. Analytics Tools

mParticle

Last updated 11 months ago

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

mParticle integration is available on our Enterprise plans

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

mParticle Setup

Nami uses mParticle 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 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.

  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.

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.

  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.

  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.

  1. To add an additional feed, navigate to Setup, Inputs and then click the Plus Button next to Nami ML.

  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.

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

Setup Integrations for Each Platform

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. 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.

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.

  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

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.

User Attributes

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

User Attribute
Description

namiml_active_entitlements

Array of entitlement_ref_id's for each active entitlement that the user currently has access to.

namiml_active_skus

Array of sku_ref_id's for the associated purchases with each active entitlement the user currently has access to.

namiml_device_ids

Array of UUIDs for each device that belongs to the user.

namiml_device_platforms

Array of app_platform_id's for each device.

namiml_former_subscriber

True if the user previously paid for a subscription and currently does not have an active subscription.

namiml_in_grace_period

True if the user is currently in grace period, false otherwise.

namiml_in_trial_period

True if the user is currently in a free trial, false otherwise.

namiml_in_intro_offer_period

True if the user is currently in an intro offer period, false otherwise.

Log in to the Nami Control Center and Navigate to the . Then scroll down to All Integrations and click the mParticle tile.

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

See our as well as more documentation on how to interpret each event.

External ID This is the identifier that you set in the SDK with a call to . We expect most customers to use the External ID for the mParticle Customer ID.

For more information, see the .

Integrations screen
full list of Event Types here
setExternalIdentifier
documentation on mParticle's website
Customer ID section
mParticle
Act As Feeds
https://app.mparticle.com/
Customer ID
Creating a Nami ML feed for the first time
Creating a feed after creating your first Nami ML feed.