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

Flutter

Getting Started

Usage

API Reference

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

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

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Xamarin

Getting Started

Identity

Alexa

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

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

Python 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

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

Linting Tools

Smartype

mParticle Command Line Interface

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

Media SDKs

Android

Web

iOS

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

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

The New mParticle Experience

The new mParticle Experience

The Overview Map

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

Usage metering for value-based pricing (VBP)

Troubleshooting mParticle

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

Event

Aarki

Audience

Abakus

Event

ABTasty

Audience

Actable

Feed

AdChemix

Event

Adikteev

Audience

Event

AdMedia

Audience

Adjust

Event

Feed

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

Algolia

Event

AlgoLift

Event

Feed

Alooma

Event

Amazon Advertising

Audience

Amazon Kinesis

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Redshift

Data Warehouse

Amazon S3

Event

Amazon SQS

Event

Amazon SNS

Event

Amobee

Audience

Amplitude

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

Antavo

Feed

Anodot

Event

AppLovin

Audience

Event

Apptimize

Event

Apteligent

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Attentive

Feed

Event

Attractor

Event

Microsoft Azure Blob Storage

Event

Awin

Event

Apptentive

Event

Bidease

Audience

Bing Ads

Event

Bluecore

Event

Batch

Audience

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Bugsnag

Event

Button

Audience

Event

Cadent

Audience

ciValue

Event

Feed

Census

Feed

comScore

Event

CleverTap

Audience

Event

Feed

Conversant

Event

Cordial

Audience

Feed

Cortex

Event

Feed

Forwarding Data Subject Requests

Criteo

Audience

Event

Custom Feed

Custom Feed

CustomerGlu

Event

Feed

Crossing Minds

Event

Databricks

Data Warehouse

Customer.io

Audience

Feed

Event

Datadog

Event

Didomi

Event

Dynamic Yield

Event

Audience

Dynalyst

Audience

Emarsys

Audience

Edge226

Audience

Epsilon

Event

Everflow

Audience

Facebook

Audience

Event

Facebook Offline Conversions

Event

Fiksu

Event

Audience

Google Analytics for Firebase

Event

Flurry

Event

Flybits

Event

Formation

Event

Feed

Foursquare

Feed

Audience

ForeSee

Event

FreeWheel Data Suite

Audience

Friendbuy

Event

Google Ad Manager

Audience

Google Ads

Audience

Event

Google Analytics 4

Event

Google Analytics

Event

Google BigQuery

Audience

Data Warehouse

Google Enhanced Conversions

Event

Google Cloud Storage

Audience

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Pub/Sub

Event

Google Tag Manager

Event

Heap

Event

Google Marketing Platform Offline Conversions

Event

Hightouch

Feed

Herow

Feed

Hyperlocology

Event

Ibotta

Event

ID5

Kit

Impact

Event

InMarket

Audience

Insider

Audience

Event

Feed

Inspectlet

Event

Intercom

Event

InMobi

Audience

Event

iPost

Feed

Audience

ironSource

Audience

Jampp

Event

Audience

Iterable

Event

Audience

Feed

Kayzen

Audience

Event

Kissmetrics

Event

Kafka

Event

Klaviyo

Event

Audience

Kochava

Feed

Event

Forwarding Data Subject Requests

Kubit

Event

Leanplum

Audience

Event

Feed

LifeStreet

Audience

LaunchDarkly

Feed

LinkedIn

LinkedIn Conversions API Integration

Liftoff

Event

Audience

LiveLike

Event

Liveramp

Audience

Localytics

Event

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Audience

Event

Feed

Marigold

Audience

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mixpanel

Audience

Event

Forwarding Data Subject Requests

Moloco

Audience

Event

MoEngage

Audience

Event

Feed

Monetate

Event

Movable Ink

Event

Movable Ink - V2

Event

Multiplied

Event

myTarget

Audience

Event

Nanigans

Event

Nami ML

Feed

Narrative

Audience

Event

Feed

NCR Aloha

Event

Neura

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle BlueKai

Event

Paytronix

Feed

Oracle Responsys

Audience

Event

PieEye

Inbound Data Subject Requests

Personify XP

Event

Persona.ly

Audience

Pilgrim

Event

Feed

Pinterest

Audience

Event

Plarin

Event

Postie

Event

Audience

Quadratic Labs

Event

Primer

