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

Audit Logs API

Bulk Profile Deletion API Reference

Calculated Attributes Seeding API

Custom Access Roles API

Household Reach API Reference

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

Workspace Switching

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Upgrade to Version 6

Cordova

Cordova Plugin

Identity

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

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

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

Upgrade to Version 9

.NET MAUI

Getting Started

Identity

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Xbox

Getting Started

Identity

Web

Initialization

Configuration

Content Security Policy

Event Tracking

User Attributes

IDSync

Page View Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Custom Logger

Persistence

Native Web Views

Self-Hosting

Multiple Instances

Web SDK via Google Tag Manager

Preventing Blocked HTTP Traffic with CNAME

Facebook Instant Articles

Troubleshooting the Web SDK

Browser Compatibility

Linting Data Plans

API Reference

Upgrade to Version 2 of the SDK

Alexa

Quickstart
HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

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

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

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

Glossary

Data Hosting Locations

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

The Developer's Guided Journey to mParticle

API Credential Management

Guides
Composable Audiences

Composable Audiences Overview

User Guide

User Guide Overview

Warehouse Setup

Warehouse Setup Overview

Connections

Connections Overview

Google BigQuery

Databricks

Amazon Redshift

Snowflake

Data Models

Data Models Overview

Create a User Data Model

Create an Event Data Model

Create a Generic Data Model

Audience Setup

Frequently Asked Questions

Customer 360

Overview

User Profiles

Overview

User Profiles

Household Reach

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Predictions

Predictions Overview

What's Changed in the New Predictions UI

View and Manage Predictions

Predict Future Behavior

Future Behavior Predictions Overview

Create Future Behavior Prediction

Manage Future Behavior Predictions

Create an Audience with Future Behavior Predictions

Next Best Action

Next Best Action Overview

Create a Next Best Action Prediction

Manage Next Best Actions

Create an Audience with Next Best Actions

Find Similar Customers

Similar Customer Predictions Overview

Create Similar Customer Prediction

Manage Similar Customer Predictions

Build an Audience with Similar Customer Predictions

Identity

Identity Dashboard

Identity Logs

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

The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

Platform Settings

Audit Logs

Key Management

Platform Configuration

Event Forwarding

Event Match Quality Dashboard

Notifications

System Alerts

Trends

Introduction

Data Retention

Data Catalog

Connections

Activity

Data Plans

Live Stream

Filters

Consent 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

Audience Insights

Audience Sharing

Match Boost

Inclusive & Exclusive Audiences (Early Access)

Inclusive & Exclusive Audiences Overview

Using Logic Blocks in Audiences

Combining Inclusive and Exclusive Audiences

Inclusive & Exclusive Audiences FAQ

Audience Expansion

Audience Agent (Early Access)

Audience Agent Overview

Building Audiences with the Agent

Data and Privacy

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

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

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey 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

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

SFTP Credentials

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 (Snowplow Schema)

