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
Custom Access Roles API
Bulk Profile Deletion API Reference
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
Cordova
Cordova Plugin
Identity
Direct Url Routing
Direct URL Routing FAQ
Web
Android
iOS
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
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
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
Python Quick Start
Step 1. Create an input
Step 2. Create an output
Step 3. Verify output
Server SDKs
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
Guides
Partners
Introduction
Outbound Integrations
Outbound Integrations
Firehose Java SDK
Inbound Integrations
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
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
Saved Analyses
Manage Analyses in Dashboards
Dashboards
Dashboards––Getting Started
Manage Dashboards
Dashboard Filters
Organize Dashboards
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
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
Warehouse Sync
Data Privacy Controls
Data Subject Requests
Default Service Limits
Feeds
Cross-Account Audience Sharing
Approved Sub-Processors
Import Data with CSV Files
Import Data with CSV Files
CSV File Reference
Glossary
Video Index
Analytics (Deprecated)
Identity Providers
Single Sign-On (SSO)
Setup Examples
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)
Developer Basics
Aliasing
Integrations
24i
Event
Abakus
Event
ABTasty
Audience
Aarki
Audience
AdChemix
Event
Actable
Feed
Adobe Marketing Cloud
Event
Cookie Sync
Adobe Audience Manager
Audience
Adobe Campaign Manager
Audience
AdMedia
Audience
Adobe Target
Audience
AgilOne
Event
AdPredictive
Feed
Algolia
Event
Alooma
Event
Amazon Advertising
Audience
Amazon Kinesis
Event
Amazon Redshift
Data Warehouse
Amazon S3
Event
Amazon SNS
Event
Adobe Marketing Cloud
Event
Amazon SQS
Event
Amobee
Audience
Anodot
Event
Antavo
Feed
Apptentive
Event
Apptimize
Event
Apteligent
Event
Attractor
Event
Microsoft Azure Blob Storage
Event
Bidease
Audience
Bing Ads
Event
Bluecore
Event
Bluedot
Feed
Branch S2S Event
Event
Bugsnag
Event
Cadent
Audience
Census
Feed
comScore
Event
Conversant
Event
Crossing Minds
Event
Custom Feed
Custom Feed
Databricks
Data Warehouse
Didomi
Event
Datadog
Event
Dynalyst
Audience
Edge226
Audience
Emarsys
Audience
Epsilon
Event
Everflow
Audience
Facebook Offline Conversions
Event
Google Analytics for Firebase
Event
Flybits
Event
ForeSee
Event
Flurry
Event
Google Ad Manager
Audience
FreeWheel Data Suite
Audience
Google Analytics
Event
Google BigQuery
Audience
Data Warehouse
Google Analytics 4
Event
Google Enhanced Conversions
Event
Google Marketing Platform
Cookie Sync
Audience
Event
Google Pub/Sub
Event
Google Tag Manager
Event
Google Marketing Platform Offline Conversions
Event
Heap
Event
Herow
Feed
Hightouch
Feed
Hyperlocology
Event
Impact
Event
Ibotta
Event
InMarket
Audience
Inspectlet
Event
Intercom
Event
ironSource
Audience
Kafka
Event
Kissmetrics
Event
Kubit
Event
LifeStreet
Audience
LaunchDarkly
Feed
Liveramp
Audience
Localytics
Event
LiveLike
Event
MadHive
Audience
Marigold
Audience
mAdme Technologies
Event
MediaMath
Audience
Mediasmart
Audience
Microsoft Azure Event Hubs
Event
Mintegral
Audience
Monetate
Event
Movable Ink
Event
Multiplied
Event
Movable Ink - V2
Event
Nanigans
Event
Nami ML
Feed
Neura
Event
NCR Aloha
Event
OneTrust
Event
Oracle BlueKai
Event
Persona.ly
Audience
Paytronix
Feed
Personify XP
Event
Plarin
Event
Primer
Event
Qualtrics
Event
Quantcast
Event
Regal
Event
Reveal Mobile
Event
RevenueCat
Feed
Rokt
Audience
Salesforce Mobile Push
Event
Scalarr
Event
Shopify
Custom Pixel
Feed
Signal
Event
SimpleReach
Event
Singular-DEPRECATED
Event
Skyhook
Event
Slack
Event
Smadex
Audience
SmarterHQ
Event
Snapchat Conversions
Event
Snowplow
Event
Snowflake
Data Warehouse
Splunk MINT
Event
StartApp
Audience
Tapad
Audience
Tapjoy
Audience
Taptica
Audience
Taplytics
Event
Teak
Audience
The Trade Desk
Audience
Cookie Sync
Event
Ticketure
Feed
TUNE
Event
Triton Digital
Audience
Valid
Event
Vkontakte
Audience
Vungle
Audience
Webhook
Event
Webtrends
Event
White Label Loyalty
Event
Wootric
Event
Xandr
Cookie Sync
Audience
Yahoo (formerly Verizon Media)
Cookie Sync
Audience
Yotpo
Feed
YouAppi
Audience
Quadratic Labs
Event
Audience
BigQuery is Google’s fully managed, petabyte scale, low cost analytics data warehouse.
Enable the Connection
- Enable BigQuery in your project in Google Cloud Platform.
- From the IAM page for your project, add
mparticle-gcp-clientfacing@gcp-prod-170221.iam.gserviceaccount.comas a member with the role of Project Viewer.
-
From the BigQuery page for your project:
- Create a dataset for your app data to be loaded into.
- Click on Share Dataset on the dataset page.
- Add
mparticle-gcp-clientfacing@gcp-prod-170221.iam.gserviceaccount.comwith the “BigQuery Data Editor” role.
- Connect your audience from the Audiences page in the mParticle dashboard. You’ll need to enter your BigQuery Project ID and Dataset ID.
- This step is optional, if you want to sync data downstream using Storage API instead of Streaming API. The default
Use Storage API Data Syncconfiguration setting is set to false and mParticle uses Streaming API endpoint for data sync. However, if you wish to use Storage API, you must first enable access to Storage API in your Google project and then set theUse Storage API Data Syncconfiguration setting in mParticle totrue.
BigQuery Schema
All of your audience data is stored in a single BigQuery dataset. Multiple audiences can be sent to each dataset. The data sent to BigQuery is not the current state for the audience, but changes to the audience over time as users are added and removed.
For each audience, mParticle creates one table per week, showing all users added to, or removed from the audience each week. Table names are in the format {Audience Name}_{Audience ID}_{Beginning of the week in yyyyMMdd format}. Audience name is either audience or the external audience name depending on the Use External Audience Name in Table Name setting. If a table with the configured name does not exist, a new table will be created the next time memberships are uploaded.
For example, if your audience ID is 7185 and the external audience name is New Users Low Engagement,
- If
Use External Audience Name in Table Nameisunchecked, data for the week beginning on March 1, 2020 will be written to a table namedaudience_7185_20200301. - If
Use External Audience Name in Table Nameischecked, data for the week beginning on March 1, 2020 will be written to a table namednewuserslowengagement_7185_20200301.
To find the ID of an audience in the mParticle Dashboard, look for your audience name in the Audiences summary page.
Table fields
| Field Name | Data Type | Description |
|---|---|---|
androidid |
string |
Android ID |
audienceid |
int |
ID of the Audience |
audiencename |
string |
External Name of the Audience |
customerid |
string |
Customer ID |
email |
string |
|
facebookid |
string |
Facebook ID |
googleaid |
string |
GAID (Google Advertising ID) |
googleuserid |
string |
Google User ID |
idfa |
string |
IDFA (Apple Advertising ID) |
idfv |
string |
IDFV (Apple Vendor ID) |
isadd |
bool |
true for a user added to an audience. false for a user removed |
microsoftid |
string |
Microsoft ID |
mpid |
int |
mParticle ID |
otheruserid |
string |
Other User ID |
otheruserid2 |
string |
Other User ID 2 |
otheruserid3 |
string |
Other User ID 3 |
otheruserid4 |
string |
Other User ID 4 |
otheruserid5 |
string |
Other User ID 5 |
otheruserid6 |
string |
Other User ID 6 |
otheruserid7 |
string |
Other User ID 7 |
otheruserid8 |
string |
Other User ID 8 |
otheruserid9 |
string |
Other User ID 9 |
otheruserid10 |
string |
Other User ID 10 |
pushtoken |
string |
Push Token |
rokuaid |
string |
Roku Advertising ID |
rokupublisherid |
string |
Roku Publisher ID |
fireadvertisingid |
string |
Fire Advertising ID |
timestamp |
string |
Unix timestamp for the update |
twitterid |
string |
Twitter ID |
userattributes |
string |
A list of user attribute name and value pairs |
userattributes.attributename |
string |
The name of an attribute |
userattributes.attributevalue |
string |
The value of an attribute |
yahooid |
string |
Yahoo ID |
Customer ID Only Option
You can opt to only send Customer ID to BigQuery by checking Only Send Customer ID in the Configuration Settings
Sample Query for Audience Membership
You can run a query similar to the following to get audience membership at a given point in time.
-- selects only mPIDs added based on latest timestamp for each distinct mPID
WITH t1 AS
(
SELECT DISTINCT mpid, MAX(timestamp) AS max_timestamp, isadd
FROM `{BQ Project}.{BQ Dataset}.audience_{audience_id}_*`
GROUP BY mpid, timestamp, isadd
)
SELECT count(mpid)
FROM t1
WHERE isadd = trueSample Query for RECORD Data Types
You can run a query similar to the following to properly query on fields mParticle schema defines as RECORD, since they can be have multiple values such as device identifiers:
-- selects IDFA from the table, querying over all weekly tables
SELECT idfaid.id AS IDFA
FROM `{project_id}.{data_set}.audience_{audience_id}_*`, UNNEST(idfa) idfaidUpload Frequency
The BigQuery Audience Integration uses Bulk Forwarding. Bulk Forwarding means that, instead of uploading updates to an audience in real time, mParticle compiles updates into a queue until either a given amount of time has passed since the last upload, or until a certain number of updates are waiting to be sent.
By default, mParticle uploads to BigQuery whenever at least one of the following conditions is met:
- At least 50000 messages are in the queue.
- 15 minutes have passed since the last update.
Upload frequency can sometimes be adjusted. Reach out to your mParticle Customer Success Manager if you need to discuss upload frequency.
Deleting an Audience
mParticle doesn’t delete the downstream audience when you delete an audience in mParticle.
Configuration Settings
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| BigQuery ProjectId | string |
ProjectID for your BigQuery project. | |
| BigQuery DatasetId | string |
Target dataset for audience data | |
| Only Send Customer ID | bool |
false |
If enabled, only the Customer ID and no other identites will be forwarded. |
| Use External Audience Name in Table Name | bool |
false |
If enabled, BigQuery table name starts with audience external name; otherwise starts with “audience”. See here for more details. Note: if a table with the configured name does not exist, a new table will be created. |
| Send External Audience Name as Column | bool |
false |
If enabled, a column that has the value of the external audience name will be added to all new tables. |
| Send Anonymous Users | bool |
false |
If enabled, users that are only identified by their mParticle ID will be sent. |
| Send User Attributes | bool |
false |
If enabled, user attribute values will be forwarded. |
| Use Dataset Default Expiration | bool |
false |
If enabled, BigQuery tables will use the dataset’s default expiration. Otherwise, tables will not expire. |
| Use Storage API Data Sync | bool |
false |
If enabled, data will be synced with the Storage API endpoint. Otherwise data will be synced with the Streaming API. |
Connection Settings
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Identities to Exclude | List |
An optional setting allowing one to indicate which user and device identities to exclude in outgoing data. |
- Last Updated: November 20, 2024