Documentation

Developers

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

Custom Access Roles API

Data Planning API

Group Identity API Reference

Calculated Attributes Seeding API

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

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Flutter

Getting Started

Usage

API Reference

iOS

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

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

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

Cordova

Cordova Plugin

Identity

Web

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

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

HTTP 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

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

Rules Developer Guide

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

API Credential Management

The Developer's Guided Journey to mParticle

Guides

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

Introduction

Data Retention

Connections

Activity

Live Stream

Data Filter

Rules

Tiered Events

mParticle Users and Roles

Analytics Free Trial

Troubleshooting mParticle

Usage metering for value-based pricing (VBP)

Analytics

Introduction

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

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

Understanding the Screen View Event

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

Dashboards

Dashboards––Getting Started

Manage Dashboards

Organize Dashboards

Dashboard Filters

Scheduled Reports

Favorites

Time and Interval Settings in Dashboards

Query Notes in Dashboards

User Aliasing

Analytics Resources

The Demo Environment

Keyboard Shortcuts

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

User Segments

APIs

User Segments Export API

Dashboard Filter API

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

Data Master
Group Identity

Overview

Create and Manage Group Definitions

Introduction

Catalog

Live Stream

Data Plans

Data Plans

Blocked Data Backfill Guide

Personalization
Predictive Attributes

Predictive Attributes Overview

Create Predictive Attributes

Assess and Troubleshoot Predictions

Use Predictive Attributes in Campaigns

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

Introduction

Profiles

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Audiences

Audiences Overview

Real-time Audiences

Standard Audiences

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

Journeys 2.0

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

Debug Console

Data Warehouse Delay Alerting

Identity Providers

Single Sign-On (SSO)

Setup Examples

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

REST API

Dashboard Filter API (Deprecated)

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

Adikteev

Audience

Event

AdChemix

Event

Adjust

Event

Feed

AdMedia

Audience

Adobe Marketing Cloud

Cookie Sync

Event

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

Adobe Target

Audience

AdPredictive

Feed

AgilOne

Event

Airship

Event

Audience

Feed

AlgoLift

Event

Feed

Algolia

Event

Alooma

Event

Amazon Advertising

Audience

Amazon Kinesis

Event

Amazon Redshift

Data Warehouse

Amazon Kinesis Firehose

Event

Audience

Amazon S3

Event

Amazon SNS

Event

Amazon SQS

Event

Adobe Marketing Cloud

Event

Amobee

Audience

Ampush

Audience

Event

Amplitude

Event

Forwarding Data Subject Requests

Analytics

Audience

Forwarding Data Subject Requests

Event

Anodot

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Apptentive

Event

Apptimize

Event

Antavo

Feed

Apteligent

Event

Attractor

Event

AppLovin

Audience

Event

Microsoft Azure Blob Storage

Event

Attentive

Event

Feed

Bidease

Audience

Batch

Event

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

Feed

Forwarding Data Subject Requests

Event

Bugsnag

Event

Button

Audience

Event

Census

Feed

Cadent

Audience

ciValue

Event

Feed

CleverTap

Audience

Event

Feed

comScore

Event

Conversant

Event

Cordial

Audience

Feed

Criteo

Audience

Event

Custom Feed

Custom Feed

CustomerGlu

Feed

Event

Cortex

Event

Feed

Forwarding Data Subject Requests

Crossing Minds

Event

Customer.io

Audience

Event

Feed

Didomi

Event

Datadog

Event

Dynalyst

Audience

Dynamic Yield

Audience

Event

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Everflow

Audience

Fiksu

Audience

Event

Facebook Offline Conversions

Event

Google Analytics for Firebase

Event

Flybits

Event

Flurry

Event

ForeSee

Event

FreeWheel Data Suite

Audience

Formation

Event

Feed

Foursquare

Feed

Audience

Google Ads

Audience

Event

Google Ad Manager

Audience

Google Analytics

Event

Google Analytics 4

Event

Google Cloud Storage

Audience

Event

Google BigQuery

Audience

Data Warehouse

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

Herow

Feed

Hightouch

Feed

Hyperlocology

Event

Ibotta

Event

InMarket

Audience

Impact

Event

Indicative

Audience

Event

InMobi

Audience

Event

Insider

Audience

Feed

Event

Inspectlet

Event

Intercom

Event

iPost

Audience

Feed

ironSource

Audience

Iterable

Audience

Feed

Event

Jampp

Audience

Event

Facebook

Audience

Event

Kafka

Event

Kissmetrics

Event

Kayzen

Audience

Event

Klaviyo

Audience

Event

Kochava

Event

Feed

Forwarding Data Subject Requests

Kubit

Event

LaunchDarkly

Feed

Leanplum

Audience

Event

Feed

LifeStreet

Audience

Liftoff

Audience

Event

LiveLike

Event

Liveramp

Audience

mAdme Technologies

Event

Localytics

Event

MadHive

Audience

Mailchimp

Audience

Event

Feed

Marigold

Audience

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mixpanel

Audience

Event

Forwarding Data Subject Requests

MoEngage

Audience

Event

