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

Calculated Attributes Seeding API

Custom Access Roles API

Data Planning API

Group Identity API Reference

Pixel Service

Profile API

Events API

mParticle JSON Schema Reference

IDSync

Client SDKs
AMP

AMP SDK

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

Cordova

Cordova Plugin

Identity

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

Flutter

Getting Started

Usage

API Reference

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

Xamarin

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

Web

Alexa

Media SDKs

Android

iOS

Web

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

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

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

Linting Tools

Smartype

mParticle Command Line Interface

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Compose ID

Data Hosting Locations

Glossary

Migrate from Segment to mParticle

Migrate from Segment to mParticle

Migrate from Segment to Client-side mParticle

Migrate from Segment to Server-side mParticle

Segment-to-mParticle Migration Reference

Rules Developer Guide

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

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

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 Audiences

Predictive Audiences Overview

Using Predictive Audiences

Predictive Attributes

Predictive Attributes Overview

Create Predictive Attributes

Assess and Troubleshoot Predictions

Use Predictive Attributes in Campaigns

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

Snowplow Schema Overview

Snowflake (Snowplow Schema)

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

ABTasty

Audience

Abakus

Event

Aarki

Audience

Actable

Feed

AdChemix

Event

Adjust

Event

Feed

AdMedia

Audience

Adikteev

Audience

Event

Adobe Marketing Cloud

Cookie Sync

Event

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

Adobe Target

Audience

AdPredictive

Feed

AgilOne

Event

Algolia

Event

Airship

Audience

Event

Feed

AlgoLift

Feed

Event

Alooma

Event

Amazon Kinesis

Event

Amazon Advertising

Audience

Amazon Kinesis Firehose

Audience

Event

Amazon S3

Event

Amazon Redshift

Data Warehouse

Amazon SNS

Event

Adobe Marketing Cloud

Event

Amazon SQS

Event

Amobee

Audience

Amplitude

Forwarding Data Subject Requests

Event

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Anodot

Event

Antavo

Feed

Apptentive

Event

AppLovin

Audience

Event

Apptimize

Event

Apteligent

Event

Microsoft Azure Blob Storage

Event

Attentive

Event

Feed

Bidease

Audience

Batch

Audience

Event

Attractor

Event

Bing Ads

Event

Bluecore

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Branch

Feed

Event

Forwarding Data Subject Requests

Bugsnag

Event

Cadent

Audience

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Button

Audience

Event

ciValue

Event

Feed

Census

Feed

CleverTap

Event

Feed

Audience

comScore

Event

Conversant

Event

Cordial

Audience

Feed

Cortex

Event

Feed

Forwarding Data Subject Requests

Criteo

Audience

Event

Custom Feed

Custom Feed

Crossing Minds

Event

CustomerGlu

Event

Feed

Customer.io

Audience

Event

Feed

Databricks

Data Warehouse

Datadog

Event

Didomi

Event

Dynalyst

Audience

Dynamic Yield

Audience

Event

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Everflow

Audience

Facebook

Audience

Event

Fiksu

Audience

Event

Facebook Offline Conversions

Event

Google Analytics for Firebase

Event

Flybits

Event

Flurry

Event

ForeSee

Event

Formation

Event

Feed

Foursquare

Audience

Feed

FreeWheel Data Suite

Audience

Google Ad Manager

Audience

Google Ads

Audience

Event

Google Analytics

Event

Google Analytics 4

Event

Google BigQuery

Audience

Data Warehouse

Google Cloud Storage

Event

Audience

Google Enhanced Conversions

Event

Google Marketing Platform

Cookie Sync

Audience

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

Impact

Event

Indicative

Audience

Event

InMarket

Audience

Insider

Audience

Event

Feed

InMobi

Audience

Event

Inspectlet

Event

Intercom

Event

iPost

Audience

Feed

ironSource

Audience

Iterable

Event

Audience

Feed

Jampp

Audience

Event

Kafka

Event

Kayzen

Event

Audience

Kochava

Feed

Forwarding Data Subject Requests

Event

Kissmetrics

Event

Klaviyo

Event

Audience

Kubit

Event

LaunchDarkly

Feed

Leanplum

Audience

Feed

Event

LifeStreet

