Documentation

Developers

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

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

Flutter

Getting Started

Usage

API Reference

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

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

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

Java 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

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

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

mParticle Command Line Interface

Smartype

Linting Tools

Media SDKs

Android

iOS

Web

Guides

Partners

Introduction

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

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

The New mParticle Experience

The new mParticle Experience

The Overview Map

Billing

Usage and Billing Report

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

Event Forwarding

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

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

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

Android SDK Changelog

v5.63.0 (2025-05-12)

5.63.0 (2025-05-12)

Features

Add user attributes mapping logic in Rokt execute flow (#574) (37666be)
Added Callback Support (#569) (9976373)

Updates & Maintenance

Update submodules (4470ad1)
- Braze kit feat: Update Braze to v35.0.0
- Rokt kit feat: Add callback support

View on GitHub

v5.62.2 (2025-04-23)

5.62.2 (2025-04-23)

Updates & Maintenance

Update submodules (d2cebb2)
- Braze kit feat: Add support to forward SubscriptionGroupIds

View on GitHub

v5.62.1 (2025-04-23)

5.62.1 (2025-04-23)

Bug Fixes

Rename disabled kit method name (#573) (86f1558)

View on GitHub

v5.62.0 (2025-04-18)

5.62.0 (2025-04-18)

Features

Add option to disable kits in MParticleOptions (#570) (d7e4154)

Bug Fixes

Add ProGuard rule to preserve method visibility (#571) (f01e404)

Updates & Maintenance

Add Test Kits step to GitHub workflow (#568) (9415ded)

View on GitHub

v5.61.2 (2025-04-14)

5.61.2 (2025-04-14)

Bug Fixes

Add a rule to make sure RoktEmbeddedView and related classes are not removed in release builds (#566) (1a78039)
Align Kotlin files with correct package structure (#565) (9b4bd7b)
Rokt Submodule link (#564) (e06bf8a)

Updates & Maintenance

add rokt-kit as a new submodule (b897439)
Update submodules (735fc1f)

View on GitHub

v5.61.1 (2025-04-11)

5.61.1 (2025-04-11)

Updates & Maintenance

Update submodules (f75499b)
- feat: Map commerce position attribute to GA4 index attribute(Google Analytics for Firebase - GA4).
- feat: Update to Partner latest version 19.3.0 (Urban Airship)

View on GitHub

v5.61.0 (2025-04-11)

5.61.0 (2025-04-11)

Features

Add support for Rokt first-party kit (#550) (8229921)

Bug Fixes

changed rokt widget namespace (#558) (5910509)

Updates & Maintenance

Add rokt submodule (#557) (6a4cfda)

View on GitHub

v5.60.0 (2025-04-07)

5.60.0 (2025-04-07)

Features

Remove the existing code and added new method ‘getUserAudience’ (#542) (cf8328a)

Updates & Maintenance

Update submodules (3274ce7)

View on GitHub

v5.59.0 (2025-04-03)

5.59.0 (2025-04-03)

Features

Add Workspace Switching feature (#551) (de72f0a)

Updates & Maintenance

Downgrade API level to 28 for both instrument test and instrument… (#552) (ddf8f4f)
Downgrade API level to 28 for daily yml file (#553) (12eef85)

View on GitHub

v5.58.12 (2025-03-18)

5.58.12 (2025-03-18)

Updates & Maintenance

Update submodules (01c5f37)

View on GitHub

v5.58.11 (2025-03-05)

5.58.11 (2025-03-05)

Bug Fixes

Update Kotlin version to be compatible with Braze (#547) (50d73b3)

Kit Version Updates

Update submodules (b9ccc6c)

Braze kit has been updated to 34.0.0
CleverTap has been updated to 7.2.2
Iterable Kit has been updated to 3.5.10

View on GitHub

v5.58.10 (2025-02-27)

5.58.10 (2025-02-27)

Bug Fixes

Previous Google ad Id from being null on cold launch (#546) (3051a82)

Updates & Maintenance

Migrate Internal Application context class to kotlin (#545) (ecd2833)
Update submodules (e9cb498)

View on GitHub

v5.58.9 (2025-02-13)

5.58.9 (2025-02-13)

Updates & Maintenance

Update submodules (9686aed)
- Update Appsflyer Kit to latest version 6.16.0

View on GitHub

v5.58.8 (2025-02-13)

5.58.8 (2025-02-13)

Updates & Maintenance

Migrate Internal CoreCallback class to kotlin (#543) (c9c8cfb)
Remove Pilgrim-kit from cross-platform testing (#544) (08401bc)
Update submodules (2386eba)

View on GitHub

v5.58.7 (2025-02-07)

5.58.7 (2025-02-07)

Bug Fixes

Disable location tracking to stop setting location updates (#540) (8f68edb)

Updates & Maintenance

Update submodules (a9ca8d9)

View on GitHub

v5.58.6 (2025-01-30)

5.58.6 (2025-01-30)

Updates & Maintenance

Migrate Internal OS Helper class to kotlin (#515) (#536) (6ce2e7d)
Migrate Internal user storage class to kotlin (#516) (#539) (fab4925)

View on GitHub

v5.58.5 (2025-01-24)

5.58.5 (2025-01-24)

Updates & Maintenance

Add issue autorespond and close workflow (#526) (28ccb97)
Update cross-platform-tests.yml (#530) (0924e88)
Update emulator version tag (#537) (4f2fea6)
Update submodules (ab53cb1)
- Google Analytics 4 (GA4) * feat: forward product custom attributes

View on GitHub

v5.58.4 (2024-12-12)

5.58.4 (2024-12-12)

Updates & Maintenance

Fix release action trying to push to old internal repo (09101f2)
Update submodules (36a6396)
- Apptentive Kit * Android34 support
- Braze KIt * Send ProductName to Braze

View on GitHub

v5.58.3 (2024-10-24)

5.58.3 (2024-10-24)

Updates & Maintenance

Migrate Internal Constants class to kotlin (#510) (2fd32f6)
Migrate MPLifecycleCallbackDelegate and MPLocationListener class to Kotlin (#506) (687e623)
Remove unused session history upload code (#507) (a86cd3b)
Update submodules (81e50ca)
- Update Clevertap kit to version 7.0.2

View on GitHub

v5.58.2 (2024-09-11)

5.58.2 (2024-09-11)

Updates & Maintenance

Update submodules (ae9f719)
- Update Braze Kit to latest version 32.1.0
- Support Google EU Consent to Braze Kit

View on GitHub

v5.58.1 (2024-08-29)

5.58.1 (2024-08-29)

Updates & Maintenance

Update submodules (3d79f75)
- Update Adjust Kit to latest version 5.0.0

View on GitHub

v5.58.0 (2024-08-21)

IMPORTANT NOTICE

If you are using custom domains with mParticle and are currently passing SSL certificates in your domain mappings in NetworkOptions, please validate that you are still receiving events after updating to this version.

5.58.0 (2024-08-21)

Features

Certificate pinning update (#504) (85b38cd)

Updates & Maintenance

Update submodules (2c359eb)

View on GitHub

v5.57.0 (2024-08-13)

5.57.0 (2024-08-13)

Features

Support direct URL routing (#499) (d7aa30c)

Bug Fixes

Crash in KitConfiguration due to NumberFormatException (#503) (e1a23e7)

View on GitHub

v5.56.5 (2024-08-06)

5.56.5 (2024-08-06)

Bug Fixes

Remove Code for Handling Google AdId on a Separate Thread (#502) (17928b9)

View on GitHub

v5.56.4 (2024-07-31)

5.56.4 (2024-07-31)

Updates & Maintenance

Update submodules (8c59ab1)
- Update Urbanairship kit to version 18.1.3 (latest version)
- Replace deprecated method ‘isDataCollectionEnabled’ with setEnabledFeatures
- Replace ‘addEvent’ method with recordCustomEvent due to restricted access in the latest version.
- Updated ‘requestRegistrationUpdate’ method to match new signature;now passing MParticlePushProvider instance and token

View on GitHub