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

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

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

Flutter

Getting Started

Usage

API Reference

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

Xbox

Getting Started

Identity

Roku

Getting Started

Identity

Media

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

Media SDKs

Android

iOS

Web

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

HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

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

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

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

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

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
Observability

Observability Overview

Observability User Guide

Observability Span Glossary

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

Export Results from a Funnel

Explore Users from a Funnel

Cohorts

Getting Started with Cohorts

Analysis Modes

Save a Cohort Analysis

Export Results

Explore Users

Saved Analyses

Manage Analyses in Dashboards

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey Analysis

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

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

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

APIs

User Segments Export API

Dashboard Filter API

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

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Audiences

Audiences Overview

Real-time Audiences

Standard Audiences

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

Journeys 2.0

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

Settings

Debug Console

Data Warehouse Delay Alerting

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)

APIs

Dashboard Filter API (Deprecated)

REST API

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Integrations

Aarki

Audience

ABTasty

Audience

Abakus

Event

24i

Event

Actable

Feed

Adikteev

Event

Audience

Adjust

Event

Feed

AdChemix

Event

AdMedia

Audience

Adobe Marketing Cloud

Cookie Sync

Event

Adobe Campaign Manager

Audience

Adobe Audience Manager

Audience

Adobe Target

Audience

AdPredictive

Feed

Airship

Audience

Event

Feed

AgilOne

Event

Algolia

Event

AlgoLift

Event

Feed

Alooma

Event

Amazon Kinesis

Event

Amazon Advertising

Audience

Amazon Kinesis Firehose

Audience

Event

Amazon Redshift

Data Warehouse

Amazon S3

Event

Amazon SNS

Event

Amazon SQS

Event

Amobee

Audience

Adobe Marketing Cloud

Event

Amplitude

Forwarding Data Subject Requests

Event

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Anodot

Event

AppLovin

Audience

Event

Apptimize

Event

Apptentive

Event

Apteligent

Event

Attentive

Event

Feed

Attractor

Event

Microsoft Azure Blob Storage

Event

Batch

Audience

Event

Bing Ads

Event

Bidease

Audience

Bluecore

Event

Bluedot

Feed

Blueshift

Forwarding Data Subject Requests

Feed

Event

Branch

Event

Forwarding Data Subject Requests

Feed

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Branch S2S Event

Event

Bugsnag

Event

Button

Audience

Event

Cadent

Audience

ciValue

Event

Feed

CleverTap

Event

Audience

Feed

Census

Feed

comScore

Event

Conversant

Event

Cortex

Event

Feed

Forwarding Data Subject Requests

Cordial

Audience

Feed

Criteo

Audience

Event

Crossing Minds

Event

Custom Feed

Custom Feed

CustomerGlu

Event

Feed

Customer.io

Audience

Event

Feed

Databricks

Data Warehouse

Datadog

Event

Dynalyst

Audience

Didomi

Event

Dynamic Yield

Audience

Event

Edge226

Audience

Epsilon

Event

Emarsys

Audience

Everflow

Audience

Facebook

Audience

Event

Fiksu

Audience

Event

Flurry

Event

Facebook Offline Conversions

Event

Flybits

Event

Formation

Event

Feed

ForeSee

Event

Google Analytics for Firebase

Event

Foursquare

Audience

Feed

FreeWheel Data Suite

Audience

Google Ad Manager

Audience

Google Ads

Audience

Event

Google Analytics

Event

Google BigQuery

Audience

Data Warehouse

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Analytics 4

Event

Google Marketing Platform Offline Conversions

Event

Google Pub/Sub

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Tag Manager

Event

Heap

Event

Herow

Feed

Hightouch

Feed

Ibotta

Event

Indicative

Audience

Event

Hyperlocology

Event

Impact

Event

InMobi

Audience

Event

InMarket

Audience

Insider

Audience

Event

Feed

Intercom

Event

Inspectlet

Event

iPost

Feed

Audience

ironSource

Audience

Iterable

Event

Feed

Audience

Jampp

Event

Audience

Kayzen

Event

Audience

Kafka

Event

Kissmetrics

Event

Klaviyo

Audience

Event

Kochava

Feed

Forwarding Data Subject Requests

Event

LaunchDarkly

Feed

Leanplum

Event

Audience

Feed

LifeStreet

Audience

Kubit

Event

Liftoff

