Developers
API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

Platform API

Key Management

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

Cordova

Cordova Plugin

Identity

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

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

iOS

Workspace Switching

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

Roku

Getting Started

Identity

Media

Flutter

Getting Started

Usage

API Reference

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

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

Alexa

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

mParticle Command Line Interface

Linting Tools

Smartype

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

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

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Java 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

Media SDKs

Android

iOS

Web

API Credential Management

The Developer's Guided Journey to mParticle

Guides
Customer 360

Overview

User Profiles

Overview

User Profiles

Group Identity

Overview

Create and Manage Group Definitions

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Predictive Attributes

What are predictive attributes?

Predict Future Behavior

Create Future Prediction

Use Future Predictions in Campaigns

Assess and Troubleshoot Predictions

Next Best Action

Next Best Action Overview

Create a Next Best Action (NBA)

View and Manage NBAs

Activate Next Best Actions in Campaigns

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
Billing

Usage and Billing Report

The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

Platform Settings

Key Management

Event Forwarding

Notification Center (Early Access)

System Alerts

Trends

Introduction

Data Retention

Data Catalog

Connections

Activity

Data Plans

Live Stream

Filters

Rules

Blocked Data Backfill Guide

Tiered Events

mParticle Users and Roles

Analytics Free Trial

Troubleshooting mParticle

Usage metering for value-based pricing (VBP)

Segmentation
New Audiences Experience

Audiences Overview

Create an Audience

Connect an Audience

Manage Audiences

FAQ

Classic Audiences Experience

Real-time Audiences (Legacy)

Standard Audiences (Legacy)

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

New vs. Classic Experience Comparison

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

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

Analytics

Introduction

Core Analytics (Beta)

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

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

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

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

User Attributes at Event Time

Understanding the Screen View Event

User Aliasing

Dashboards

Dashboards––Getting Started

Manage Dashboards

Dashboard Filters

Organize Dashboards

Scheduled Reports

Favorites

Time and Interval Settings in Dashboards

Query Notes in Dashboards

Analytics Resources

The Demo Environment

Keyboard Shortcuts

User Segments

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

APIs

User Segments Export API

Dashboard Filter API

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

24i

Event

Abakus

Event

ABTasty

Audience

Actable

Feed

Adikteev

Audience

Event

AdChemix

Event

Adjust

Event

Feed

AdMedia

Audience

Adobe Marketing Cloud

Cookie Sync

Platform SDK Events

Server-to-Server Events

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

Adobe Target

Audience

AdPredictive

Feed

AgilOne

Event

Airship

Audience

Event

Feed

AlgoLift

Event

Feed

Alooma

Event

Amazon Advertising

Audience

Amazon Kinesis Firehose

Audience

Event

Amazon Kinesis

Event

Amazon Redshift

Data Warehouse

Amazon S3

Event

Amazon SNS

Event

Amazon SQS

Event

Amobee

Audience

Amplitude

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

Antavo

Feed

Anodot

Event

Algolia

Event

AppLovin

Audience

Event

Apptentive

Event

Apteligent

Event

Apptimize

Event

Attentive

Event

Feed

Attractor

Event

Awin

Event

Microsoft Azure Blob Storage

Event

Bidease

Audience

Batch

Audience

Event

Bing Ads

Event

Blueshift

Feed

Event

Forwarding Data Subject Requests

Bluecore

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Bluedot

Feed

Branch

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Bugsnag

Event

Cadent

Audience

Census

Feed

Button

Audience

Event

ciValue

Event

Feed

CleverTap

Event

Audience

Feed

comScore

Event

Conversant

Event

Cortex

Event

Feed

Forwarding Data Subject Requests

Cordial

Audience

Feed

Crossing Minds

Event

Criteo

Audience

Event

Custom Feed

Custom Feed

CustomerGlu

Event

Feed

Databricks

Data Warehouse

Datadog

Event

Customer.io

Event

Audience

Feed

Didomi

Event

Dynalyst

Audience

Dynamic Yield

Event

Audience

Edge226

Audience

Epsilon

Event

Emarsys

Audience

Everflow

Audience

Facebook

Audience

Event

Facebook Offline Conversions

Event

Flurry

Event

Fiksu

Audience

