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
Custom Access Roles API
Data Planning 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
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
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
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
Data Hosting Locations
Glossary
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
Export Results from a Funnel
Explore Users from a Funnel
Saved Analyses
Manage Analyses in Dashboards
Dashboards––Getting Started
Manage Dashboards
Organize Dashboards
Dashboard Filters
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
Audience
Audience
Event
Event
Feed
Event
Audience
Cookie Sync
Event
Audience
Audience
Audience
Feed
Event
Event
Event
Event
Audience
Data Warehouse
Event
Event
Event
Audience
Event
Event
Event
Event
Event
Event
Event
Event
Audience
Event
Feed
Event
Event
Audience
Feed
Event
Event
Event
Custom Feed
Data Warehouse
Event
Audience
Event
Audience
Event
Audience
Audience
Event
Event
Event
Event
Event
Audience
Audience
Event
Audience
Data Warehouse
Event
Event
Event
Event
Audience
Cookie Sync
Event
Event
Event
Feed
Feed
Event
Event
Event
Audience
Event
Event
Audience
Event
Event
Feed
Audience
Event
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
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Audience
Audience
Event
Audience
Audience
Audience
Cookie Sync
Audience
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Event
Event
Event
Audience
Cookie Sync
Audience
Cookie Sync
Feed
Audience
Feed
Localytics provides funnel, attribution, re-targeting, and segmentation solutions. They also provide push and in-app messaging functionality.
.
For more information on setting up a new mParticle connection, see the Platform Guide.
Setting Name | Data Type | Default Value | Description |
---|---|---|---|
App Key | string |
Your app’s Localytics App Key. | |
Track CLV as Raw Value | bool |
False | Disable this if you are tracking customer value as revenue; enabled it otherwise. A value of true corresponds to ‘tracked as money’; false corresponds to ‘raw value’ under the ‘Customer Value’ setting for your app in Localytics. |
Setting Name | Data Type | Default Value | Platform | Description |
---|---|---|---|---|
App Version | string |
Web | Your app’s version number | |
Session Timeout | int |
1800 | Web | Time in seconds until Localytics marks the session as closed. |
Domain | string |
Web | Changes the domain used for cookies. Use this to track users across subdomains. | |
Track Page Views | bool |
False | Web | Automatically track page view events. |
Custom Dimensions | Custom Field |
All | If you use Custom Dimensions in Localytics, you can use “Custom Dimension 0-9” to specify which mParticle user attributes should be forwarded to Localytics as Custom Dimensions | |
Profile Attributes (Organization) | <string> List |
iOS, Android | Enter the list of user attributes that will be forwarded to Localytics scoped at the organization level | |
Profile Attributes (Application) | <string> List |
iOS, Android | Enter the list of user attributes that will be forwarded to Localytics scoped at the application level |
mParticle’s Localytics integration requires that you add the Localytics Kit to your iOS or Android app. This kit-only integration solely supports client-side data forwarding.
Just by adding the binary to your app:
mParticle publishes the Localytics 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-Localytics'
end
// Sample build.gradle
dependencies {
// Ensure the Kit version matches that of the mParticle Core SDK that you're using
compile 'com.mparticle:android-localytics-kit:4.16.6'
}
Reference the Apple SDK and Android SDK guides to read more about kits.
As long as the Localytics Kit is included in your app, mParticle will pass any Push Notifications from Localytics to the kit for display. However, you will need to provide credentials in the Localytics dashboard.
See the main iOS and Android Push Notification documentation for more detail.
For Android push notifications you will need to provide your Server Key to Localytics. See the Localytics documentation for more.
For iOS push notifications you will need to upload your APNs Push SSL certificate to Localytics. See the Localytics documentation for more.
Localytics has an app-level setting called “Customer Value”, which controls whether customer value should be tracked as a monetary value, or as a “Raw Value”, i.e. as a count of the number of high-value in-app actions taken by your app users.
mParticle’s integration with Localytics relies on the “Track CLV as Raw Value” setting to correctly pass Customer Value information into your Localytics account. As such, it’s important for you to be aware of the value of this setting for each of your apps in Localytics during the activation process.
Additionally, if you’re planning to track Customer Value as a Raw Value in Localytics, you’ll want to make sure that all of your high-value events have been tagged as Goal Events. For more information on how to tag Goal Events, please review Measuring Transactions and lifetime value.
You can find your Localytics Customer Value by clicking the Settings tab in the Localytics dashboard.
Customer Value will be processed based on the enabled state of the “Track CLV as Raw Value” setting:
mParticle will forward user identity information to Localytics as described below:
mParticle User Information | Localytics method |
---|---|
UserIdentity.CustomerId | setCustomerId |
UserIdentity.Email | setCustomerEmail |
$FirstName |
setCustomerFirstName (only for iOS/Android) |
$LastName |
setCustomerLastName (only for iOS/Android) |
$FirstName + $LastName |
setCustomerName |
Additional identify types | setIdentifier |
User attributes which match a Custom Dimension |
setCustomDimension |
Additional attributes not matching a Custom Dimension |
setProfileAttribute |
mParticle will forward Customer IDs as follows: using the Customer ID User Identity, if available, and then the Other User Identity if available.
Localytics Special Profile IDs $first_name, $last_name, $full_name and $email are automatically set as Organization Profile Attributes.
mParticle forwards events to Localytics as follows:
mParticle Event | Localytics SDK Method | Description |
---|---|---|
App events | tagEvent | The mParticle EventName is forwarded as the Localytics eventName |
eCommerce events | tagEvent | “eCommerce - Product Action ” is forwarded as the Localytics eventName |
Opt Out events | setOptedOut | The current optout status is forwarded |
Push Registration events | setPushRegistrationId | |
Screen Views | tagScreen | All screen views tracked by the mParticle SDK, either via automatic screen tracking in the Android SDK, or manually via the logScreen SDK method are forwarded passing the screenName. For Web, multiple screen names may be included. |
Please see the panel below for sample method calls using Localytics SDK, and the equivalent using mParticle’s SDK.
//Event attribute dictionary (used by both SDK method calls)
NSDictionary *choicesDictionary = @{@"spice":@"hot",
@"menu":@"weekdays"};
//Localytics event-tracking SDK method call
[[LocalyticsSession shared] tagEvent:@"Food Order"
attributes:choicesDictionary];
//Equivalent call using mParticle's SDK
[[MParticle sharedInstance] logEvent:@"Food Order"
eventType:MPEventTypeTransaction
eventInfo:choicesDictionary];
//Event attribute dictionary (used by both SDK method calls)
Map<String, String> eventInfo = new HashMap<String, String>();
eventInfo.put("spice", "hot");
eventInfo.put("menu", "weekdays");
//Localytics event-tracking SDK method call
localyticsSession.tagEvent("Food Order", eventInfo);
//Equivalent call using mParticle's SDK
MParticle.getInstance().logEvent("Food Order", MParticle.EventType.Transaction, eventInfo);
You can add Custom Flags to your events for Web, which will be mapped to Localytics as described below.
mParticle Custom Flag | Description |
---|---|
"Localytics.ScreenName" |
Allows you to pass a custom screen name to the Localytics tagScreen method |