Documentation
Developers
API References
Data Subject Request API
Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
Platform API
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
Warehouse Sync API
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
Custom Access Roles API
Bulk Profile Deletion API Reference
Data Planning API
Group Identity API Reference
Calculated Attributes Seeding API
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
Client SDKs
AMP
AMP SDK
Android
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
Cordova Plugin
Identity
Direct Url Routing
Direct URL Routing FAQ
Web
Android
iOS
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
React Native
Getting Started
Identity
Unity
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
Web
Initialization
Configuration
Content Security Policy
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
Xamarin
Getting Started
Identity
Web
Alexa
Quickstart
Android
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
iOS Quick Start
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
Python Quick Start
Step 1. Create an input
Step 2. Create an output
Step 3. Verify output
Server SDKs
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
Guides
Partners
Introduction
Outbound Integrations
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Data Hosting Locations
Glossary
Migrate from Segment to mParticle
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
Guides
Getting Started
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
Platform Guide
The New mParticle Experience
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)
Analytics
Introduction
Setup
Sync and Activate Analytics User Segments in mParticle
User Segment Activation
Welcome Page Announcements
Settings
Project Settings
Roles and Teammates
Organization Settings
Global Project Filters
Portfolio Analytics
Analytics Data Manager
Analytics Data Manager Overview
Events
Event Properties
User Properties
Revenue Mapping
Export Data
UTM Guide
Query Builder
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
Analyses Introduction
Segmentation: Basics
Getting Started
Visualization Options
For Clauses
Date Range and Time Settings
Calculator
Numerical Settings
Segmentation: Advanced
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
Funnels: Basics
Getting Started with Funnels
Group By Settings
Conversion Window
Tracking Properties
Date Range and Time Settings
Visualization Options
Interpreting a Funnel Analysis
Funnels: Advanced
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
Dashboards––Getting Started
Manage Dashboards
Dashboard Filters
Organize Dashboards
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
User Aliasing
Analytics Resources
The Demo Environment
Keyboard Shortcuts
Tutorials
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
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
Data Master
Group Identity
Overview
Create and Manage Group Definitions
Introduction
Catalog
Live Stream
Data Plans
Data Plans
Blocked Data Backfill Guide
Personalization
Predictive Attributes
Predictive Attributes Overview
Create Predictive Attributes
Assess and Troubleshoot Predictions
Use Predictive Attributes in Campaigns
Predictive Audiences
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
Import Data with CSV Files
CSV File Reference
Glossary
Video Index
Analytics (Deprecated)
Identity Providers
Single Sign-On (SSO)
Setup Examples
Introduction
Developer Docs
Introduction
Integrations
Introduction
Rudderstack
Google Tag Manager
Segment
Data Warehouses and Data Lakes
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)
Developer Basics
Aliasing
Integrations
24i
Event
Abakus
Event
ABTasty
Audience
Aarki
Audience
AdChemix
Event
Actable
Feed
Adobe Marketing Cloud
Event
Cookie Sync
Adobe Audience Manager
Audience
Adobe Campaign Manager
Audience
AdMedia
Audience
Adobe Target
Audience
AgilOne
Event
AdPredictive
Feed
Algolia
Event
Alooma
Event
Amazon Advertising
Audience
Amazon Kinesis
Event
Amazon Redshift
Data Warehouse
Amazon S3
Event
Amazon SNS
Event
Adobe Marketing Cloud
Event
Amazon SQS
Event
Amobee
Audience
Anodot
Event
Antavo
Feed
Apptentive
Event
Apptimize
Event
Apteligent
Event
Attractor
Event
Microsoft Azure Blob Storage
Event
Bidease
Audience
Bing Ads
Event
Bluecore
Event
Bluedot
Feed
Branch S2S Event
Event
Bugsnag
Event
Cadent
Audience
Census
Feed
comScore
Event
Conversant
Event
Crossing Minds
Event
Custom Feed
Custom Feed
Databricks
Data Warehouse
Didomi
Event
Datadog
Event
Dynalyst
Audience
Edge226
Audience
Emarsys
Audience
Epsilon
Event
Everflow
Audience
Facebook Offline Conversions
Event
Google Analytics for Firebase
Event
Flybits
Event
ForeSee
Event
Flurry
Event
Google Ad Manager
Audience
FreeWheel Data Suite
Audience
Google Analytics
Event
Google BigQuery
Audience
Data Warehouse
Google Analytics 4
Event
Google Enhanced Conversions
Event
Google Marketing Platform
Cookie Sync
Audience
Event
Google Pub/Sub
Event
Google Tag Manager
Event
Google Marketing Platform Offline Conversions
Event
Heap
Event
Herow
Feed
Hightouch
Feed
Hyperlocology
Event
Impact
Event
Ibotta
Event
InMarket
Audience
Inspectlet
Event
Intercom
Event
ironSource
Audience
Kafka
Event
Kissmetrics
Event
Kubit
Event
LifeStreet
Audience
LaunchDarkly
Feed
Liveramp
Audience
Localytics
Event
LiveLike
Event
MadHive
Audience
Marigold
Audience
mAdme Technologies
Event
MediaMath
Audience
Mediasmart
Audience
Microsoft Azure Event Hubs
Event
Mintegral
Audience
Monetate
Event
Movable Ink
Event
Multiplied
Event
Movable Ink - V2
Event
Nanigans
Event
Nami ML
Feed
Neura
Event
NCR Aloha
Event
OneTrust
Event
Oracle BlueKai
Event
Persona.ly
Audience
Paytronix
Feed
Personify XP
Event
Plarin
Event
Primer
Event
Qualtrics
Event
Quantcast
Event
Regal
Event
Reveal Mobile
Event
RevenueCat
Feed
Rokt
Audience
Salesforce Mobile Push
Event
Scalarr
Event
Shopify
Custom Pixel
Feed
Signal
Event
SimpleReach
Event
Singular-DEPRECATED
Event
Skyhook
Event
Slack
Event
Smadex
Audience
SmarterHQ
Event
Snapchat Conversions
Event
Snowplow
Event
Snowflake
Data Warehouse
Splunk MINT
Event
StartApp
Audience
Tapad
Audience
Tapjoy
Audience
Taptica
Audience
Taplytics
Event
Teak
Audience
The Trade Desk
Audience
Cookie Sync
Event
Ticketure
Feed
TUNE
Event
Triton Digital
Audience
Valid
Event
Vkontakte
Audience
Vungle
Audience
Webhook
Event
Webtrends
Event
White Label Loyalty
Event
Wootric
Event
Xandr
Cookie Sync
Audience
Yahoo (formerly Verizon Media)
Cookie Sync
Audience
Yotpo
Feed
YouAppi
Audience
Quadratic Labs
Event
Event
Leanplum is a mobile marketing platform providing cross-channel messaging and app optimization in a single solution. Leanplum offers Push, Email, Automation, App Editing, Personalization, A/B Testing, and Analytics.
Data Processing Notes
Leanplum has limits around characters and the number of unique event names and attributes their platform can process as noted here: https://docs.leanplum.com/reference#api-limits, a non-compendious list can be found below. You should go to the link for a full list as it may be updated from time-to-time.
- Up to 200 distinct user attribute names per app
- Up to 500 event names per app
- Up to 50 user attributes per user
- Up to 50 event attributes per event
-
Events and user attributes must be under 140 characters and must follow the rules for following special characters:
- a period (.)
- hyphen(-)
- end with a forward slash (/)
- contain commas (,)
- vertical pipes (|)
- double quotes ("")
- tabs
- newlines
- or
- return characters
- must not be numeric
- must not use the same name for different events and states (don’t name your state a
transactionand your event atransaction)
Platforms Supported
- Android
- Custom Feeds
- iOS
- Roku
- tvOS
- Web
The mParticle Unity plugin also supports the Leanplum kit. Navigate to see Leanplum’s documentation for the steps needed for Unity support.
Supported User IDs
- Customer ID
- Email Address
- Push Token
Supported Device IDs
- Android Device ID
- iOS IDFA
- iOS IDFV
- Google Advertising Identifier
- Roku Channel Client ID (Publisher ID)
- Roku Advertiser ID
Supported Data Types
- App Event
- Application State Transition
- Push Message
- Push Registration
- Session End
- Session Start
Tags Supported
- Email Marketing
- Marketing Automation
- Push Notifications
Prerequisites
- In order to enable mParticle’s integration with Leanplum, you will need an account with Leanplum. Once you have logged into your Leanplum account, your App ID and Client Key can be found by clicking App Setting > Keys and Settings.
- If you will be sending development data to Leanplum you will need to uncheck the
Use same settings for Production and Developmentand specify the Production and Development Client Keys respectively.
mParticle Leanplum Implementation Scenarios
Kit Integration
The mParticle SDK allows you to include the Leanplum kit which allows Leanplum interface components (images, layout files, etc.), and as a result, supports the entire Leanplum feature set, which includes:
- Push Notifications, including locally triggered push notifications
- Newsfeed messages
- In-App messages
Add the Kit to Your App
mParticle publishes the Leanplum Kit as separate iOS and Android libraries which have a transitive dependency on the mParticle core libraries. You can add them to your app via Carthage, Cocoapods, or Gradle:
# Sample Podfile
source 'https://github.com/CocoaPods/Specs.git'
target '<Your Target>' do
pod 'mParticle-Leanplum'
end// Sample build.gradle
dependencies {
// Ensure the Kit version matches that of the mParticle Core SDK that you're using
compile 'com.mparticle:android-leanplum-kit:4.16.4'
}See the Apple SDK and Android SDK guides to read more about kits.
The kit will map events instrumented with the mParticle SDK onto Leanplum’s event methods. The source code to each kit is available if you would like to learn exactly how the above mappings occur:
If the Leanplum Kit it is included in your app, all event forwarding will be handled by the kit. No data from your mobile app will be forwarded server-to-server (S2S).
Push Notifications
As long as the Leanplum Kit is included in your app, mParticle will pass any Push Notifications from Leanplum to the kit for display. However, you will need to provide credentials in the Leanplum dashboard.
See the main iOS and Android Push Notification documentation for more detail.
Android
For Android push notifications you will need to provide your Server Key in your project Settings under Push Notifications. See the Leanplum documentation for more.
iOS
For iOS push notifications you will need to upload your APNs Push SSL certificate to Leanplum. See the Leanplum documentation for more information.
Server Integration
The mParticle S2S API allows you to send data server side (API reference). In this scenario, mParticle forwards data via Leanplum’s REST API which supports a limited set of features:
- Updating User information - device and user attributes
- Event tracking
If you have included the Leanplum Kit in your app, no app data will be sent via the Server Integration.
If you are using the server side Leanplum integration:
- Contact your Leanplum account manager to ensure that your Leanplum account is provisioned for Full Service.
- For data from the Android or iOS platforms, mParticle will only forward events to Leanplum if a Device ID is available.
- For data from a feed, mParticle will only forward events to Leanplum if a User ID is present. User ID can be set to Customer ID, email, or mParticle ID in the Connection Settings.
Forwarding Web Data
By default, mParticle forwards web data to Leanplum client-side, by directly invoking Leanplum’s Javascript methods. Optionally, you can choose to forward web data server-to-server in the Connection Settings. Note that if you choose this option, your incoming data must have your selected User ID to be forwarded.
General Parameters
The following general parameters are forwarded to Leanplum:
| Leanplum field | Description |
|---|---|
| appId | The value of App ID in the Configuration Settings. |
| clientKey | The value of Client Key in the Configuration Settings. |
| userId | The User ID selected in the Connection Settings. No data can be forwarded if the selected User ID is not present. |
| deviceId | The Device ID setting controls what value is passed in the deviceId field per platform as follows: iOS - by default the IDFV will be used for Production and IDFA for Development or you can specify to always send IDFA or IDFV. Android - by default the Google Advertising ID will be used and then Android Device ID or you can specify to always send Google Advertising ID or Android ID. |
If available, mParticle will forward the email address as a user attribute with the key of "email". |
Event Data Mapping
The following default mappings exist when forwarding events from mParticle to Leanplum:
| mParticle event/property | Leanplum action | Additional details |
|---|---|---|
| Application State Transition - Background | pauseSession | |
| Application State Transition - Foreground | resumeSession | |
| Custom Events | track | The event name is passed in the event argument and the event attributes are passed in the params argument. |
| Push Registration | setDeviceAttributes | iOS - iosPushToken argument Android - gcmRegistrationId argument |
| Session Start | start | The following additional parameters are forwarded to Leanplum: systemName, systemVersion, deviceName, deviceModel, locale, location, versionName, timezoneOffsetSeconds and country. |
| Session End | stop | |
| User Attributes | setUserAttributes | All user attributes are passed in the userAttributes argument. |
Configuration Settings
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| App ID | string |
The application ID. To find it, select your app in the navigation column, and click Edit Apps. Under Keys, click Show. | |
| Client Key | string |
Either the Production or Development keys, depending on which API call you want to make. |
Connection Settings
| Setting Name | Data Type | Default Value | Platform | Description |
|---|---|---|---|---|
| User ID | string |
customerId | All | Select which user identity to forward to Leanplum as your customer’s user ID. |
| Android Device ID | string |
GAID | Android | Select which value to forward to Leanplum as the Device ID. |
| Apple Device ID | string |
IDFV | iOS/tvOS | Select which value to forward to Leanplum as Device ID. Used for iOS and tvOS. Note that if the chosen deviceId is missing, the application falls back to the DAS. |
| Roku Device ID | string |
RCID (Roku Channel Client ID) | Roku | Select which value to forward to Leanplum as Device ID. Note that if the chosen deviceId is missing, the application falls back to the DAS. |
| Camel Case Property Names | bool |
true |
All | Apply camel casing to event and user attribute property names. |
| Forward Web Requests Server Side | bool |
false |
Web | If enabled, mParticle will not initialize the full Leanplum integration on the web client. Instead, web data will be forwarded to Leanplum via server-to-server API. |
- Last Updated: November 20, 2024