Event

Google Analytics for Firebase

Event

Flybits

Event

ForeSee

Event

Formation

Event

Feed

Foursquare

Audience

Feed

Friendbuy

Event

FreeWheel Data Suite

Audience

Google Ads

Audience

Event

Google Ad Manager

Audience

Google Analytics

Event

Google Analytics 4

Event

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google BigQuery

Data Warehouse

Audience

Google Marketing Platform Offline Conversions

Event

Google Pub/Sub

Event

Google Tag Manager

Event

Heap

Event

Herow

Feed

Hightouch

Feed

Hyperlocology

Event

Ibotta

Event

ID5

Kit

Impact

Event

InMobi

Audience

Event

Insider

Audience

Event

Feed

InMarket

Audience

Inspectlet

Event

Intercom

Event

iPost

Audience

Feed

ironSource

Audience

Iterable

Audience

Event

Feed

Jampp

Audience

Event

Kafka

Event

Kayzen

Audience

Event

Kissmetrics

Event

Klaviyo

Audience

Event

Kubit

Event

Kochava

Forwarding Data Subject Requests

Event

Feed

LaunchDarkly

Feed

Leanplum

Event

Audience

Feed

LifeStreet

Audience

Liftoff

Event

Audience

LiveLike

Event

LinkedIn

LinkedIn Conversions API Integration

Liveramp

Audience

Localytics

Event

mAdme Technologies

Event

MadHive

Audience

Mailchimp

Audience

Feed

Event

Marigold

Audience

Mediasmart

Audience

Mautic

Audience

Event

Microsoft Azure Event Hubs

Event

MediaMath

Audience

Mintegral

Audience

MoEngage

Audience

Event

Feed

Mixpanel

Audience

Event

Forwarding Data Subject Requests

Monetate

Event

Moloco

Event

Audience

Multiplied

Event

Movable Ink - V2

Event

Movable Ink

Event

myTarget

Audience

Event

Nami ML

Feed

Nanigans

Event

NCR Aloha

Event

Narrative

Audience

Event

Feed

Neura

Event

Optimizely

Audience

Event

OneTrust

Event

Oracle BlueKai

Event

Oracle Responsys

Audience

Event

PieEye

Inbound Data Subject Requests

Paytronix

Feed

Personify XP

Event

Persona.ly

Audience

Pilgrim

Event

Feed

Plarin

Event

Pinterest

Audience

Event

Postie

Audience

Event

Quadratic Labs

Event

Qualtrics

Event

Quantcast

Event

Radar

Event

Feed

Rakuten

Event

Reddit

Audience

Event

Remerge

Audience

Event

Regal

Event

Retina AI

Event

Feed

Reveal Mobile

Event

RevenueCat

Feed

Rokt

Audience

Event

RTB House

Audience

Event

Sailthru

Audience

Event

Salesforce Email

Audience

Event

Feed

Salesforce Mobile Push

Event

Samba TV

Audience

Event

Salesforce Sales and Service Cloud

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

Shopify

Custom Pixel

Feed

Signal

Event

ShareThis

Feed

Audience

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Audience

Event

Snapchat Conversions

Event

Snowplow

Event

Snowflake

Data Warehouse

Split

Event

Feed

Splunk MINT

Event

Sprig

Audience

Event

StartApp

Audience

Statsig

Event

Feed

Stormly

Audience

Event

Swrve

Feed

Event

Talon.One

Audience

Event

Loyalty Feed

Feed

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Teak

Audience

Primer

Event

Ticketure

Feed

Pushwoosh

Audience

Event

Taptica

Audience

TikTok Event

Audience

Event

Audience (Deprecated)

Audience Migration

Treasure Data

Audience

Event

Triton Digital

Audience

TUNE

Event

Twitter

Audience

Event

Valid

Event

Vkontakte

Audience

Vungle

Audience

Voucherify

Audience

Event

Webhook

Event

White Label Loyalty

Event

Webtrends

Event

Wootric

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Event

Audience

Zendesk

Feed

Event

Punchh

Audience

Event

Feed

The Trade Desk

Cookie Sync

Audience

Event

Use Cases for IDSync

mParticle’s IDSync features are designed to address the following common issues with user management.

User continuity