Feed

Moloco

Audience

Event

Monetate

Event

Movable Ink - V2

Event

Movable Ink

Event

Multiplied

Event

myTarget

Audience

Event

Nami ML

Feed

Mautic

Audience

Event

Nanigans

Event

Narrative

Event

Feed

Audience

NCR Aloha

Event

Neura

Event

Optimizely

Event

Audience

OneTrust

Event

Oracle BlueKai

Event

Paytronix

Feed

Persona.ly

Audience

Oracle Responsys

Audience

Event

PieEye

Inbound Data Subject Requests

Pilgrim

Event

Feed

Personify XP

Event

Pinterest

Audience

Event

Plarin

Event

Postie

Audience

Event

Primer

Event

Punchh

Audience

Feed

Event

Pushwoosh

Audience

Event

Quantcast

Event

Radar

Event

Feed

Reddit

Audience

Event

Regal

Event

Remerge

Audience

Event

Retina AI

Event

Feed

Reveal Mobile

Event

RevenueCat

Feed

RTB House

Event

Audience

Rokt

Audience

Sailthru

Audience

Event

Salesforce Mobile Push

Event

Scalarr

Event

Salesforce Email

Audience

Event

Feed

Samba TV

Audience

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

ShareThis

Audience

Feed

Shopify

Custom Pixel

Feed

Signal

Event

SimpleReach

Event

Singular

Feed

Event

Singular-DEPRECATED

Event

Slack

Event

Skyhook

Event

Smadex

Audience

SmarterHQ

Event

Snapchat Conversions

Event

Snapchat

Audience

Event

Snowflake

Data Warehouse

Split

Feed

Event

Snowplow

Event

Splunk MINT

Event

Sprig

Event

Audience

StartApp

Audience

Statsig

Feed

Event

Stormly

Audience

Event

Swrve

Event

Feed

Talon.One

Audience

Event

Feed

Tapjoy

Audience

Tapad

Audience

Taplytics

Event

Taptica

Audience

The Trade Desk

Event

Audience

Cookie Sync

Teak

Audience

Ticketure

Feed

TikTok Event

Audience

Audience (Deprecated)

Event

Audience Migration

TUNE

Event

Treasure Data

Audience

Event

Triton Digital

Audience

Vkontakte

Audience

Twitter

Audience

Event

Valid

Event

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

White Label Loyalty

Event

Wootric

Event

Xandr

Cookie Sync

Audience

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

YouAppi

Audience

Webtrends

Event

Z2A Digital

Audience

Event

Zendesk

Feed

Event

Qualtrics

Event

Quadratic Labs

Event

Event

Analytics is mParticle’s customer journey analytics platform designed for product and marketing teams to leverage complex analysis to build better products that drive conversion, increase engagement, and retain customers.

Prerequisites

  • Analytics supports both Event and Audience connections when integrating with an mParticle data source. However, Analytics requires an event input to be able to use the platform, so enabling the Event connection is required.
  • Set up your Analytics projects using the free trial wizard in mParticle.

Supported Platforms

  • Alexa
  • Android
  • Apple TV
  • Data Feeds
  • Fire TV
  • iOS
  • Roku
  • SmartTV
  • tvOS
  • Web
  • Xbox

Supported Identities

Analytics supports the following user and device identities.

User Identities

  • Email Address
  • Customer ID
  • mParticle ID (MPID)
  • Other
  • Other 2
  • Other 3
  • Other 4
  • Other 5
  • Other 6
  • Other 7
  • Other 8
  • Other 9
  • Other 10

Device Identities

  • Push Token
  • Android Device ID
  • Apple IDFV
  • Apple IDFA
  • Google Advertising ID
  • Roku Advertising ID
  • Roku Publisher ID

Supported Event Types

Analytics supports the following event types:

  • Application State Transition
  • Commerce Event
  • Crash Report
  • Custom Event
  • Opt Out
  • Push Registration
  • Push Open
  • Screen View
  • Session End
  • Session Start
  • User Attribute Change
  • User Identity Change

Data Processing Notes

  • Analytics accepts data from any timeframe.

    • Data with mParticle event timestamp <= 24 hours will process in Analytics in near real time
    • Data with mParticle event timestamp > 24 hours will process through Analytics’s replay queue, which is meant built for backfills and runs sequentially, first in, first out. Generally allow a few days for data to be available in Analytics that runs through the replay queue.
  • In addition to the user IDs, device IDs, and event types listed previously, mParticle forwards location, IP address, Device Application Stamp, and user agent data to Analytics.
  • Analytics supports DSR forwarding from mParticle. See Analytics’s Privacy & Security docs for information on deletion, rectification, and suppression APIs.

User Identity Options

Analytics uses mParticle’s MPID as the Analytics eventUniqueId. The MPID is therefore the only user identity to match incoming event and audience updates to the correct user profile in Analytics. Therefore, the configuration of IDSync and the identity strategy for your mParticle account will be applied to events in Analytics.

Data Mapping Reference

Event Data Mapping

The following mParticle event types are translated into Analytics events.