Event

Qualtrics

Event

Quantcast

Event

Radar

Event

Feed

Rakuten

Event

Regal

Event

Reddit

Audience

Event

Remerge

Audience

Event

Retina AI

Feed

Event

Reveal Mobile

Event

RevenueCat

Feed

Rokt

Audience

Event

RTB House

Audience

Event

Sailthru

Audience

Event

Salesforce Email

Audience

Event

Feed

Salesforce Mobile Push

Event

Salesforce Sales and Service Cloud

Event

Samba TV

Audience

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

ShareThis

Audience

Feed

Shopify

Custom Pixel

Feed

Signal

Event

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Event

Audience

Snapchat Conversions

Event

Snowflake

Data Warehouse

Snowplow

Event

Split

Event

Feed

Splunk MINT

Event

Sprig

Audience

Event

StartApp

Audience

Stormly

Audience

Event

Statsig

Feed

Event

Swrve

Event

Feed

Talon.One

Audience

Feed

Event

Loyalty Feed

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Taptica

Audience

Teak

Audience

The Trade Desk

Audience

Cookie Sync

Event

Ticketure

Feed

TikTok Event

Audience

Audience (Deprecated)

Audience Migration

Event

Treasure Data

Audience

Event

Triton Digital

Audience

TUNE

Event

Twitter

Event

Audience

Valid

Event

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webtrends

Event

Webhook

Event

White Label Loyalty

Event

Xandr

Audience

Cookie Sync

Wootric

Event

Yahoo (formerly Verizon Media)

Cookie Sync

Audience

Yotpo

Feed

Z2A Digital

Event

Audience

YouAppi

Audience

Zendesk

Feed

Event

Punchh

Audience

Event

Feed

Pushwoosh

Audience

Event

The Overview Map

The Overview Map provides an interactive diagram of your mParticle data infrastructure, including all of your data inputs, outputs, and configured mParticle features.

How to access the Overview Map

The Overview Map is the first page you see after logging into your account at app.mparticle.com.

You can navigate back to the Overview Map at any time by clicking the Overview button in the left hand nav bar.

Screenshot showing the overview button

The Overview Map is unique to each workspace in your account, because each workspace may contain a different configuration of inputs, outputs, and mParticle features. If you can’t find an input, output, or feature that you are expecting to see on the Overview Map, make sure you have selected the correct workspace.

Overview Map settings

The Overview Map has a few basic settings allowing you to control its appearance, and the type of information it displays.

Zoom

You can zoom your view of the Overview Map in and out by clicking the + or - magnifying glass icons in the bottom left corner of the map.

Screenshow showing the zoom controls for the overview map

Switching views

The Overview Map provides two different views. Each view is designed to highlight a different collection of information describing your mParticle account.

You can switch between different views of the Overview Map using the View button to the left of the zoom controls.

Screenshot showing the different view options for the overview map

Overview

The Data Flow view provides a complete diagram of each specific feature your data flows through between your inputs and outputs, including Rules, Data Plans, and Filters.

Screenshot showing the data flow view of the overview map

Connections view

The Connections view only displays your inputs, outputs, and the connections between them.

To see which inputs and outputs are connected, hover your cursor over any input or output, and a highlighted purple line will appear showing the connections. Every output connected to a single input will be highlighted. For example, in the map below you can see that the iOS input is connected to the Amplitude and Amazon Redshift outputs, in addition to a selection of other outputs.

If your workspace contains a large number of inputs or outputs, you can view them in a complete list by clicking the + more Events button.

Screenshot showing the connections view of the overview map

The Overview Map is interactive: you can use it to navigate to different products, features, and settings within mParticle.

If you see a product or feature shown on the map that you can’t click on, your role doesn’t have adequate permissions to view it. Contact your mParticle account administrator to request access.

Inputs

Your inputs are the sources of your customer data. You can create Platform inputs, which use the mParticle SDKs to collect and ingest data directly from different device platforms (like iOS or Web), or Feed inputs, which ingest data from third-party marketing or data warehouse tools.

All of your inputs are listed on the left side of the Overview Map, with the Platform and Feed inputs separated into two groups.

Add an input

To add an input, click the + Add button next to Platforms or Feeds under INPUTS to create an input of either type.

This opens the Setup > Inputs page, where you can create a new Platform or Feed input.

See connections