AWS S3 Integration (Define Your Own 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

ABTasty

Audience

Aarki

Audience

Actable

Feed

AdChemix

Event

Adikteev

Audience

Event

Adjust

Event

Feed

AdMedia

Audience

Adobe Marketing Cloud

Cookie Sync

Platform SDK Events

Server-to-Server Events

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

Adobe Experience Platform

Event

Adobe Target

Audience

AdPredictive

Feed

AgilOne

Event

Airship

Audience

Event

Feed

Algolia

Event

Amazon Advertising

Event

Audience

Amazon Kinesis

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Redshift

Data Warehouse

Amazon S3

Audience

Event

Amazon SNS

Event

Amobee

Audience

Amazon SQS

Event

Amplitude

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

Anodot

Event

Antavo

Feed

AppLovin

Audience

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Apptentive

Event

Apteligent

Event

Apptimize

Event

Attentive

Feed

Event

Awin

Event

Microsoft Azure Blob Storage

Event

Bidease

Audience

Bluedot

Feed

Bing Ads

Event

Bluecore

Event

Blueshift

Event

Forwarding Data Subject Requests

Feed

Branch

Event

Feed

Forwarding Data Subject Requests

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Cadent

Audience

Branch S2S Event

Event

Bugsnag

Event

Census

Feed

Button

Event

Audience

CleverTap

Audience

Event

Feed

comScore

Event

Conversant

Event

Cordial

Audience

Feed

Cortex

Event

Forwarding Data Subject Requests

Feed

Criteo

Audience

Event

Crossing Minds

Event

Custom Feed

Custom Feed

CustomerGlu

Feed

Event

Customer.io

Audience

Event

Feed

Datadog

Event

Databricks

Data Warehouse

Didomi

Event

Dynamic Yield

Audience

Event

Eagle Eye

Audience

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Everflow

Audience

Facebook

Audience

Event

Facebook Offline Conversions

Event

Google Analytics for Firebase

Event

Flurry

Event

Flybits

Event

Foursquare

Audience

Feed

ForeSee

Event

FreeWheel Data Suite

Audience

Friendbuy

Event

Google Ad Manager

Audience

Google Ads

Event

Audience

Google Analytics

Event

Google Analytics 4

Event

Google BigQuery

Data Warehouse

Audience

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Marketing Platform Offline Conversions

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Pub/Sub

Event

Heap

Event

Google Tag Manager

Event

Hightouch

Feed

Herow

Feed

Hyperlocology

Event

ID5

Kit

Ibotta

Event

Impact

Event

InMarket

Audience

InMobi

Audience

Event

Inspectlet

Event

Insider

Audience

Event

Feed

iPost

Audience

Feed

Intercom

Event

Iterable

Audience

Feed

Event

Jampp

Audience

Event

ironSource

Audience

Kafka

Event

Kayzen

Event

Audience

Kissmetrics

Event

Klaviyo

Audience

Event

Kochava

Event

Feed

Forwarding Data Subject Requests

LaunchDarkly

Feed

Kubit

Event

Leanplum

Event

Audience

Feed

Liftoff

Audience

Event

LifeStreet

Audience

LinkedIn

Audience

LinkedIn Conversions API Integration

Liveramp

Audience

LiveLike

Event

Localytics

Event

MadHive

Audience

Mailchimp

Audience

Feed

Event

mAdme Technologies

Event

Marigold

Audience

Mautic

Event

Audience

MediaMath

Audience

Microsoft Ads

Microsoft Ads Audience Integration

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mediasmart

Audience

Mixpanel

Audience

Event

Mixpanel Cohort Feed Integration

Forwarding Data Subject Requests

MoEngage

Audience

Event

Feed

Moloco

Audience

Event

Monetate

Event

Movable Ink

Event

Movable Ink - V2

Event

myTarget

Audience

Event

Multiplied

Event

Nami ML

Feed

Nanigans

Event

Narrative

Event

Audience

Feed

NCR Aloha

Event

Neura

Event

OneTrust

Event

Optimizely

Event

Audience

Oracle BlueKai

Event

Oracle Responsys

Audience

Event

Personify XP

Event

Paytronix

Feed

Persona.ly

Audience

PieEye

Inbound Data Subject Requests

Pilgrim

Event

Feed

Pinterest

Audience

Event

Plarin

Event

Primer

Event

Punchh

Audience

Event

Feed

Pushwoosh

Audience

Event

Qualtrics

Event

Quantcast

Event

Radar

Event

Feed

Postie

Audience

Event

Rakuten

Event

Reddit

Audience

Event

Regal

Event

Batch

Audience

Event

Remerge

Audience

Event

RevenueCat

Feed

Reveal Mobile

Event

Rokt

Audience

Rokt Thanks and Pay+

Event

RTB House

Audience

Event

Sailthru

Audience

Event

Salesforce Email

Audience

Event

Feed

Salesforce Mobile Push

Event

Salesforce Sales and Service Cloud

Event

Feed

Scalarr

Event

Samba TV

Audience

Event

SendGrid

Audience

Feed

ShareThis

Audience

Feed

SFTP

Audience

SessionM

Event

Feed

Shopify

Custom Pixel

Feed

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Audience

Event

Snapchat Conversions

Event

Snowplow

Event

Snowflake

Audience

Data Warehouse

Split

Event

Feed

Splunk MINT

Event

Sprig

Audience

Event

StartApp

Audience

Statsig

Event

Feed

Stormly

Audience

Event

Talon.One

Audience

Event

Feed

Loyalty Feed

Swrve

Event

Feed

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Teak

Audience

Taptica

Audience

The Trade Desk

Audience

Cookie Sync

Event

Ticketure

Feed

TikTok Event

Audience

Audience (Deprecated)

Event

Audience Migration

Treasure Data

Audience

Event

TUNE

Event

Triton Digital

Audience

Twitter

Audience

Event

Valid

Event

Vkontakte

Audience

Vibe

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Wootric

Event

X

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Cookie Sync

Audience

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Zendesk

Feed

Event

Retina AI

Event

Feed

Manage Audiences

The Audiences landing page is the central place to review and manage audiences and audience groups. To open it, select Segmentation in the Overview Map, then select Audiences in the navigation.

The Audiences landing page showing audience summary cards, status tabs, search and filter controls, and the audiences table

Review audience summaries

The audience summary cards at the top of the landing page provide an overview of your audiences:

  • Total audiences shows the total number of audiences and summarizes them by status.
  • Active audiences shows how many audiences are active relative to your account limit and identifies your most-used outputs.
  • Audience size shows the average size across active audiences and identifies the audiences with the largest gains and declines.

Find and filter audiences

Use the controls above the table to narrow the audiences displayed:

  • Select one of the status tabs (either Active, Faulty, or Inactive) to see only audiences with that status. Select All audiences to view audiences with any status. The number shown next to All audiences reflects the audiences available in the current view, with any filters applied.
  • Enter an audience name, tag, or ID in the search field.
  • Select Filters to open the filter drawer, choose filter values, and apply them to the table.

Customize the audience table

Select View columns to control which fields appear in the table:

  1. Search for a column by name or scroll through the available columns.
  2. Select or clear a column’s checkbox to show or hide it.
  3. Drag selected columns into the order you want.
  4. Select Save.

Select Reset to restore the default column selection and order.

Available fields include identifying information, audience metrics, refresh information, ownership and modification details, and tags. Examples include:

  • Name
  • Type
  • ID
  • Size
  • Refresh frequency
  • Total audiences
  • Active audiences
  • Adds
  • Drops
  • Volatility
  • Last synced
  • Last updated (UTC)
  • Created by
  • Created on
  • Last modified by
  • Tags

Some metrics apply only to individual audiences or only to audience groups. The table displays a dash when a field isn’t available for that row type. For example, individual-audience metrics such as Size, Adds, Drops, and Volatility aren’t available for audience group rows.

Review audiences and audience groups

Audience groups contain one or more individual audiences. Use the expand or collapse control beside a group name to show or hide its audiences.

An expanded audience group showing its individual audiences

If an audience group contains a single audience, the landing page displays only the individual audience.

A single audience displayed on the Audiences landing page

For scheduled audiences, Next calculation shows when mParticle will next refresh audience membership. For a one-time audience, it shows the single scheduled calculation. After that calculation completes, no additional calculation is scheduled, and the audience expires 30 days after its scheduled start date.

Audience Insights

Select the Insights icon in an eligible audience row to open its dedicated Audience Insights page. The icon appears only for real-time audiences with an Active or Calculated status.

The dedicated page isn’t available for composable audiences. Real-time and composable audiences can continue to access Insights from the Insights tab in Audience Builder.

For metric definitions and eligibility details, see Audience Insights.

Manage audiences

Select an audience name to open it in Audience Builder. Select an audience group name to open it in the Audience Group Editor.

Create and apply tags

Use tags to organize audiences by purpose, campaign, or another category. You can also enter a tag in the landing-page search field to find every audience with that tag.

To create and apply a tag:

  1. Expand the audience group that contains the audience.
  2. Select the Tags control in the audience row.
  3. Enter a tag name. Tag names can contain up to 18 characters.
  4. Select the new tag to apply it to the audience.

To apply additional tags, open the audience’s tag list and select each tag you want to add.

Edit audience group inputs

You can add or remove an audience group’s data inputs after creating it:

  1. Open the audience group.
  2. Select the top node labeled Audience Group Inputs.
  3. Add or remove inputs.
  4. Select Update.

Clone audiences and audience groups

Use cloning to reuse an audience’s criteria or an audience group’s configuration instead of starting from scratch.

Clone an audience

You can clone an audience from the Audiences landing page or from the Audience Group Editor.

From the Audiences landing page

To clone an audience from the Audiences landing page:

  1. Go to Segmentation > Audiences.
  2. Select New Audience.
  3. In the Create Audience dialog, select Start from existing audience.
  4. Open the Select Audience dropdown and select the audience you want to clone.
The Create Audience dialog opened from the Audiences landing page, with the Start from existing audience dropdown expanded
  1. Select Next.

Audience Builder opens with the criteria from the selected audience. Review and edit the criteria as needed.

From the Audience Group Editor

To clone an audience from the Audience Group Editor:

  1. Open the audience group where you want to add the cloned audience.
  2. Select the + icon where you want to add the cloned audience.
The add audience controls in the Audience Group Editor
  1. In the Create Audience dialog, select Start from existing audience.
  2. Open the Select Audience dropdown and select the audience you want to clone.
The Create Audience dialog opened from the Audience Group Editor, with the Start from existing audience dropdown expanded
  1. Select Next.

Audience Builder opens with the criteria from the selected audience. Review and edit the criteria as needed.

Clone an audience group

To clone an audience group:

  1. Go to Segmentation > Audiences.
  2. Open the three-dot action menu for the audience group you want to clone, then select Clone.
The action menu for an audience group with Clone selected
  1. In the Clone Audience Group dialog, enter a descriptive name for the cloned group.
  2. Select Clone Audience Group.
The Clone Audience Group dialog with a name entered for the cloned group

The Audience Group Editor opens with the cloned group. Cloned audience groups are inactive by default. You can activate the audiences in the group and connect them to downstream outputs as you would for any other audience group.

Delete audiences and audience groups

Delete one audience

To delete a single audience:

  1. Open the audience’s row action menu.
  2. Select Delete.
  3. Review the affected audience in the confirmation dialog.
  4. Confirm the deletion.

Delete multiple audiences

To delete multiple audiences:

  1. Select the checkbox for each audience you want to delete.
  2. Select the count-aware bulk action, such as Delete (2).
Two selected audiences and the Delete (2) bulk action on the Audiences landing page
  1. Review every affected audience in the confirmation dialog.
The Delete Audiences confirmation dialog listing two selected audiences
  1. Confirm the deletion.

Delete an audience group

To delete an audience group:

  1. Open the audience group’s action menu.
  2. Select Delete group.
  3. Review every audience in the confirmation dialog.
  4. Confirm the deletion.
The confirmation for deleting an audience group, listing every audience in the group and marking a dependent audience In use

Resolve in-use dependencies

An audience is marked In use when another audience depends on it. The dependency details in the deletion dialog identify the records that prevent deletion.

The In use help text explaining that another audience depends on the selected audience

Remove the dependencies before trying the deletion again. If any audience in an audience group is In use, you will not be able to delete the group.

Download an Audience

You can download an audience that has been calculated as a CSV file. Downloads are useful for verifying that specific profiles match your criteria, troubleshooting an audience definition, or sharing audience data when an official mParticle audience integration isn’t available.

You can download a real-time audience after it begins calculating. You can also download a one-time audience after it calculates and before it expires. A one-time audience expires 30 days after its scheduled start date and can’t be downloaded after expiration.

A/B test variations, including the control group, can also be downloaded. Each variation appears as an individual audience on the Audiences landing page, so select the variation you want and follow the standard download steps.

Initiate a Download

  1. On the Audiences landing page, open the actions menu for the audience you want to download and select the download option.
Select the download action for an audience
  1. Choose whether to download all users or a sample, then select the download format. A sample is usually faster to prepare and is useful for testing or troubleshooting.
Choose the audience download size and format
  1. Select the device IDs to include in the download.
Select device IDs to include in the audience download
  1. Select the identities to include in the download.
Select identities to include in the audience download
  1. Select Download.

Download the File

mParticle prepares the download asynchronously. When the file is ready, mParticle sends an email containing a link to download it.

The download is a ZIP archive containing a CSV file for each selected audience or variation and a manifest.json file containing metadata about the download.

CSV Format

Audience CSV files contain one row for each identity in the audience. Because a single user profile can contain multiple identities, the same MPID can appear in multiple rows.

Each row contains the MPID, the time the membership was retrieved, the identity value, and the identity type:

mpid, scanned_timestamp_ms, identity_value, identity_type
-1327484737295091692, 1538596779, h.jekyll.md, customer_id
5991422180106081928, 1538596729, m.hyde@example.com, email
3269816782460039080, 1580148438137, 74587f4b-3ed5-492f-a0f5-9a6c4578673d, ios_idfv

Manifest Example

The manifest.json file describes the archive, selected identities, generation time, included files, and row counts:

{
  "archive_name": "mParticleAudiences_204223Jan022019_9dd9.zip",
  "id": "9dd9b6dc-f0ec-4acf-8b18-f3a357afe1c3",
  "audience_ids": [
    8754
  ],
  "included_identities": [
    "customer_id",
    "email"
  ],
  "manifest_generated": "2019-01-02T21:06:20.0216776Z",
  "min_timestamp_ms": 1546463100276,
  "max_timestamp_ms": 1546463100276,
  "total_rows": 18,
  "rows_by_identity": {
    "customer_id": 15,
    "email": 3
  },
  "files": [
    {
      "file_name": "8754_PotentialParisians_172136Nov292018.csv",
      "min_timestamp_ms": 1546463100276,
      "max_timestamp_ms": 1546463100276,
      "total_users": 15,
      "total_rows": 18,
      "rows_by_identity": {
        "customer_id": 15,
        "email": 3
      }
    }
  ]
}

Share audiences between accounts

You can share audiences between your organization’s accounts. When sharing an audience with an account, you can specify one of the following access levels for recipient account:

  • Owner: Full access to the audience, including editing, audience updates, and connecting outputs. Admins can set permissions.
  • Private: The audience is invisible to the receiving account.
  • View only: Visible to the receiving account but cannot connect to outputs.
  • Usable: Visible to the receiving account and can connect to outputs. Audience definition cannot be edited.

To share an audience:

  1. Navigate to the Audiences landing page.
  2. Open the Actions menu for the audience you want to share, then click Share.

    The Actions menu for an audience with Share selected
  3. In Audience Sharing Settings, review the accounts the audience is already shared with. To add an account, click the + button.

    Audience Sharing Settings with no accounts currently selected
  4. Select the account you want to share the audience with under Share With, and select the access level under Share Level.

    The Add Account controls in Audience Sharing Settings
  5. Click Add. Repeat these steps to share the audience with additional accounts, and when you are finished, click Save.
  6. You can change an existing access level with its dropdown or stop sharing with an account by clicking the delete icon.

    An existing account with controls to change or remove its audience access

Was this page helpful?

    Last Updated: September 8, 2026