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

Audience

Braze is a comprehensive customer engagement platform that powers relevant experiences between consumers and brands they love. Braze helps brands foster human connection through interactive conversations across channels.

mParticle audiences correspond to Braze’s Segments feature and can be used to target engagement campaigns in Braze.

Prerequisites

In order to activate our Braze integration, you’re going to need the API key for each app that you’d like to set up, which can be found by logging into your Braze account and navigating to your app’s settings. You will also need to create an App Group REST API Key in the Developer Console.

Braze Instance

Braze maintains several instances. As part of the Configuration Settings, you need to specify which one your data should be forwarded to. You can tell your Braze Instance from the URL of your Braze Dashboard.

Instance Dashboard URL
US 01 Cluster https://dashboard-01.braze.com
US 02 Cluster https://dashboard-02.braze.com
US 03 Cluster https://dashboard-03.braze.com
US 04 Cluster https://dashboard-04.braze.com
US 05 Cluster https://dashboard-05.braze.com
US 06 Cluster https://dashboard-06.braze.com
US 08 Cluster https://dashboard-08.braze.com
EU 01 Cluster https://dashboard-01.braze.eu
EU 02 Cluster https://dashboard-02.braze.eu

Check with your Braze account manager if you are unsure which Braze instance you are using.

There is also the ability to specify a Custom instance, which allows you to specify separate endpoints for REST, SDK and Javascript.

User Identity Mapping

mParticle will attempt to match users in Braze based on IDFAs, Android Device IDs, and a customizable External User ID field, which uniquely identifies a user in Braze. You can set which Identity Type to use as the External User ID in the Configuration Settings. Your External User ID should be a unique, permanent identifier — usually Customer ID or Email. If you are also using the Event integration, make sure you set the same External User ID across both integrations.

Forwarding Audiences

The Braze API does not allow mParticle to directly create and maintain membership of segments in Braze, so the Audience integration works by setting attributes on a user, which you can then use to define a corresponding segment in Braze. Like mParticle, Braze populates it’s Segment Manager based on the actual data points received, so you need to create audiences in mParticle and connect them to Braze first. Then, provided your audience is not empty, the segment membership attributes should become available in the Braze Segment Manager within a few minutes.

mParticle offers seven ways to set segment membership attributes, controlled by the Send Segments As Configuration Setting. The drop-down has the following options:

  1. Single String Attribute (default)
  2. Single Array Attribute
  3. One Attribute Per Segment
  4. Both Single Array Attribute and Single String Attribute
  5. Both Single Array Attribute and One Attribute Per Segment
  6. Both Single String Attribute and One Attribute Per Segment
  7. Single Array Attribute, Single String Attribute, and One Attribute Per Segment

These options will be explained in further detail below.

Sample Audience Membership

Note that Audience IDs can be found in the main Audience list view.

For example, note the Audience IDs for these three audiences:

  • 13053
  • 13052
  • 13051

Single String Attribute

This is the default behavior. mParticle creates a single custom attribute in Braze for each user, called SegmentMembership. The value of this attribute is a comma-separated string of mParticle audience IDs that match the user.

Using the above examples, a user who is a member of Test Audience 1, Test Audience 2, and Test Audience 3 will show the attribute SegmentMembership with a value of "'13053','13052', '13051'" in Braze. See the Sample Braze Profile for an example.

To target members of Test Audience 1, for example, you need to create a matching segment in Braze using the mParticle Audience ID, with the filter SegmentMembershipmatches regex13051. It’s important to choose the matches regex option, and not equals, or users with membership in more than one audience will not be matched.

Single Array Attribute

mParticle creates a single custom array attribute in Braze for each user, called SegmentMembershipArray. The value of this attribute is an array of mParticle audience IDs that match the user.

Using the above examples, a user who is a member of Test Audience 1, Test Audience 2, and Test Audience 3 will show the attribute SegmentMembershipArray with a value of ["13053","13052", "13051"] in Braze. Note, however, that Braze parses array attributes to make them more readable.

See the Sample Braze Profile for an example.

To target members of Test Audience 1, for example, you need to create a matching segment in Braze with the filter SegmentMembershipArrayincludes value13051

One Attribute Per Segment

mParticle creates a custom attribute in Braze for each audience that a user belongs to, based on the External Name of the audience.

Using the above examples, a user who is a member of audience Test Audience 1 will show the attribute In Test Audience 1 is true in Braze.

To target members of Test Audience 1, for example, you need to create a matching segment in Braze with the filter In Test Audience 1equalstrue.

Both Single Array Attribute and Single String Attribute

mParticle will send attributes as described by both Single Array Attribute and Single String Attribute.

Both Single Array Attribute and One Attribute Per Segment

mParticle will send attributes as described by both Single Array Attribute and One Attribute Per Segment.

Both Single String Attribute and One Attribute Per Segment

mParticle will send attributes as described by both Single String Attribute and One Attribute Per Segment.

Single Array Attribute, Single String Attribute, and One Attribute Per Segment

mParticle will send attributes as described by Single Array Attribute, Single String Attribute and One Attribute Per Segment.

Sample Braze Profile

Here is a sample Braze profile with all options enabled.

Deactivating and Deleting Connections

Since mParticle does not directly maintain segments in Braze, it will not delete segments when the corresponding mParticle audience connection is deleted or deactivated. When this happens, mParticle will not update the audience user attributes in Braze to remove the audience from each user.

Deleting an Audience

Deleting an audience does not remove the custom attributes in Braze.

Configuration Settings

Setting Name Data Type Default Value Description
API Key string Your app’s API Key can be found in your Braze dashboard.
API Key Operating System enum Unselected Select which operating system your Braze API key corresponds to. This selection will limit the types of push tokens that will be forwarded on an audience update.
Send Segments As enum Single String Attribute The method of sending audiences to Braze. Audience membership can be uploaded as a custom attribute containing comma-separated audience IDs, a custom array attribute containing audience IDs, and / or one attribute per audience with a boolean value to indicate membership. Warning: If multiple configurations use the same credentials and cluster, options involving single attributes may cause values to be overwritten on Braze’s end.
App Group REST API Key string The App Group REST API Key can be found in the developer console section of the Braze dashboard.
External Identity Type enum Customer ID The mParticle User Identity type to forward as an External ID to Braze.
Email Identity Type enum Email The mParticle User Identity Type to forward as the Email to Braze.
Braze Instance enum US 03 Cluster Specify which cluster your Braze data will be forwarded to. Please ensure you are contractually authorized to use the EU cluster if you select that option. If you choose ‘Custom’, you will need to provide separate endpoints for your SDK, Server, and Web data.
Forward Push Tokens bool True If enabled, mParticle will forward user Push Tokens to Braze.
    Last Updated: November 8, 2024