To view connections between an input and your outputs, hover your cursor over an input’s card and a highlighted purple line will appear between the input and any connected outputs.

Add a connection

To add a connection from an input, click the + icon next to an input card.

Screenshot showing the add connection button in the overview map

This opens the Connections > Connect page for that particular platform input, where you can select one of your configured outputs to connect the input to.

Outputs

Outputs are the destinations of your customer data. These are third-party marketing, analytics, or data warehouse tools that can accept either event data or user data.

Your outputs are shown on the right side of the Overview Map.

Add an output

To add an output, click the + Add button next to Events under OUTPUTS to create an Events output.

This opens the Setup > Outputs page where you can select one of the many available output integrations to configure.

See connected inputs

To see which inputs are connected to an output, hover your cursor over an output’s card and a highlighted purple line will appear between the output and any connected inputs.

Screenshot showing the outputs section of the overview map

View output configurations

A single output can have multiple configurations. To see an expanded list of configurations for an output, click the output’s card.

By hovering your cursor over each card in the expanded list, you can see which inputs send data to that particular configuration.

mParticle Suites

The mParticle platform includes several suites, or collections, of tools that you use to monitor, manage, and leverage your customer data. There are six different suites, and they are are displayed in the center of the Overview Map:

Screenshot showing the suites section of the overview map

Oversight

This group of features allows you to monitor the health of your data infrastructure and manage your data privacy settings. Features here include:

Screenshot showing the oversight suite in the overview map

Data Platform

The Data Platform features provide an overview of what data is flowing into mParticle, both in real time and historically. Features include:

Screenshot showing the data platform suite in the overview map

Customer 360

Customer 360 is the collection of tools and features related to your customer data, including:

Screenshot showing the data customer 360 suite in the overview map

Predictions, Analytics, and Segmentation

From the Customer 360 Profile, you can gain a deeper understanding of your users’ behavior, and make predictions based on their behavior to power a highly personalized, omnichannel customer experience:

  • Predictions: discover how best to engage with your users with mParticle’s machine learning and AI powered predictive analytics suite
  • Analytics: gain actionable insights into how your users behave and interact with your brand
  • Segmentation: create groups of related users and perform user journey analytics, testing, and cross-channel orchestration

Screenshot showing the predictions, analytics, and segmentation suites in the overview map

Data platform management

mParticle provides several data management tools that help you control exactly what data you ingest from your inputs, what data you send to your outputs, and to improve the quality of your data. These tools are Data Plans, Rules, and Filters, and they’re shown on the Overview Map at the intersections between the mParticle Suites and your inputs and outputs.

Screenshot showing location of rules, plans, and filters on overview map

Data Plans

Data Plans allow you to improve the quality of the data you ingest by validating inbound data against a schema. Data that doesn’t fit the schema you define isn’t ingested by mParticle, ensuring that you have high quality when creating Audiences, Predictions, or when forwarding data to your downstream marketing and engagement tools.

Data Plans only operate on data as it is ingested from inputs into the mParticle Suites.

To view your Data Plans, click the Plans button on the Overview Map.

Learn more about Data Plans.

Rules

Rules are scripts that manipulate data that is either being ingested from an input, or forwarded to an output. They allow you to cleanse, enrich, or transform your data by changing event names, modifying event or user attributes, or adding or removing events from a batch.

Rules can be used on both inbound and outbound data.

To view or add Rules, click the Rules button on the Overview Map.

Learn more about Rules.

Filters

Filters control the data that’s forwarded to your outputs. While Rules and Data Plans help you collect only the data you want, without duplicates or poor quality data points, Filters prevent all of your data from being forwarded to all of your outputs.

Filters can only be used on outbound data.

To view your filters, click the Filters button on the Overview Map.

Learn more about Filters.

Identity Resolution

IDSync, mParticle’s identity resolution framework, allows you to manage how your users are identified wherever, and whenever, they engage with your brand. IDSync works in tandem with Customer360 to give you control over exactly what data is attributed to which user profiles.

The Identity Resolution process is noted on the Overview Map between Data Platform and Customer360, but it is not currently navigable via the Overview Map.

To manage your IDSync settings click the Settings icon in the left nav bar, click Platform, and select the Identity Settings tab. Or, click on the identity resolution circle.

Learn more about IDSync.

Was this page helpful?

    Last Updated: June 19, 2025