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

Group Identity API Reference

Data Planning API

Pixel Service

Profile API

Events API

mParticle JSON Schema Reference

IDSync

Client SDKs
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

Workspace Switching

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

AMP

AMP SDK

Cordova

Cordova Plugin

Identity

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Flutter

Getting Started

Usage

API Reference

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

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

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

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

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

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

API Credential Management

The Developer's Guided Journey to mParticle

Guides

Composable Audiences (Early Access)

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

Platform Settings

Key Management

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

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)

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

Segmentation
Audiences

Audiences Overview

Create an Audience

Connect an Audience

Manage Audiences

FAQ

Classic Audiences

Standard Audiences (Legacy)

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

New vs. Classic Experience Comparison

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

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

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

Warehouse Sync User Guide

Historical Data and 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
24i

Event

Aarki

Audience

Abakus

Event

Actable

Feed

ABTasty

Audience

AdChemix

Event

Adjust

Event

Feed

Adikteev

Event

Audience

AdMedia

Audience

Adobe Campaign Manager

Audience

Adobe Marketing Cloud

Cookie Sync

Server-to-Server Events

Platform SDK Events

Adobe Audience Manager

Audience

AdPredictive

Feed

AgilOne

Event

Airship

Feed

Audience

Event

Adobe Target

Audience

Algolia

Event

AlgoLift

Event

Feed

Alooma

Event

Amazon Advertising

Audience

Amazon Kinesis

Event

Amazon S3

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Redshift

Data Warehouse

Amobee

Audience

Amazon SNS

Event

Amazon SQS

Event

Amplitude

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

AppsFlyer

Event

Forwarding Data Subject Requests

Feed

Anodot

Event

AppLovin

Audience

Event

Apptimize

Event

Apptentive

Event

Attractor

Event

Attentive

Event

Feed

Awin

Event

Apteligent

Event

Batch

Audience

Event

Bidease

Audience

Microsoft Azure Blob Storage

Event

Bluecore

Event

Bing Ads

Event

Blueshift

Event

Forwarding Data Subject Requests

Feed

Bluedot

Feed

Branch

Event

Forwarding Data Subject Requests

Feed

Branch S2S Event

Event

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Bugsnag

Event

Button

Event

Audience

Cadent

Audience

Census

Feed

ciValue

Event

Feed

CleverTap

Event

Audience

Feed

comScore

Event

Cordial

Audience

Feed

Conversant

Event

Criteo

Event

Audience

Cortex

Event

Feed

Forwarding Data Subject Requests

Custom Feed

Custom Feed

Crossing Minds

Event

CustomerGlu

Feed

Event

Customer.io

Audience

Event

Feed

Databricks

Data Warehouse

Datadog

Event

Didomi

Event

Dynalyst

Audience

Dynamic Yield

Audience

Event

Edge226

Audience

Epsilon

Event

Emarsys

Audience

Everflow

Audience

Facebook

Audience

Event

Facebook Offline Conversions

Event

Fiksu

Audience

Event

Google Analytics for Firebase

Event

Flurry

Event

Flybits

Event

ForeSee

Event

Formation

Event

Feed

Foursquare

Audience

Feed

FreeWheel Data Suite

Audience

Friendbuy

Event

Antavo

Feed

Google Ads

Event

Audience

Google Analytics

Event

Google Ad Manager

Audience

Google BigQuery

Audience

Data Warehouse

Google Analytics 4

Event

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Marketing Platform Offline Conversions

Event

Google Pub/Sub

Event

Google Tag Manager

Event

Heap

Event

Hightouch

Feed

Herow

Feed

Hyperlocology

Event

Impact

Event

Ibotta

Event

ID5

Kit

InMarket

Audience

InMobi

Event

Audience

Inspectlet

Event

Insider

Audience

Event

Feed

Intercom

Event

iPost

Feed

Audience

ironSource

Audience

Iterable

Audience

Event

Feed

Jampp

Event

Audience

Kafka

Event

Kissmetrics

Event

Kayzen

Event

Audience

Klaviyo

Audience

Event

Kochava

Event

Feed

Forwarding Data Subject Requests

LaunchDarkly

Feed

Kubit

Event

LifeStreet

Audience

Leanplum

Event

Audience

Feed

Liftoff

Audience

Event

LiveLike

Event

LinkedIn

LinkedIn Conversions API Integration

Liveramp

Audience

Localytics

Event

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Audience

Event

Feed

Marigold