A common scenario for a media or ecommerce app goes something like this:

  1. User downloads an app but has not yet registered an account.
  2. User browses around in the app. Visits screens A, B and C. Data collection begins, but since the user has not yet registered, this activity is stored against an anonymous user profile identified only by an anonymous ID (such as a device ID).
  3. User decides to register for an account, creating a new logged-in user profile, and continues to use the app while signed in. Visits screens D and E, and buys product F.

How should the data from this interaction be organized? There are two basic approaches:

  • Link the new logged-in user profile with the original anonymous one. This approach yields a continuous view of the user journey.
  • At the moment of user registration, create a new user profile and keep the post-signup activity completely separate from the pre-signup activity.

There are compelling business and legal arguments for and against each approach. By choosing the first approach, you have a chance to preserve a complete history of a user’s experience with your app. This might be invaluable for improving your funnel. However, you also introduce the possibility of mingling data from several users into a single profile. For example, on a shared device, multiple users might access the app in a pre-signup state.

The second approach sacrifices the possibility of collecting a user’s entire history under a single continuous view. However, you can be sure that the data from your logged-in users is never mixed up with data from a different user. Quarantining anonymous data from known user data may also be required by law.

IDSync is designed to let you make smart decisions about user continuity that fit the needs of your app and to give you transparency into how user profiles are created and updated.

Cross-device tracking

Users often interact with an app ecosystem through more than one device. For example, users might interact with an eCommerce app through both a native app and a web browser, or view media content on a web browser, a native app, or a Roku channel.

Many apps will want to track events and lifetime value for a user across all platforms, but others will prefer to keep data for each platform separate. IDSync allows mParticle to support both use cases, and to harness 3rd party data to decisively link data generated from your apps with data from other sources, like CRM Feeds.

Cross-app tracking

Your product ecosystem may be spread not just across multiple platforms, but also multiple apps. Needs for tracking users across multiple apps will vary depending on your business model. For example, a gaming organization might publish dozens of individual games and want to track their user’s LTV across all their apps. By creating workspaces for each app group under the same mParticle account, you can allow them to share a pool of users, and create only one profile per known user, no matter how many of your apps they use.

Alternatively, you might wish to define different groups of users for different apps within the same ecosystem. For example, you might have one app for vendors and another for buyers, with a completely different set of metrics for each group. IDSync allows mParticle to support either use case.

Customer experience personalization

Personalization of customer experience (CX) is a top priority for marketers. Personalization reduces friction and increases conversions by presenting relevant in-context content that increases customer awareness, engagement, and satisfaction. The Immutable Identity Setting enables marketers to use the mParticle Profile API to get the most up-to-date real-time user identities, device identities, user attributes, and audience memberships. The Profile API uses either an identifier with Immutable Identity set or the mParticle Identifier to match a user profile. Additionally, IDSync Search allows marketers to query User Profiles by any known identifier, such as email, mobile phone, or device identity, and return all matched user identity values including the mParticle ID. The mParticle ID can then be used with Profile API to get the values necessary to personalize the customer experience.

Privacy compliance

The ability to provide evidence that demonstrates that your organization is in regulatory compliance is important to every Chief Privacy Officer and corporate information security executive. GDPR and CCPA data privacy controls and traceability are core to mParticle’s user profile data policies. In addition, the IDSync Search capability can verify that a matching User Profile exists. It can also be used after a GDPR or CCPA User Profile Delete Request has been processed, to validate that the process has completed successfully and thereby validate compliance.

Mutable identities

Different user identifiers have different lifespans and degrees of specificity. A Customer ID or a social media ID permanently identify a single user, while an IP Address or Session ID may not be sufficient to identify a single user and can change at any time. Other identifiers fall somewhere in between. Email addresses, for example, do identify a single user, but a user may change their email address over time. IDSync gives you the tools to update identifiers for a User Profile without losing that user’s history.

Identity translation

With mParticle managing all available identities for a user, you’re freed up to focus on your data. One messaging service requires an email address while another needs Push Tokens? Don’t worry about it. Build your messaging audiences in mParticle based on any criteria you need and mParticle will forward the correct identities for each service, as long as they are available.

Was this page helpful?

    Last Updated: June 26, 2025