Audience

Event

LiveLike

Event

Localytics

Event

Liveramp

Audience

MadHive

Audience

mAdme Technologies

Event

Marigold

Audience

Mailchimp

Event

Feed

Audience

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mixpanel

Event

Forwarding Data Subject Requests

Audience

Moloco

Event

Audience

MoEngage

Event

Audience

Feed

Monetate

Event

Movable Ink - V2

Event

Movable Ink

Event

Multiplied

Event

myTarget

Event

Audience

Nami ML

Feed

Nanigans

Event

Narrative

Audience

Event

Feed

NCR Aloha

Event

Optimizely

Audience

Event

Neura

Event

OneTrust

Event

Oracle Responsys

Audience

Event

Oracle BlueKai

Event

Paytronix

Feed

Persona.ly

Audience

Personify XP

Event

PieEye

Inbound Data Subject Requests

Pinterest

Audience

Event

Plarin

Event

Pilgrim

Event

Feed

Postie

Event

Audience

Primer

Event

Punchh

Audience

Event

Feed

Quadratic Labs

Event

Pushwoosh

Audience

Event

Qualtrics

Event

Quantcast

Event

Reddit

Event

Audience

Radar

Event

Feed

Remerge

Event

Audience

Regal

Event

Retina AI

Event

Feed

Reveal Mobile

Event

RevenueCat

Feed

Rokt

Audience

RTB House

Event

Audience

Salesforce Email

Audience

Event

Feed

Sailthru

Audience

Event

Salesforce Mobile Push

Event

Samba TV

Audience

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

ShareThis

Feed

Audience

Shopify

Custom Pixel

Feed

Signal

Event

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

Snapchat

Audience

Event

SmarterHQ

Event

Snapchat Conversions

Event

Snowflake

Data Warehouse

Snowplow

Event

Split

Event

Feed

Splunk MINT

Event

Sprig

Audience

Event

StartApp

Audience

Statsig

Event

Feed

Stormly

Event

Audience

Swrve

Event

Feed

Tapad

Audience

Talon.One

Audience

Event

Feed

Taplytics

Event

Tapjoy

Audience

Taptica

Audience

Teak

Audience

The Trade Desk

Cookie Sync

Audience

Event

Ticketure

Feed

Treasure Data

Audience

Event

TikTok Event

Audience

Audience (Deprecated)

Event

Audience Migration

Triton Digital

Audience

TUNE

Event

Valid

Event

Vkontakte

Audience

Twitter

Event

Audience

Voucherify

Audience

Event

Vungle

Audience

Webtrends

Event

Webhook

Event

White Label Loyalty

Event

Wootric

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Zendesk

Event

Feed

Antavo

Feed

Event

Localytics provides funnel, attribution, re-targeting, and segmentation solutions. They also provide push and in-app messaging functionality.

Supported Features

  • User Analytics

Enabling Localytics

1. Configure

  1. Add the mParticle SDKs to your iOS and/or Android apps. See the docs for your platform here.
  2. Connect your iOS and/or Android workspaces to Localytics. You will need to provide your Localytics App Key - one for each app that you would like to setup. You can find your Localytics App Key by clicking the Settings tab in the Localytics dashboard.

Alt text.

For more information on setting up a new mParticle connection, see the Platform Guide.

Configuration Settings

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.

Connection Settings

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

2. Add the iOS/Android Kits

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:

  • The mParticle SDK will initialize the Localytics SDK per their documentation, using the Localytics App Key provided above..
  • Push Notifications sent from Localytics will be displayed by the kit (see Push Notifications.

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.

Push Notifications

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.

Android

For Android push notifications you will need to provide your Server Key to Localytics. See the Localytics documentation for more.

iOS

For iOS push notifications you will need to upload your APNs Push SSL certificate to Localytics. See the Localytics documentation for more.

Customer Value Settings

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 Forwarding

Customer Value will be processed based on the enabled state of the “Track CLV as Raw Value” setting:

  • If enabled, mParticle will increment Customer Value (i.e. increase by 1) every time a Goal Event is tracked by mParticle.
  • If not enabled, mParticle will increase LTV by the amount specified in the $Value attribute of any tagged Goal Event, or by the revenue amount of purchase events logged through mParticle.

User Data Mapping

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.

Event Data Mapping

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);

Localytics Custom Flags

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
    Last Updated: December 10, 2024