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

Data Planning API

Custom Access Roles 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

Workspace Switching

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Cordova

Cordova Plugin

Identity

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

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

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

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

Xamarin

Getting Started

Identity

Alexa

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

Python 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

Media SDKs

Android

iOS

Web

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
The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

Billing

Usage and Billing Report

Platform Settings

Platform Configuration

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)

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

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

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

Abakus

Event

ABTasty

Audience

Actable

Feed

AdChemix

Event

Adikteev

Audience

Event

Adjust

Event

Feed

Aarki

Audience

AdMedia

Audience

Adobe Marketing Cloud

Cookie Sync

Server-to-Server Events

Platform SDK Events

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

Adobe Target

Audience

Adobe Experience Platform

Event

AdPredictive

Feed

AgilOne

Event

Airship

Audience

Feed

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

Amplitude

Event

Forwarding Data Subject Requests

Ampush

Event

Audience

Analytics

Audience

Event

Forwarding Data Subject Requests

Anodot

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Apptentive

Event

Apteligent

Event

Apptimize

Event

Attentive

Event

Feed

Attractor

Event

Microsoft Azure Blob Storage

Event

Awin

Event

Batch

Audience

Event

Bidease

Audience

Bing Ads

Event

Bluecore

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Braze

Audience

Forwarding Data Subject Requests

Feed

Event

Bugsnag

Event

Button

Audience

Event

Cadent

Audience

Census

Feed

ciValue

Event

Feed

CleverTap

Event

Audience

Feed

Conversant

Event

Cordial

Audience

Feed

comScore

Event

Cortex

Event

Forwarding Data Subject Requests

Feed

Crossing Minds

Event

Criteo

Audience

Event

CustomerGlu

Feed

Event

Custom Feed

Custom Feed

Customer.io

Audience

Feed

Event

Databricks

Data Warehouse

Datadog

Event

Didomi

Event

Dynamic Yield

Event

Audience

Dynalyst

Audience

Eagle Eye

Audience

Edge226

Audience

Emarsys

Audience

Everflow

Audience

Facebook

Audience

Event

Epsilon

Event

Fiksu

Audience

Event

Facebook Offline Conversions

Event

Google Analytics for Firebase

Event

Flurry

Event

Flybits

Event

ForeSee

Event

Formation

Event

Feed

Foursquare

Audience

Feed

FreeWheel Data Suite

Audience

Friendbuy

Event

Google Ad Manager

Audience

Google Analytics

Event

Google Ads

Audience

Event

Google Analytics 4

Event

Google BigQuery

Audience

Data Warehouse

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

Ibotta

Event

ID5

Kit

Impact

Event

InMarket

Audience

InMobi

Audience

Event

Insider

Event

Audience

Feed

Inspectlet

Event

Intercom

Event

iPost

Audience

Feed

Iterable

Audience

Feed

Event

ironSource

Audience

Jampp

Audience

Event

Kafka

Event

Kayzen

Event

Audience

Kissmetrics

Event

Kochava

Event

Feed

Forwarding Data Subject Requests

Klaviyo

Audience

Event

Kubit

Event

LaunchDarkly

Feed

Leanplum

Audience

Event

Feed

LifeStreet

Audience

Liftoff

Audience

Event

LinkedIn

LinkedIn Conversions API Integration

LiveLike

Event

Liveramp

Audience

MadHive

Audience

Localytics

Event

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

Forwarding Data Subject Requests

Event

MoEngage

Event

Audience

Feed

Moloco

Audience

Event

Monetate

Event

Movable Ink

Event

Movable Ink - V2

Event

Multiplied

Event

myTarget

Audience

Event

Nami ML

Feed

Nanigans

Event

Narrative

Audience

Event

Feed

NCR Aloha

Event

Neura

Event

OneTrust

Event

Optimizely

Audience

Event

Paytronix

Feed

Oracle BlueKai

Event

Oracle Responsys

Audience

Event

Persona.ly

Audience

Personify XP

Event

PieEye

Inbound Data Subject Requests

Pilgrim

Event

Feed

Pinterest

Audience

Event

AppLovin

Audience

Event

Plarin

Event

Primer

Event

Antavo

Feed

Punchh

Audience

Event

Feed

Pushwoosh

Event

Audience

Quadratic Labs

Event

Qualtrics

Event

Quantcast

Event

Rakuten

Event

Radar

Event

Feed

Reddit

Audience

Event

Regal

Event

Remerge

Audience

Event

Retina AI

Event

Feed

Reveal Mobile

Event

RevenueCat

Feed

Sailthru

Audience

Event

Rokt

Audience

Event

Rokt Thanks and Pay+

RTB House

Audience

Event

Salesforce Email

Audience

Event

Feed

Salesforce Sales and Service Cloud

Event

Salesforce Mobile Push

Event

Samba TV

Audience

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

ShareThis

Feed

Audience

Shopify

Custom Pixel

Feed

Postie

Audience

Event

Signal

Event

SimpleReach

Event

Skyhook

Event

Singular-DEPRECATED

Event

Singular

Event

Feed

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Audience

Event

Snowplow

Event

Snowflake

Data Warehouse

Snapchat Conversions

Event

Split

Event

Feed

Splunk MINT

Event

Sprig

Event

Audience

StartApp

Audience

Statsig

Event

Feed

Stormly

Audience

Event

Swrve

Event

Feed

Talon.One

Audience

Event

Feed