Audience

LiveLike

Event

Liveramp

Audience

Liftoff

Audience

Event

Localytics

Event

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Audience

Feed

Event

Marigold

Audience

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Mintegral

Audience

Microsoft Azure Event Hubs

Event

Mixpanel

Audience

Forwarding Data Subject Requests

Event

MoEngage

Event

Audience

Feed

Moloco

Event

Audience

Monetate

Event

Movable Ink - V2

Event

Movable Ink

Event

Multiplied

Event

myTarget

Event

Audience

Nami ML

Feed

Nanigans

Event

Narrative

Audience

Event

Feed

Neura

Event

NCR Aloha

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle Responsys

Audience

Event

Oracle BlueKai

Event

Paytronix

Feed

Persona.ly

Audience

Personify XP

Event

PieEye

Inbound Data Subject Requests

Pilgrim

Feed

Event

Pinterest

Audience

Event

Plarin

Event

Postie

Audience

Event

Punchh

Audience

Event

Feed

Primer

Event

Quantcast

Event

Radar

Event

Feed

Regal

Event

Reddit

Audience

Event

Remerge

Audience

Event

Qualtrics

Event

RevenueCat

Feed

Retina AI

Event

Feed

Reveal Mobile

Event

RTB House

Event

Audience

Rokt

Audience

Salesforce Email

Audience

Event

Feed

Sailthru

Audience

Event

Salesforce Mobile Push

Event

Samba TV

Audience

Event

SendGrid

Audience

Feed

Scalarr

Event

ShareThis

Audience

Feed

SessionM

Event

Feed

Signal

Event

Shopify

Custom Pixel

Feed

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Smadex

Audience

Slack

Event

SmarterHQ

Event

Snapchat Conversions

Event

Snapchat

Audience

Event

Snowflake

Data Warehouse

Snowplow

Event

Splunk MINT

Event

Split

Event

Feed

StartApp

Audience

Sprig

Audience

Event

Statsig

Event

Feed

Stormly

Audience

Event

Swrve

Event

Feed

Talon.One

Audience

Feed

Event

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Taptica

Audience

Teak

Audience

The Trade Desk

Audience

Cookie Sync

Event

Ticketure

Feed

TikTok Event

Audience (Deprecated)

Audience

Event

Audience Migration

Treasure Data

Audience

Event

Triton Digital

Audience

Twitter

Audience

Event

TUNE

Event

Valid

Event

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Wootric

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Pushwoosh

Audience

Event

Zendesk

Feed

Event

Quadratic Labs

Event

Audience

The mParticle Facebook Audiences integration allows you to forward mParticle audience data directly to a Facebook Ads Manager account for use with Facebook Custom Audiences, making it easy to target existing or prospective customers.

Prerequisites

Access to a Facebook Ad account

You must have Full Access to the Facebook Ads account you want to forward your audience data to. To check if you have Full Access:

  1. Log into the Meta Business Suite at business.facebook.com
  2. Select the Meta business portfolio you want to send your audience data to.

  1. Go to Settings > Accounts > Ad Accounts, and select the Ad account you want to use. Click Ad account access.
  2. Under “People with full control”, look for the Facebook account you plan to use when setting up the mParticle integration.
  3. To assign full access to someone, click Manage next to their name. You can also assign a new account access by clicking Assign people and selecting their name from the list of people with access to your Meta Business portfolio.

Accept the Facebook Audiences Terms of Service

The Facebook Ads account you are connecting to must have accepted the following terms of service:

  • Custom Audiences Terms of Service
  • Value Based Custom Audience Terms of Service
  • Web Custom Audience Terms of Service

To see if you’ve accepted the terms of service:

  1. Log into your Facebook Ad account at adsmanager.facebook.com and click Audiences in the left nav bar.
  2. Make sure that you have the correct ad account selected using the dropdown menu in the top right.
  3. You should be prompted to accept the Facebook Audience terms of service. If you already have accepted these terms of service, you will be presented with the options to create new audiences:

Access to your Facebook Application ID

