Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
Warehouse Sync API Overview
Warehouse Sync API Tutorial
Warehouse Sync API Reference
Data Mapping
Warehouse Sync SQL Reference
Warehouse Sync Troubleshooting Guide
ComposeID
Warehouse Sync API v2 Migration
Bulk Profile Deletion API Reference
Calculated Attributes Seeding API
Data Planning API
Custom Access Roles API
Group Identity API Reference
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
AMP SDK
Initialization
Configuration
Network Security Configuration
Event Tracking
User Attributes
IDSync
Screen Events
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Push Notifications
WebView Integration
Logger
Preventing Blocked HTTP Traffic with CNAME
Linting Data Plans
Troubleshooting the Android SDK
API Reference
Upgrade to Version 5
Cordova Plugin
Identity
Direct URL Routing FAQ
Web
Android
iOS
Initialization
Configuration
Event Tracking
User Attributes
IDSync
Screen Tracking
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Push Notifications
Webview Integration
Upload Frequency
App Extensions
Preventing Blocked HTTP Traffic with CNAME
Linting Data Plans
Troubleshooting iOS SDK
Social Networks
iOS 14 Guide
iOS 15 FAQ
iOS 16 FAQ
iOS 17 FAQ
iOS 18 FAQ
API Reference
Upgrade to Version 7
Getting Started
Identity
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
Initialization
Content Security Policy
Configuration
Event Tracking
User Attributes
IDSync
Page View Tracking
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Custom Logger
Persistence
Native Web Views
Self-Hosting
Multiple Instances
Web SDK via Google Tag Manager
Preventing Blocked HTTP Traffic with CNAME
Facebook Instant Articles
Troubleshooting the Web SDK
Browser Compatibility
Linting Data Plans
API Reference
Upgrade to Version 2 of the SDK
Getting Started
Identity
Web
Alexa
Overview
Step 1. Create an input
Step 2. Verify your input
Step 3. Set up your output
Step 4. Create a connection
Step 5. Verify your connection
Step 6. Track events
Step 7. Track user data
Step 8. Create a data plan
Step 9. Test your local app
Overview
Step 1. Create an input
Step 2. Verify your input
Step 3. Set up your output
Step 4. Create a connection
Step 5. Verify your connection
Step 6. Track events
Step 7. Track user data
Step 8. Create a data plan
Overview
Step 1. Create an input
Step 2. Verify your input
Step 3. Set up your output
Step 4. Create a connection
Step 5. Verify your connection
Step 6. Track events
Step 7. Track user data
Step 8. Create a data plan
Step 1. Create an input
Step 2. Create an output
Step 3. Verify output
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Glossary
Data Hosting Locations
Migrate from Segment to mParticle
Migrate from Segment to Client-side mParticle
Migrate from Segment to Server-side mParticle
Segment-to-mParticle Migration Reference
Rules Developer Guide
API Credential Management
The Developer's Guided Journey to mParticle
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
The new mParticle Experience
The Overview Map
Introduction
Data Retention
Connections
Activity
Live Stream
Data Filter
Rules
Tiered Events
mParticle Users and Roles
Analytics Free Trial
Troubleshooting mParticle
Usage metering for value-based pricing (VBP)
Introduction
Sync and Activate Analytics User Segments in mParticle
User Segment Activation
Welcome Page Announcements
Project Settings
Roles and Teammates
Organization Settings
Global Project Filters
Portfolio Analytics
Analytics Data Manager Overview
Events
Event Properties
User Properties
Revenue Mapping
Export Data
UTM Guide
Data Dictionary
Query Builder Overview
Modify Filters With And/Or Clauses
Query-time Sampling
Query Notes
Filter Where Clauses
Event vs. User Properties
Group By Clauses
Annotations
Cross-tool Compatibility
Apply All for Filter Where Clauses
Date Range and Time Settings Overview
Understanding the Screen View Event
Analyses Introduction
Getting Started
Visualization Options
For Clauses
Date Range and Time Settings
Calculator
Numerical Settings
Assisted Analysis
Properties Explorer
Frequency in Segmentation
Trends in Segmentation
Did [not] Perform Clauses
Cumulative vs. Non-Cumulative Analysis in Segmentation
Total Count of vs. Users Who Performed
Save Your Segmentation Analysis
Export Results in Segmentation
Explore Users from Segmentation
Getting Started with Funnels
Group By Settings
Conversion Window
Tracking Properties
Date Range and Time Settings
Visualization Options
Interpreting a Funnel Analysis
Group By
Filters
Conversion over Time
Conversion Order
Trends
Funnel Direction
Multi-path Funnels
Analyze as Cohort from Funnel
Save a Funnel Analysis
Explore Users from a Funnel
Export Results from a Funnel
Saved Analyses
Manage Analyses in Dashboards
Dashboards––Getting Started
Manage Dashboards
Dashboard Filters
Organize Dashboards
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
User Aliasing
The Demo Environment
Keyboard Shortcuts
Analytics for Marketers
Analytics for Product Managers
Compare Conversion Across Acquisition Sources
Analyze Product Feature Usage
Identify Points of User Friction
Time-based Subscription Analysis
Dashboard Tips and Tricks
Understand Product Stickiness
Optimize User Flow with A/B Testing
User Segments
IDSync Overview
Use Cases for IDSync
Components of IDSync
Store and Organize User Data
Identify Users
Default IDSync Configuration
Profile Conversion Strategy
Profile Link Strategy
Profile Isolation Strategy
Best Match Strategy
Aliasing
Overview
Create and Manage Group Definitions
Introduction
Catalog
Live Stream
Data Plans
Blocked Data Backfill Guide
Predictive Attributes Overview
Create Predictive Attributes
Assess and Troubleshoot Predictions
Use Predictive Attributes in Campaigns
Predictive Audiences Overview
Using Predictive Audiences
Introduction
Profiles
Warehouse Sync
Data Privacy Controls
Data Subject Requests
Default Service Limits
Feeds
Cross-Account Audience Sharing
Approved Sub-Processors
Import Data with CSV Files
CSV File Reference
Glossary
Video Index
Single Sign-On (SSO)
Setup Examples
Introduction
Introduction
Introduction
Rudderstack
Google Tag Manager
Segment
Advanced Data Warehouse Settings
AWS Kinesis (Snowplow)
AWS Redshift (Define Your Own Schema)
AWS S3 Integration (Define Your Own Schema)
AWS S3 (Snowplow Schema)
BigQuery (Snowplow Schema)
BigQuery Firebase Schema
BigQuery (Define Your Own Schema)
GCP BigQuery Export
Snowflake (Snowplow Schema)
Snowplow Schema Overview
Snowflake (Define Your Own Schema)
Aliasing
Event
Event
Audience
Audience
Feed
Event
Audience
Cookie Sync
Event
Audience
Audience
Audience
Event
Event
Feed
Event
Audience
Event
Data Warehouse
Event
Event
Event
Event
Audience
Event
Event
Event
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Audience
Feed
Event
Event
Event
Custom Feed
Data Warehouse
Event
Event
Audience
Audience
Audience
Audience
Event
Event
Event
Event
Event
Event
Audience
Audience
Event
Audience
Data Warehouse
Event
Event
Audience
Cookie Sync
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Event
Audience
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Event
Event
Custom Pixel
Feed
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Audience
Audience
Cookie Sync
Event
Audience
Feed
Audience
Event
Event
Audience
Audience
Event
Event
Event
Event
Audience
Cookie Sync
Cookie Sync
Audience
Audience
Feed
Nami ML helps you launch, grow and optimize your mobile app’s revenue using an in-app purchase and subscription model.
With your Nami ML Account Rep, determine which Nami ML identity type to map to mParticle’s Customer ID to ensure your Nami ML data is connected to the right user profiles. Nami ML will also send namiml_user_id as a Partner Identity.
Please see Nami ML’s Documentation for more details.
Full details on the events sent by Nami ML and the possible attributes within those events can be found below.
Nami ML will send the following events to mParticle as Custom Events of type transaction.
| Event | Event Attributes | Description |
|---|---|---|
| cancelled | namiml_event_category, namiml_event_subcategory1, event_platform |
The cancelled event is generated when the user takes an action that either cancels a subscription or shuts of an auto-renewing process for a subscription. A cancellation does not result in the revocation of an entitlement and loss of access to your app’s premium features, it just shuts off any future billing after the current bill term end. See the expired event for when an entitlement is no longer active. |
| expired | namiml_event_category, namiml_event_subcategory1, event_platform |
The expired event occurs when a user’s access to an entitlement should be revoked. This may occur because they had previously cancelled, the subscription is not set up for auto-renewing payments, or the payment was never received due to a billing error. |
| in_grace_period | namiml_event_category, namiml_event_subcategory1, event_platform |
The grace period event occurs when billing for a purchase product has failed and the store platform is still actively trying to recover the payment. |
| paused | namiml_event_category, namiml_event_subcategory1, event_platform |
The paused event occurs when a user has decided to pause their subscription and it will automatically resume at a future date. Android only. |
| purchased | namiml_event_category, namiml_event_subcategory1, event_platform |
The purchased event is generated when a purchase is made by a user that generates a new active entitlement. Purchase events are produced the first time a user purchases and also on any subsequent purchase where the entitlement has lapsed and is no longer active. A purchase made of a product sku that grants an entitlement that is already active will not generate a purchased event. |
| renewal_in_grace_period | namiml_event_category, namiml_event_subcategory1, event_platform |
The renewal in grace period event occurs when the store platform was successful in recovering payment while a user was in grace period. |
| renewed | namiml_event_category, namiml_event_subcategory1, event_platform |
The renewed event is produced each time a payment is processed on a subscription with an active entitlement after the initial purchase. If there was a gap where the entitlement was not active then a new purchase will produce a purchased event instead of a renewed event. |
| resumed | namiml_event_category, namiml_event_subcategory1, event_platform |
The resumed event occurs when a subscription becomes active again after a pause. Android only. |
| trial_converted | namiml_event_category, namiml_event_subcategory1, event_platform |
The trial_converted event occurs when a customer’s free trial ends and they are billed for a paying subscription for the first time. This will occur at the same time as a renewed event. |
| trial_did_not_convert | namiml_event_category, namiml_event_subcategory1, event_platform |
The trial_did_not_convert event occurs when a customer ends their free trial and does not continue on to a paying subscription. This will occur at the same time as a an expired event. |
| trial_started | namiml_event_category, namiml_event_subcategory1, event_platform |
The trial_started event occurs when a customer begins a free trial. This will occur at the same time as a purchased event. |
Nami ML will send the following events to mParticle as Custom Events of type impression.
| Event | Event Attributes | Description |
|---|---|---|
| impression | namiml_event_category, app_env, app_platform_id, controller_name, cta_type, developer_paywall_id, initiator, id, name |
An impression event is generated each time a user was presented with a paywall. |
Nami ML will send the following events to mParticle as Commerce Events.
| Commerce Action Type | Event Attributes | Description |
|---|---|---|
| Product Action - purchase | namiml_event_category, app_env, locale, impression_id, original_transaction_id, purchase_env, source, subscription_interval, subcription_interval_count |
A transaction event is the record produced in Nami ML when a user makes a purchase in an app. |
| Attribute Name | Description |
|---|---|
| app_env | The app environment where the purchase made. This value is auto-detected and varies in capability per store environment. The default is production if any other value cannot be determined. Values include simulator_development, device_development, beta_testing, and production. |
| app_platform_id | The app platform id from the Nami Control Center. |
| controller_name | The name of the screen from which the paywall was raised, if it can be determined. |
| cta_type | The type of call to action that was displayed, based on what you created in the Nami Control Center. |
| developer_paywall_id | The developer paywall id created in the |
| event_platform | The name of the platform that produced the event such as apple or google. |
| id | The id of the impression. This can be used to link to a transaction to determine which paywall impression resulted in a purchase. |
| impression_id | The id of the paywall impression from which the purchase was made, if it was made in the app. This can be used to link to the impression events. |
| initiator | Value describes why the paywalll was shown to the user. Values: nami_ml when a machine learning model decided to show the user the paywall, nami_rules when the campaign rules engine displayed the paywall, user when the user requested to see the paywall, and unknown if it cannot be determined. |
| locale | String that includes the language code, country code, and currency code for the device that made the purchase. |
| name | The name of the paywall set in the Nami Control Center. |
| namiml_event_category | Possible values are user or device. |
| namiml_event_subcategory1 | Possible values are subscription. |
| original_transaction_id | A unique id that groups multiple related purchases on a single platform if supported by the store. |
| purchase_env | The purchase environment of the transaction. Possible values are production or sandbox. |
| source | The source of the transaction provides context on where the user made their purchase. Values are external for purchases made outside the app, nami_triggered if the purchase was on a paywall auto-raised by Nami ML, user_initiated if it was on a paywall the user invoked themselves, or unknown if none of the previous options could be determined. |
| subcription_interval_count | The number of subscription intervals included in the purchase if applicable. Example: a store platform where you can sell a 1 week subscription as seven 1-day intervals. |
| subscription_interval | The length of the subscription. Possible values are day, week, month, quarter, halfyear, year |
| User Attribute | Type | Description |
|---|---|---|
| namiml_active_entitlements | Array |
Any entitlements that currently apply to the customer |
| namiml_active_skus | Array |
A list of currently purchased product SKUs that correspond to the namiml_active_entitlements associated with the customer. |
| namiml_device_ids | Array |
The device IDs associated with the customer |
| namiml_device_platforms | Array |
The platforms of the devices associated with the customer |
| namiml_former_subscriber | String |
Whether or not the customer is a former subscriber |
| namiml_in_grace_period | String |
Whether or not the customer is currently in a grace period |
| namiml_in_trial_period | String |
Whether or not the customer is currently in a trial period |
| namiml_in_intro_offer_period | String |
Whether or not the customer is in an introductory offer period |