mParticle Event Type Analytics Event Name Note
ApplicationStateTransition App Install, App Upgrade, App Initialize, App Exit, App Background, App Foreground
Commerce: Impression Impression
Impression Item These events are sent only if Process Impression Item Events is set to True
Commerce: ProductAction $action For example, “Purchase”
$action Item For example, “Purchase Item”. These events are only processed If Process Product Action Item Events is enabled.
Commerce: PromotionAction Promo $action For example, “Promo Click”
Commerce: PromotionAction Promo $action Item For example, “Promo Click Item.” These events are only processed if Process Promotion Item Events is enabled.
Custom Event CustomEvent.name
Crash Report Error
PushMessageReceived Push Received
PushSubscription Push $action $action will be either “Subscribe” or “Unsubscribe.”
ScreenView Screen View
SessionEnd Session End
SessionStart Session Start

Custom Event Name Clashes

If you have a custom attribute name that is the same as an event name in Analytics, for example screen_name, you can keep both values by requesting that the prefix mp_ be added to one of the names. If you don’t do this, Analytics chooses one value at random and drops the other, leading to unpredictable results.

To request this, submit a request to Support.

Time-based Auto-generated Properties

Analytics auto-generates time-based properties for each event that it receives from mParticle. These properties are determined and defined as follows:

Property Value Start and End Times
Morning 05:00 - Before 10:00
Daytime 10:00 - Before 18:00
Evening 18:00 - Before 21:00
Night 21:00 - Before 00:00
Overnight 00:00 - Before 05:00

Properties Data Model

mParticle attributes are converted to Analytics properties automatically when forwarded. The Analytics naming conventions closely match mParticle, with the following exceptions:

mParticle Property Value or Path Analytics User Property Name Note
platform mp_rt_env
ip mp_rt_ip
sdk_version mp_rt_sdkversion
http_header_user_agent mp_rt_useragent
ErrorEvent.breadcrumbs breadcrumbs A comma-delimited string of breadcrumbs
CustomEvent.name custom_event_name
CustomEvent.customType custom_event_type
ImpressionEvent.impression_list_name list_name
CommerceEvent.product.$key product_$key A comma-delimited string of values.
Impression[].Product[].key product_$key For example, “product_brand” for Impression[].Product[].brand or “product_id” for Impression[].Product[].id
PushSubscriptionEvent is_push_subscribed True or False, depending on the action

In addition to mp_rt_useragent, the following properties are derived from http_header_user_agentand may be returned:

  • mp_rt_browsername
  • mp_rt_browserversion
  • mp_rt_osname
  • mp_rt_osversion
  • mp_rt_devicetype

User Properties Data Model

mParticle user attributes are included in a UserAttributeChangeEvent or directly from event types. The following user attributes are converted to Analytics user properties when forwarded:

mParticle Property Value or Path Analytics User Property Name Note
user_identities user_id.$type For example, user_id.customer
device_info device_id.$type For example, device_id.ios_advertising_id
user_attributes ua_$key For example, ua_$firstname and ua_color=’red’
UserAttributeChangeEvent.added{}.value ua_$key
UserAttributeChangeEvent.removed{}.key ua_$key Analytics does not support unsetting a user attribute, so the value is replaced with “$unset”. For example, userattr_color=”$unset”.

Automatic UTM Parsing

For any event that mParticle sends to Analytics containing a URL with UTM parameters, Analytics automatically parses each UTM parameter into separate properties. In the table below, assume that Analytics has received a URL as a property named pageUrl:

Supported UTM Parameter Example Analytics Property Name Example Analytics Property Value Description
utm_source pageUrl.utm_source Facebook Defines the source sending traffic to the URL
utm_medium pageUrl.utm_medium blog_article Defines the channel sending the UTM source
utm_campaign pageUrl.utm_campaign journeys_launch Defines the name of the campaign associated with the URL
utm_content pageUrl.utm_content header_link Used to track different ads or CTAs related to a campaign
utm_term pageUrl.utm_term la_restaurants Used to track paid keywords or phrases.
utm_source_platform pageUrl.utm_source_platform Facebook A variation of UTM source.
utm_creative_format pageUrl.utm_creative_format carousel The type of ad placement or creative material used in a campaign.
utm_marketing_tactic pageUrl.utm_marketing_tactic remarketing The tactic used in your marketing efforts.
utm_id pageUrl.utm_id 123456789 Used to track performance of campaigns in GA.

Settings Reference

You can set configuration values for different inputs, and connection setting values to control the behavior of data once it is input.

Configuration Settings

Setting Name Data Type Default Value Description
API Key string Input your project API key found within your Analytics project settings.

Connection Settings

Setting Name Data Type Default Value Description
Process Impression Item Events boolean False Choose whether to record additional events for each Product in an Impression event. Enabling this may increase your Analytics event volume significantly.
Process Product Action Item Events boolean True Choose whether to record additional events for each Product in a Product Action event. Enabling this may increase your Analytics event volume significantly.
Process Promotion Item Events boolean True Choose whether to record additional events for each Promotion in an Promotion Action event.
    Last Updated: November 8, 2024