If you want to forward users’ Facebook IDs with your audience data, you must have the Facebook Application ID number for your app or integration. To find your Facebook Application ID, you need to access the Facebook Developer Dashboard. To find your Facebook App ID:

  1. Visit the Meta for Developers website at https://developers.facebook.com/ and log in with your Facebook account credentials.
  2. Click My Apps in the top nav bar.
  3. Under the list of apps on your dashboard, you can find your App ID listed under the name of your app:

Once you have satisfied the prerequisites described above, follow the steps below to set up the mParticle Facebook audience integration.

Facebook audience integration setup instructions

Setting up and using the audience integration for Facebook includes three stages:

  1. Creating a Facebook audience output in mParticle.
  2. Connecting an audience in mParticle to Facebook.
  3. Finding your new mParticle audiences in Facebook for use in a campaign.

1) Create Facebook audience output

  1. Log into your mParticle account at app.mparticle.com, and navigate to the Integrations Directory.
  2. Search for “Facebook”, hover your cursor over the Facebook tile, and click Setup.

  1. Check the box labeled Audience, and click Configure.

  1. Under Account Credentials, click Log In. This opens a separate window where you can connect your Facebook account to mParticle. Click Connect.

  1. Enter a descriptive name under Configuration Name.
  2. Use the Facebook Account ID dropdown menu to select the Facebook account that is tied to the Facebook Ads account you want to forward your audiences to.

  1. Click Save & Open in Connections.

2) Connect an audience to Facebook

  1. If you just completed step 1.7, then you will be brought to Audiences > Real-time in mParticle. Otherwise, from your mParticle account, navigate to Audiences in the left-hand navigation and select either Real-time or Standard.
  2. From the list of audiences, find the one you want to forward to Facebook and click the “plus sign” + button under Connected Outputs.

  1. Click Connect Output.

  1. Select Facebook, and use the Configuration Name dropdown menu to select the new configuration you want to send your audience to. Click Next.

  1. Toggle the Connection Status to either Inactive or Active. Only active connections will forward audiences. After completing the setup process, it may take up to 24 hours for your audience data to fully populate in Facebook.
  2. Enter your Facebook Application ID. This is only required if you intend to forward Facebook IDs in the next step.
  3. Check the box next to each of the following user identities you want to forward to Facebook with your audience:

    • Email address (hashed as SHA256)
    • Phone number (hashed as SHA256)
    • Facebook ID
    • Apple IDFA
    • Google GAID

Email addresses and Facebook IDs result in higher match rates with Facebook users because they are more unique across the Facebook platform, so it’s recommended to use these identities whenever they are available.

  1. Check Enable Multi-Key Audience to have an additional audience forwarded to Facebook that includes all of the user identities you selected in the previous step.

    • mParticle creates a new custom audience in your Facebook Ads Manager for each identity that you select. For example, if you select both phone and email, you will see two new custom audiences added: one using user phone numbers and one using their email addresses. If you enable Multi-Key Audiences, you will still see a separate audience for each identity, but you will also see an additional audience that includes all of the identities you selected.
  2. Check Match on User Attributes to have mParticle forward all available attributes from the following list for each user. This can increase the match rate for your audience. All user attributes are hashed as SHA256 before being forwarded to Facebook.

    • Gender
    • First name
    • Last name
    • City
    • State
    • Country
  3. To create a value-based lookalike audience, check Is Value Based Audience, and use the User Attribute Representing Value dropdown menu to select an mParticle user attribute to forward to Facebook.

    • The attribute you select is what Facebook refers to when determining the relative value of a user, and whether or not to include it in the audience. Users with higher values for this attribute are considered more valuable.
    • To allow attributes with a value of 0 to be forwarded, check Allow Zero Values. Negative values are never forwarded.
  4. Under Customer File Source, select one of the following as the source of your audience data:

    • Directly from customers: all audience data was collected directly from the audience members
    • Customers and partners: the audience data was collected both from audience members and from a partner, like a third-party agency
    • Directly from partners: the audience data was collected only from third-party partners
  1. Select the identity you want to forward to Facebook as an external email address from the External Email Identity Type dropdown.

    • Including an external email address can help improve your match rate in Facebook.
  2. Select the identity you want to be hashed and forwarded to Facebook for use as an external unique ID from the Multi-Key External ID Type dropdown.

    • This can be any unique ID, like an advertising ID, loyalty membership ID, user ID, or even a cookie ID, and can help increase your audience’s match rate.
  3. Click Add Connection.