Audience

Mautic

Audience

Event

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mintegral

Audience

MediaMath

Audience

MoEngage

Audience

Event

Feed

Mixpanel

Audience

Event

Forwarding Data Subject Requests

Monetate

Event

Moloco

Audience

Event

Movable Ink

Event

Multiplied

Event

Movable Ink - V2

Event

myTarget

Audience

Event

Nami ML

Feed

Nanigans

Event

Narrative

Audience

Event

Feed

NCR Aloha

Event

Neura

Event

Oracle BlueKai

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle Responsys

Audience

Event

Persona.ly

Audience

Paytronix

Feed

Personify XP

Event

Pilgrim

Feed

Event

PieEye

Inbound Data Subject Requests

Pinterest

Audience

Event

Plarin

Event

Punchh

Audience

Event

Feed

Pushwoosh

Audience

Event

Primer

Event

Quadratic Labs

Event

Qualtrics

Event

Radar

Event

Feed

Rakuten

Event

Quantcast

Event

Reddit

Audience

Event

Regal

Event

Retina AI

Event

Feed

Remerge

Audience

Event

Reveal Mobile

Event

RTB House

Audience

Event

Rokt

Audience

Event

Rokt Thanks and Pay+

RevenueCat

Feed

Sailthru

Event

Audience

Salesforce Email

Feed

Audience

Event

Salesforce Mobile Push

Event

Salesforce Sales and Service Cloud

Event

Samba TV

Event

Audience

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

ShareThis

Audience

Feed

Signal

Event

Shopify

Custom Pixel

Feed

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Slack

Event

Skyhook

Event

Smadex

Audience

SmarterHQ

Event

Snapchat Conversions

Event

Snapchat

Event

Audience

Snowflake

Data Warehouse

Snowplow

Event

Splunk MINT

Event

Sprig

Event

Audience

StartApp

Audience

Statsig

Event

Feed

Stormly

Audience

Event

Swrve

Event

Feed

Talon.One

Event

Audience

Feed

Loyalty Feed

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Taptica

Audience

Teak

Audience

The Trade Desk

Audience

Cookie Sync

Event

Ticketure

Feed

TikTok Event

Event

Audience

Audience (Deprecated)

Audience Migration

Treasure Data

Audience

Event

Triton Digital

Audience

TUNE

Event

Valid

Event

Twitter

Audience

Event

Voucherify

Audience

Event

Vkontakte

Audience

Vungle

Audience

Postie

Audience

Event

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Wootric

Event

Xandr

Cookie Sync

Audience

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

Z2A Digital

Audience

Event

YouAppi

Audience

Split

Event

Feed

Zendesk

Event

Feed

User Aliasing

Analytics supports several aliasing use cases. This topic describes the use cases and provides best practices for managing user aliasing.

Use Cases

Identity Reconciliation

Users interact with digital environments in many different ways. When a new user accesses your website or app, they are unknown, so a unique Anonymous ID is assigned to track their online behavior. Users may remain anonymous for the duration of their visit or they might create an account, log in, or otherwise share identifiable information. Once the user becomes known, it’s important to reconcile the known identity with any previously anonymous user identities, and to combine the activity timelines of each ID. This creates a unified user activity timeline and enables a complete analysis of the full customer journey. Without user reconciliation, an individual user may be assigned multiple user IDs, which can cause duplication of user counts and fragmentation of user activity in your data. The process of reconciling known and unknown user identities is called aliasing. Aliasing is also known as identity reconciliation, stitching, or merging. 

Cross-Device Identification

Users can access your website or app from a variety of devices and locations. Maybe a user creates a profile on your website using their laptop, then downloads your app onto their smartphone and also onto their tablet. Maybe they log in on a friend’s phone to place an order. In addition to reconciling known and unknown user identities, aliasing combines the activity timelines of each device, platform, and geographic location. This again creates a unified activity timeline to provide a complete analysis of the full customer journey.

Cross-Domain Tracking

Aliasing can also help with cross-domain tracking. To achieve this, pass the Anonymous ID from the second domain as an aliasing parameter. Then contact your Customer Success Manager for more information on how to enable cross-domain tracking with aliasing.

How Does Aliasing Work?

Depending on your integration type, aliasing is achieved in different ways. For example, if you send events to Analytics in real-time by using Segment, Amazon Kinesis, or via the Analytics API, the process is different than if you send events to Analytics daily through a data warehouse integration. The following documentation describes our process for aliasing user identities in real-time integrations.

