Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
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
Key Management
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
Audit Logs API
Bulk Profile Deletion API Reference
Custom Access Roles API
Calculated Attributes Seeding API
Data Planning API
Household Reach API Reference
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
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
AMP SDK
Direct URL Routing FAQ
Web
Android
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
Getting Started
Identity
Getting Started
Identity
Upgrade to Version 4
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
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 3 of the SDK
Alexa
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Glossary
Data Hosting Locations
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
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
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 1. Create an input
Step 2. Create an output
Step 3. Verify output
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
API Credential Management
The Developer's Guided Journey to mParticle
Introduction
Navigating mParticle
The Overview Map
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
Overview
Explore Your Data
Build Audiences
Create Predictions
Data and Privacy
mParticle Agent FAQ
System Alerts
Trends
Connections
Feeds
Import Data with CSV Files
CSV File Reference
SFTP Credentials
Live Stream
Data Catalog
Rules
Plans
Filters
Event Forwarding
Event Match Quality
Data Retention
Tiered Events
Blocked Data Backfill Guide
Warehouse Setup Overview
Overview
Overview
User Profiles
Identity Dashboard
Identity Resolution Log
Household Reach
Calculated Attributes Overview
Using Calculated Attributes
Create with AI Assistance
Calculated Attributes Reference
Predictions Overview
What's Changed in the New Predictions UI
View and Manage Predictions
Future Behavior Predictions Overview
Create Future Behavior Prediction
Manage Future Behavior Predictions
Create an Audience with Future Behavior Predictions
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
Overview
Real-Time Personalization
Introduction
Core Analytics (Beta)
Analytics Free Trial
Sync and Activate Analytics User Segments in mParticle
User Segment Activation
Welcome Page Announcements
Project Settings
Roles and Teammates
Organization Settings
Global Project Filters
Portfolio Analytics
Analytics Data Manager Overview
Events
Event Properties
User Properties
Revenue Mapping
Export Data
UTM Guide
Analyses Introduction
Getting Started
Visualization Options
For Clauses
Date Range and Time Settings
Calculator
Numerical Settings
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
Getting Started with Funnels
Group By Settings
Conversion Window
Tracking Properties
Date Range and Time Settings
Visualization Options
Interpreting a Funnel Analysis
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
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––Getting Started
Manage Dashboards
Dashboard Filters
Organize Dashboards
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
The Demo Environment
Keyboard Shortcuts
User Segments
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
Single Sign-On (SSO)
Setup Examples
Introduction
Introduction
Introduction
Rudderstack
Google Tag Manager
Segment
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)
Aliasing
Audiences Overview
Create an Audience
Connect an Audience
Manage Audiences
Audience Insights
Audience Sharing
Match Boost
Inclusive & Exclusive Audiences Overview
Using Logic Blocks in Audiences
Combining Inclusive and Exclusive Audiences
Inclusive & Exclusive Audiences FAQ
Audience Expansion
Probabilistic Reach
Predictive Audiences Overview
Using Predictive Audiences
Composable Audiences Overview
User Guide Overview
Audience Setup
Frequently Asked Questions
Troubleshooting mParticle
Default Service Limits
Glossary
Audience
Event
Audience
Feed
Event
Audience
Cookie Sync
Platform SDK Events
Server-to-Server Events
Audience
Audience
Audience
Event
Feed
Event
Event
Event
Data Warehouse
Event
Audience
Event
Event
Feed
Event
Event
Event
Event
Audience
Event
Feed
Event
Event
Event
Feed
Audience
Event
Event
Event
Custom Feed
Event
Data Warehouse
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Event
Audience
Event
Event
Audience
Data Warehouse
Event
Event
Event
Audience
Cookie Sync
Event
Event
Event
Feed
Feed
Event
Event
Event
Kit
Audience
Event
Event
Audience
Event
Event
Event
Feed
Audience
Audience
Event
Event
Audience
Event
Audience
Audience
Audience
Microsoft Ads Audience Integration
Event
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Feed
Event
Audience
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Audience
Custom Pixel
Feed
Event
Event
Event
Event
Audience
Event
Event
Event
Audience
Data Warehouse
Event
Event
Audience
Audience
Event
Audience
Feed
Loyalty Feed
Audience
Audience
Event
Audience
Cookie Sync
Event
Audience
Feed
Audience
Event
Event
Audience
Audience
Audience
Event
Event
Event
Event
Audience
Cookie Sync
Audience
Cookie Sync
Feed
Audience
Event
OpenAI Ads lets advertisers reach people with ads on OpenAI products. Custom audiences let you target, or exclude, a list of people you already know, such as existing customers or high-value users.
The mParticle OpenAI audience integration sends your mParticle audiences to OpenAI as custom audiences. mParticle creates one custom audience in OpenAI for each audience you connect, then keeps its membership up to date by adding users who enter the audience and removing users who leave it.
To set up the OpenAI audience integration, you need:
OpenAI only allows first-party data that you have the right to use for advertising. Data from data brokers isn’t allowed.
When you save the connection, mParticle creates an empty custom audience in your OpenAI ad account and begins sending audience members to it. If your mParticle audience has a description, mParticle uses it as the description of the OpenAI custom audience.
mParticle manages audience membership only. To use the audience for targeting or exclusion, add it to your campaigns in OpenAI Ads Manager.
OpenAI matches people in a custom audience by email address, phone number, and Google Advertising ID (GAID). For each audience member, mParticle sends every enabled identity that the user has. If a user is missing one identity, mParticle still sends the others.
| Identity | mParticle source | How it’s sent |
|---|---|---|
| The identity selected in Email Identity Type: Email (the default) or one of Other through Other 10 | SHA-256 hashed by default. See Hashing and formatting. | |
| Phone number | The identity selected in Phone Identity Type: Mobile Number (the default), Phone Number 2, or Phone Number 3 | SHA-256 hashed by default. See Hashing and formatting. |
| Google Advertising ID | Google Advertising ID (GAID) | Unhashed, as OpenAI requires. OpenAI hashes it. |
If you select one of the Other identity types for email, make sure that identity holds an email address.
By default, mParticle formats and hashes email addresses and phone numbers before sending them to OpenAI:
+14155552671), then SHA-256 hashed. Phone numbers without a country code are treated as US numbers, so include the country code for phone numbers outside the US. Values that can’t be read as a phone number aren’t sent.If you hash email addresses or phone numbers before sending them to mParticle, set Email Source Format or Phone Source Format to SHA-256 digest hashed upstream. mParticle sends these values to OpenAI unchanged and doesn’t hash them again.
For OpenAI to match pre-hashed values, you must hash them the same way OpenAI does:
A pre-hashed value must be a 64-character hexadecimal SHA-256 hash. mParticle doesn’t send values in any other format, including plain email addresses or phone numbers, when the source format is set to SHA-256.
The OpenAI audience integration uses bulk forwarding. Instead of sending each change to an audience in real time, mParticle queues audience updates and sends them when either of the following conditions is met:
Because of this, it can take several hours for changes in your mParticle audience to appear in OpenAI. Contact your mParticle account representative if you need to discuss upload frequency.
OpenAI applies a minimum matched audience size, based on how many audience members OpenAI can match to its users, not how many members mParticle sends:
If you combine inclusion and exclusion audiences in a campaign, the remaining eligible audience must still meet the minimum. See OpenAI’s custom audiences documentation for details.
OpenAI doesn’t support renaming custom audiences. The name you enter when you connect an audience is fixed when mParticle creates the OpenAI custom audience. Renaming the audience in mParticle doesn’t rename it in OpenAI.
OpenAI doesn’t support deleting custom audiences. When you delete an audience or disconnect it from OpenAI in mParticle, mParticle stops sending updates, but the custom audience remains in your OpenAI ad account. If you no longer need it, you can archive it in OpenAI Ads Manager. Archiving is permanent in OpenAI.
If OpenAI rejects your Ads API Key, for example because the key was revoked, mParticle can’t create audiences or send updates. Create a new Ads API Key in OpenAI Ads Manager and update it in your OpenAI output configuration.
Configuration settings apply to every audience connected to the output configuration.
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Ads API Key | string |
Required. The Ads API key created in OpenAI Ads Manager. | |
| Verify Settings | bool |
True | If enabled, mParticle confirms that your Ads API Key works before it sends audience data to OpenAI. If the key doesn’t work, no data is sent until you update the key. Leave this enabled. |
Connection settings apply to each audience you connect to OpenAI.
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Forward Email | bool |
True | If enabled, sends the identity selected in Email Identity Type as the email identifier. |
| Email Identity Type | enum |
The mParticle identity to send as the email identifier: Email, or one of Other through Other 10 that holds an email address. | |
| Email Source Format | enum |
Plain value | Whether your email values are plain text or already hashed. Select Plain value if you store plain email addresses. mParticle hashes them for you when Hash Identities is enabled. Select SHA-256 digest hashed upstream if you hashed the email addresses before sending them to mParticle. mParticle sends them as they are. See Identities you’ve already hashed. |
| Forward Phone | bool |
True | If enabled, sends the identity selected in Phone Identity Type as the phone identifier. |
| Phone Identity Type | enum |
Mobile Number | The mParticle identity to send as the phone identifier: Mobile Number, Phone Number 2, or Phone Number 3. |
| Phone Source Format | enum |
Plain value | Whether your phone values are plain text or already hashed. Select Plain value if you store plain phone numbers. mParticle hashes them for you when Hash Identities is enabled. Select SHA-256 digest hashed upstream if you hashed the phone numbers before sending them to mParticle. mParticle sends them as they are. See Identities you’ve already hashed. |
| Forward Google Advertising ID | bool |
True | If enabled, sends the Google Advertising ID. OpenAI requires it unhashed and hashes it itself. |
| Hash Identities | bool |
True | If enabled, mParticle SHA-256 hashes plain email addresses and phone numbers before sending them. Values that were hashed upstream are never hashed again. |