3) Find your new mParticle audience in Facebook

To find your new custom audience(s):

  1. Navigate to your Facebook Ads Manager at adsmanager.facebook.com and log in.
  2. Select the business portfolio containing the ad account that you used when setting up your audience connection using the left-hand navigation.
  3. In the left-hand navigation, click Audiences.
  4. After creating and activating your audience connection between mParticle and Facebook, you will see one or more (depending on your configuration settings) custom audiences added to your Audience list in Facebook Ads Manager.

  1. To edit, share, or create an ad for one of your custom audiences, click the audience name from the list to view the details panel. From the details panel, click the Actions dropdown menu. Certain actions may be unavailable due to missing payment info or a compliance requirement that hasn’t been configured yet for your Ads account.

Deleting an audience

mParticle deletes the downstream audience when you delete an audience from mParticle.

Supported identities

Following are the user identities and device identities that can be forwarded to Facebook. Identities that are hashed as SHA256 are noted.

  • Facebook ID
  • Email address (SHA256)
  • Phone number (SHA256)
  • Apple IDFA (SHA256)
  • Google Advertising ID (SHA256)
  • Android Device ID (SHA256)

Understanding your match rate

The “match rate” for a Facebook audience refers to the percentage of your forwarded user data that Facebook successfully matches to active Facebook users.

When you connect an mParticle audience with Facebook, several user identifiers are included for each audience member (such as email addresses, phone numbers, Facebook user IDs, or mobile advertiser IDs). After you send an audience from mParticle to Facebook, Facebook attempts to match these identifiers to user profiles on Facebook. The match rate indicates how successful Facebook is in finding corresponding user profiles for the identifiers you provided.

There are several factors that can impact your match rate:

  • Data quality: more accurate, up-to-date, and complete user data leads to a higher match rate.
  • Privacy settings: Facebook users with stricter privacy or data sharing settings may also impact your match rate.
  • Identifiers used: certain identifiers, like email addresses and Facebook user IDs, have higher match rates due to their uniqueness.
  • Audience size: larger audiences have higher match rates because of the increased chance in finding matches within the set of Facebook users. Facebook suggests a minimum audience size of 1,000 people for best results.

A higher match rate means that more of your user data was successfully matched to Facebook users, allowing you to reach a larger audience with your ads or other marketing efforts. However, it’s important to keep in mind that not all of your user data may match with Facebook users, and the match rate may vary from one audience to another.

Value-based audiences

You can use the mParticle audiences integration to create value-based lookalike audiences. These audiences target users who share similar characteristics and behaviors with your existing high-value customers.

However, unlike traditional lookalike audiences, which are based solely on demographic or interest similarities, value-based lookalike audiences are generated using an attribute that reflects the monetary value or profitability of your customers. For example, if you select a lifetime value attribute, Facebook will create a lookalike audience composed of users that have a higher lifetime value.

By default, mParticle only forwards users in a value-based audience to Facebook if the value of their “value reprepresenting attribute” is greater than 0. You can include values equaling zero by checking Allow Zero Values when creating your value-based audience.

You can learn more about value-based lookalike audiences in Facebook’s documentation.

Customer File Source Requirements

As of July 2, 2018, Facebook requires that all new audiences disclose whether their data was collected from customers directly, collected from partners, or both. You can provide this information in the connection settings when connecting an audience to Facebook via the Customer File Source setting.

You can learn more about the Customer File Source Requirement in Facebook’s documentation.

Data forwarding

Limits

Facebook does not allow more than 500 custom audiences to be created per Facebook Ads account. If you attempt to forward more than 500 audiences to Facebook, an error will be returned.

Upload frequency

The Facebook Audience integration uses bulk forwarding. This means that instead of forwarding audience data in real time, mParticle adds updates to a queue. By default, mParticle forwards data to Facebook from this queue whenever one of the following conditions is met:

  • 3 hours have passed since the last update
  • At least 75,000 messages are in the queue

Verify and troubleshoot your connection

Before activating your new connection, or when troubleshooting issues, please be aware of the following:

Are you forwarding audience data to the correct Facebook Ads account?