An aliasing API call consists of three components: 

  1. Anonymous ID: The anonymous ID is an ID used to identify a user before they register, log in, or otherwise identify themselves.
  2. User ID: The user ID is the ID used to uniquely identify a user in your database. This should be an immutable field that is recorded in the user table. As mentioned, the user ID is created and assigned whenever a user makes themselves known. 
  3. API Key: The project API Key is used to direct the alias call toward which Analytics project.

After receiving an aliasing call, Analytics reconciles the anonymous ID and the user ID, and handles all incoming events from both IDs as the same user. In short, they’re “stitched” together. Multiple anonymous IDs may be aliased to a single user ID, however you may not alias multiple user IDs to a single anonymous ID, nor may you alias a user ID to another user ID. Alias calls are processed once per day, so please allow up to 24 hours for best results.

JavaScript (SDK) Alias Calls

Indicative.sendAlias()

The Analytics client automatically generates a universally unique identifier (UUID) to apply to all events until “Indicative.setUniqueID(id)” is called. “Indicative.sendAlias()” can be called to alias the UUID to the ID parameter defined within “Indicative.setUniqueID(id)”

Indicative.setUniqueID(id, true)

After setting the new unique ID, then this will automatically call “Indicative.sendAlias()”. If you perform “callIndicative.setUniqueID(id)” without ‘true’, then the alias call will not be sent.

Best Practices

It is recommended that an alias call be made once, at the first instance of the user identifying themselves, such as upon registration or profile creation. We also recommend caution, as improper use of aliasing can cause unforeseen issues with data accuracy. To mitigate this risk, Analytics enforces the following strict aliasing rules:

Rule
Anonymous ID and User ID must be different
Anonymous ID may be aliased to only one User ID
Multiple Anonymous IDs may be aliased to one User ID
Anonymous ID may not be aliased to another Anonymous ID
User ID may not be aliased to another User ID
If an ID has already been defined as a User ID, then it cannot be reclassified as a Anonymous ID
You may not “chain” alias calls (i.e. Anonymous ID > User ID1 > User ID2)
Alias calls only impact future data received. 
Aliasing is stateful, which means we build an accumulated view of your aliasing calls over time.

Event Aliasing from mParticle

When user profiles and events are sent from the mParticle CDP to Analytics, Analytics will inherit all aliasing functionality that was performed using IDSync. This means that Analytics automatically has access to the same unified view of user profiles and events established within mParticle. 

Retroactive aliasing

For customers on the Enterprise plan, alias calls can be performed retroactively to combine two activity timelines that have already been processed. Retroactive aliasing is useful when events performed anonymously before an aliasing API call is received need to be reconciled with a known user profile. Retroactive aliasing takes place once every 24 hours.

For example, consider the events below, all performed by the same customer:

  • Event 1: Customer views a registration page, establishing user_id A
  • Event 2: user_id A submits registration
  • Event 3: Customer successfully registers while using a different device, establishing user_id B
  • Aliasing API call is made, establishing that user_id A is user_id B
  • Event 4: user_id B views an ad
  • Event 5: user_id A views a login screen
  • Event 6: user_id B logs in successfully

In this sequence, only event 3 would need to be retroactively reconciled with the known user ID, while events 1, 2, 4, 5, and 6 would be immediately associated with the unified profile following the aliasing API call. Once daily retroactive aliasing is complete, the event in step 3 becomes associated with the same user profile as the rest of the events.

This diagram further illustrates retroactive aliasing:

retroactive-aliasing-diagram

Custom Aliasing

Custom aliasing rules may be supported for Enterprise customers only. This can be requested by contacting Support or your Customer Success Manager.

Third Party Aliasing

Aliasing calls from a third party are not supported. Analytics rejects these calls because they are considered “chained” alias calls (i.e. Anonymous ID > Third Party User ID > Indicative User ID). If you are concerned that your method of integration is causing aliasing issues, please contact Support or your Customer Success Manager.

Aliasing with GDPR

Under GDPR privacy regulations, users have the option to opt into or out of session tracking. If a user does not consent to tracking, then all personally identifiable information (PII) must not be collected and existing PII must be deleted. The only data that is tracked by the Analytics client is the Anonymous ID, a random string ID used to unify a single user session. This ID does not persist across multiple user sessions. It is not possible to alias the IDs of users who opt out of session tracking.

Was this page helpful?

    Last Updated: August 14, 2025