Loyalty Feed

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Teak

Audience

Ticketure

Feed

Treasure Data

Audience

Event

The Trade Desk

Audience

Cookie Sync

Event

Taptica

Audience

TikTok Event

Audience

Audience (Deprecated)

Audience Migration

Event

Triton Digital

Audience

TUNE

Event

Twitter

Audience

Event

Valid

Event

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

Wootric

Event

White Label Loyalty

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Cookie Sync

Audience

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Zendesk

Feed

Event

Platform Configuration

The Platform Configuration page provides essential information about any limitations and global settings that have been configured for your mParticle account.

To find your Platform Configuration Settings:

  1. Log into your mParticle account.
  2. Hover your cursor over the Settings icon in the left hand navigation, and select Platform.
  3. Select the Platform Configuration tab.

The Platform Configuration page is organized into two broad categories:

If you have questions or need to make changes to your configuration, contact your mParticle account representative.

Organization Configuration

Each mParticle contract includes a single organization, within which you can create multiple accounts and workspaces.

Everything displayed under Organization Configuration is applicable to all accounts and workspaces within your mParticle organization.

General

Name Format Description
Organization Name The name of your organization The name used to identify your organization across the mParticle platform.
Account Count Number The total number of accounts within your mParticle organization.

Identity Configuration

Name Format Description
Identity Scope
  • Organization
  • Account
  • Workspace
Determines if user profiles are unique in each workspace, account, or organization.
Identity Strategy
  • Profile Conversion
  • Profile Link
  • Profile Isolation
  • Best Match
Determines how mParticle identifies and creates profiles for unknown users.
Identity Hierarchy Table showing the priority and identity control for each identity type The order that identifiers are checked when resolving an unknown user as defined in your identity strategy.

Data Retention

Name Format Description
Long-term Event Data Retention Number of days The length of time events are stored in the mParticle CDP for your organization.
Long-term Profile Data Retention Number of days The length of time profiles are stored in the mParticle CDP and available for data evaluation for your account.
Analytics Data Retention Number of days The amount of time mParticle Analytics stores data before it is discarded, as defined in your contract.

Service Limits

Name Format Description
Events API Rate Limit Requests per second The max number of requests per second that can be sent to the Events API from your organization.
Profile API Rate Limit Requests per second The max number of requests per second that can be sent to the Profile API from your organization.
Analytics Monthly Event Limit Number The maximum number of events available for Analytics.
Workspace Event Limit Current number / Max number The number of unique event names that can be registered per workspace.

Account Configuration

The information displayed under Account Configuration is applicable only to your currently selected account. If you switch to a different account and navigate back to the Platform Configuration Settings page, you will find a different set of information and settings.

You can also view which of the following features are enabled for your account. To make changes, contact your mParticle account representative.

General

Name Format Description
Account Name The name of the account The name used to identify this account within your mParticle organization.
Workspace Count Number The total number of workspaces within this account.

Data Oversight

Name Format Description
CCPA ON / OFF Allows you to collect users' preferences for how their data is used as per the California Consumer Privacy Act regulations (CCPA).
DSR ON / OFF Allows you to receive and process data subject requests from your users.
GDPR ON / OFF Allows you to collect users' preferences for how their data is used as per the General Data Protection Regulations (GDPR).
Consent Purposes per Workspace Number Max number of consent purposes that can be defined for this account.

Data Platform

Name Format Description
Data Warehouse ON / OFF Data Warehousing customer integrations.
Data Warehouse Inbound Integration ON / OFF Ingest data into mParticle from external data warehouses using Data Warehouse Sync.
Data Warehouse Outbound Integration ON / OFF Create connections to external warehouses where you can forward data.
Rules ON / OFF Cleanse, enrich and transform your incoming and outgoing data.
Customer Hosted Rules ON / OFF Create and manage AWS Lambda functions to control how your mParticle account ingests and forwards data.
mParticle Hosted Rules ON / OFF Create and use rules in the mParticle UI to control how your mParticle account ingests and forwards data.
Data Planning ON / OFF Create a schema to validate and filter inbound data to improve your data quality.
Max Data Plans Number The max number of data plans you can create.

Customer 360

Name Format Description
Calculated Attributes ON / OFF Create definitions for user attributes the values of which are calculated based on ingested data.
Max Calculated Attributes Number The max number of calculated attributes that can be created for your organization.
Identity Aliasing ON / OFF Allows you to transfer data from an unknown, or anonymous, profile to a known profile.
User Profile View ON / OFF View a detailed summary of user data for a single profile.

Analytics

Name Format Description
Analytics ON / OFF Analytics is mParticle's suite of tools for segmentation, behavioral analysis, reporting.

Segmentation

Name Format Description
Audiences ON / OFF Define Audiences and connect them to integrations.
Max Audiences Number The max number of Audiences you can create.
Multi Workspace Audiences ON / OFF Create and manage Audiences across multiple workspaces.
Audience Sharing ON / OFF Share Audiences between different workspaces or accounts within your mParticle organization.
Audience Profile Lookback Number of days Defines how long profiles are stored in mParticle and remain available for Audiences.
Audience Event Lookback Number of days Defines how long events are stored in mParticle and remain available for Audiences.

Predictions

Name Format Description
Predictive Audiences ON / OFF Create and manage goal-oriented Audiences containing users who are considered likely to take some specified action.

Was this page helpful?

    Last Updated: September 9, 2025