During steps 4-5 of the first stage of the setup process, you connect your Facebook account to mParticle. Make sure that you use a Facebook account that has been granted access to the Facebook Ads account you will forward your audiences to, and make sure that after connecting your Facebook account that you use the Facebook Account ID dropdown menu to select the Facebook Ads account.

It is possible to have access to multiple Ads accounts, so make sure that you selected the correct Ads account when creating your output.

Read Access to a Facebook Ads account for instructions on how to make sure your Facebook account has the correct access. If you do not have the correct access, reach out to your Facebook Ads account administrator.

If you are forwarding Facebook IDs, did you add the correct Facebook app ID?

If you are trying to forward Facebook IDs from mParticle to Facebook, you must provide your Facebook application ID.

Often referred to as an app ID, a Facebook Application ID is a unique ID assigned to your application when you register it on the Facebook Developers platform. This App ID is required to integrate your application with various Facebook functions, such as logging in through Facebook, accessing Facebook’s Graph API, or incorporating social plugins like the Like button.

See Access to your Facebook Application ID for instructions on how to find your application ID.

Data latency

While you may see your forwarded mParticle audiences listed in Facebook Ads right away, it can take up to 24 hours before your audience data begins to fully populate. This time can vary depending on how large your audiences are.

When looking for your audience data in Facebook, select the correct Business Portfolio

After logging into Facebook Ads Manager, make sure that you select the correct Business Portfolio from the left-hand navbar. You should select the Business Portfolio containing the Ads Account you chose to forward your audiences to.

Forwarding multi-key audiences to Facebook creates multiple audiences

When you select more than one user identity to forward to Facebook, a separate audience will be created in Facebook for each identity you select. If you want to have a single audience containing all of the identities you selected, make sure that you check Enable Multi-Key Audiences when connecting your audience to Facebook.

However, even with multi-key audiences enabled, you will still see an additional audience in Facebook for each identity selected.

Settings reference

Configuration Settings

Setting Name Data Type Default Value Description
Facebook Account ID string This setting is your Facebook account id. You can find it in the Ads Powertool.
Facebook AccessToken string The Facebook access token used to make Graph API calls.

Connection Settings

Setting Name Data Type Default Value Description
Forward Emails bool True If enabled, and the user’s e-mail address is available, the SHA-256 hash of that e-mail address will be added to the audience ”<Audience Name> (email)“.
Forward Facebook IDs bool True If enabled, the user’s Facebook ID is available, and the Facebook Application ID property is set, it will be added to the audience ”<Audience Name> (fb id)“.
Forward IDFAs bool True If enabled, and the user’s IDFA is available, it will be added to the audience ”<Audience Name> (IDFA/GAID)“.
Forward Google Advertising IDs bool True If enabled, and the user’s Google Advertising ID is available, it will be added to the audience ”<Audience Name> (IDFA/GAID)“.
Forward Phones bool True If enabled, and the user’s phone number is available, it will be added to the audience ”<Audience Name> (phone)“.
Enable Multi-Key Audience bool False If enabled, all selected identities will also be sent to a single audience for higher match rates.
Match on User Attributes bool False If enabled, mParticle will send all possible user attribute values to Facebook for multi-key matching. See user identity matching for more details.
Facebook Application ID string The App ID found on your Facebook application’s dashboard.
Is Audience Value Based bool False If enabled, the audiences created in Facebook will be value-based.
User Attribute Representing Value string The user attribute to be used as the basis for setting value in Facebook. Only non-negative numbers will be forwarded to Facebook. This setting only applies to value-based audiences.
Allow Zero Values bool False If enabled, user data either missing the above user attribute, or having a user attribute value of zero, will be forwarded to Facebook. This setting only applies to value based audiences.
Customer File Source enum UNSELECTED Indicates whether the information was collected directly from customers, provided by partners or a combination of the two. Starting July 2, 2018, Facebook requires this setting on all new audiences created.
External Email Identity Type enum Email The mParticle User Identity type to forward as an External Email to Facebook.
Multi-Key External ID Type enum None The user identity to be sent to Facebook as the external identity. Note: this identity’s value will have whitespace trimmed, be converted to lowercase, and be hashed prior to sending to Facebook.
    Last Updated: November 27, 2024