Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
Key Management
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
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
Group Identity API Reference
Data Planning API
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
AMP SDK
Cordova Plugin
Identity
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
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
Getting Started
Identity
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 2 of the SDK
Getting Started
Identity
Alexa
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
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
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Data Hosting Locations
Glossary
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
Composable Audiences (Early Access)
Overview
Overview
User Profiles
Overview
Create and Manage Group Definitions
Calculated Attributes Overview
Using Calculated Attributes
Create with AI Assistance
Calculated Attributes Reference
What are predictive attributes?
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
Usage and Billing Report
The new mParticle Experience
The Overview Map
Key Management
Observability Overview
Observability User Guide
Observability Troubleshooting Examples
Observability Span Glossary
Event Forwarding
Notification Center (Early Access)
System Alerts
Trends
Introduction
Data Retention
Data Catalog
Connections
Activity
Data Plans
Live Stream
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 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
Standard Audiences (Legacy)
Predictive Audiences Overview
Using Predictive Audiences
New vs. Classic Experience Comparison
Introduction
Core Analytics (Beta)
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
Export Results from a Funnel
Explore Users 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
Data Privacy Controls
Data Subject Requests
Default Service Limits
Feeds
Cross-Account Audience Sharing
Approved Sub-Processors
Import Data with CSV Files
CSV File Reference
Glossary
Video Index
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
Event
Audience
Event
Feed
Audience
Event
Audience
Audience
Cookie Sync
Server-to-Server Events
Platform SDK Events
Audience
Feed
Event
Audience
Event
Event
Audience
Event
Event
Data Warehouse
Audience
Event
Event
Event
Event
Event
Event
Event
Event
Audience
Event
Event
Event
Feed
Event
Event
Audience
Feed
Event
Event
Custom Feed
Event
Data Warehouse
Event
Event
Audience
Audience
Event
Audience
Audience
Event
Event
Event
Event
Event
Audience
Event
Feed
Event
Audience
Audience
Data Warehouse
Event
Event
Audience
Cookie Sync
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Event
Kit
Audience
Event
Event
Audience
Event
Event
Feed
Event
Audience
Event
Audience
Event
Audience
Event
Audience
Audience
Event
Audience
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Audience
Feed
Event
Event
Event
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Audience
Event
Audience
Feed
Loyalty Feed
Audience
Audience
Event
Audience
Audience
Audience
Cookie Sync
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Event
Event
Event
Cookie Sync
Audience
Audience
Cookie Sync
Feed
Audience
GET /apps/1?accountId=1
curl -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" -X GET https://api.mparticle.com/v1/apps/1?accountId=1{
"data": [
{
"name": "Test App",
"platforms": [
{
"application_id": 1,
"os": "Android",
"access_keys": [
{
"key": "AccessKey",
"secret": null,
"data_type": "token"
}
],
"crash_handling": "AppDefined",
"network_performance": "AppDefined",
"social_mode": "AppDefined",
"profile_merging": false,
"push_attribution_timer": 30,
"last_modified_on": "2014-11-05T20:09:46.577",
"data_type": "platform",
"created_on": "2014-06-11T19:43:48.697"
}
],
"last_modified_on": "2014-06-11T19:43:45.617",
"data_type": "application",
"id": 1,
"created_on": "2014-06-11T19:43:45.617"
}
],
"dataType": "application",
"errors": null
}GET /apps?accountId=1
curl -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" -X GET https://api.mparticle.com/v1/apps?accountId=1{
"data": [
{
"name": "Test App",
"platforms": [
{
"application_id": 1,
"os": "Android",
"access_keys": [
{
"key": "AccessKey",
"secret": null,
"data_type": "token"
}
],
"crash_handling": "AppDefined",
"network_performance": "AppDefined",
"social_mode": "AppDefined",
"profile_merging": false,
"push_attribution_timer": 30,
"last_modified_on": "2014-11-05T20:09:46.577",
"data_type": "platform",
"created_on": "2014-06-11T19:43:48.697"
}
],
"last_modified_on": "2014-06-11T19:43:45.617",
"data_type": "application",
"id": 1,
"created_on": "2014-06-11T19:43:45.617"
}
],
"dataType": "application",
"errors": null
}PUT /apps/1?accountId=1
curl \
-X PUT \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
-H "Content-Type: application/json" \
-d "{\"name\": \"Updated Name\"}" \
"https://api.mparticle.com/v1/apps/1?accountId=1"{
"name": "Test App New Name"
}| Name | Type | Description |
|---|---|---|
| name | string |
The name of the app. |
| Name |
|---|
| App name must be specified. |
POST /apps?accountId=1
curl \
-X POST \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
-H "Content-Type: application/json" \
-d "{\"name\": \"Test App\", \"platforms\":[{\"os\": \"iOS\"},{\"os\": \"Android\"}]}" \
"https://api.mparticle.com/v1/apps?accountId=1"{
"name": "Test App",
"platforms": [
{
"os": "iOS"
},
{
"os": "Android"
}
]
} {
"data": [
{
"name": "Test App",
"platforms": [
{
"application_id": 1,
"os": "iOS",
"access_keys": [
{
"key": "AccessKey",
"secret": "AccessSecret",
"data_type": "token"
}
],
"crash_handling": null,
"network_performance": null,
"social_mode": null,
"profile_merging": true,
"push_attribution_timer": 30,
"last_modified_on": "2015-03-11T12:07:08.077",
"data_type": "platform",
"created_on": "2015-03-11T12:07:08.077"
}
],
"last_modified_on": "2015-03-11T12:07:07.877",
"data_type": "application",
"id": 1,
"created_on": "2015-03-11T12:07:07.877"
}
],
"dataType": "application",
"errors": null
}| Name | Type | Description |
|---|---|---|
| name | string | The name of the app |
| platforms | array | Array of platforms to create for the app in the format of {"os": "iOS"}. Valid values for the “os” field include “iOS”, “tvOS”, “Android”, “MobileWeb”, “Roku”, “Alexa”, “SmartTV”, “FireTV”, and “Xbox” |
| Name |
|---|
| Exceeded app limit. |
| App name already exists. |
| App must have at least one platform selected. |
| App name not specified. |
| Invalid as specified. |
Creating a new app or app platform will generate a new Access Key and Secret for that app platform, which can be accessed through the “access_keys”. Note that this is the only time the Secret is transmitted - subsequent GET requests will only return the Access Key.
DELETE /apps/1?accountId=1
curl \
-X DELETE \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
https://api.mparticle.com/v1/apps/1?accountId=1| Name |
|---|
| Deleting an app that has active platforms is not allowed. |
GET /apps/1/platforms/android?accountId=1
curl \
-X GET \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
"https://api.mparticle.com/v1/apps/1/platforms/android?accountId=1" \{
"data": [
{
"application_id": 1,
"os": "Android",
"access_keys": [
{
"key": "AccessKey",
"secret": null,
"data_type": "token"
}
],
"crash_handling": "AppDefined",
"network_performance": "AppDefined",
"social_mode": "AppDefined",
"profile_merging": false,
"push_attribution_timer": 30,
"last_modified_on": "2014-11-05T20:09:46.577",
"data_type": "platform",
"created_on": "2014-06-11T19:43:48.697"
}
],
"dataType": "platform",
"errors": null
}GET /apps/1/platforms?accountId=1
curl \
-X GET \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
"https://api.mparticle.com/v1/apps/1/platforms?accountId=1"{
"data": [
{
"application_id": 1,
"os": "Android",
"access_keys": [
{
"key": "AccessKey",
"secret": null,
"data_type": "token"
}
],
"crash_handling": "AppDefined",
"network_performance": "AppDefined",
"social_mode": "AppDefined",
"profile_merging": false,
"push_attribution_timer": 30,
"last_modified_on": "2014-11-05T20:09:46.577",
"data_type": "platform",
"created_on": "2014-06-11T19:43:48.697"
}
],
"dataType": "platform",
"errors": null
}PUT /apps/1/platforms/ios?accountId=1
curl \
-X PUT \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
-H "Content-Type: application/json" \
-d "{\"profile_merging\": true,\"push_attribution_timer\": 30,\"crash_handling\": \"ForceCatch\",\"network_performance\": \"ForceTrue\",\"social_mode\": \"FacebookAndTwitter\"}" \
"https://api.mparticle.com/v1/apps/1/platforms/ios?accountId=1"{
"profile_merging": true,
"push_attribution_timer": 30,
"crash_handling": "ForceCatch",
"network_performance": "ForceTrue",
"social_mode": "FacebookAndTwitter"
}| Name | Type | Description |
|---|---|---|
| profile_merging | bool |
Enable or disable profile merging |
| push_attribution_timer | int |
Push attribution timer in minutes |
| crash_handling | string |
“AppDefined” or “ForceCatch” or “ForceIgnore” |
| network_performance | string |
“AppDefined” or “ForceTrue” or “ForceFalse” |
| social_mode | string |
“AppDefined” or “Facebook” or “Twitter” or “FacebookAndTwitter” |
POST apps/1/platforms?accountId=1
curl \
-X POST \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
-H "Content-Type: application/json" \
-d "{\"os\": \"android\",\"profile_merging\": true,\"push_attribution_timer\": 30,\"crash_handling\": \"ForceCatch\",\"network_performance\": \"ForceTrue\",\"social_mode\": \"FacebookAndTwitter\"}" \
"https://api.mparticle.com/v1/apps/1/platforms?accountId=1"{
"os": "android",
"profile_merging": true,
"push_attribution_timer": 30,
"crash_handling": "ForceCatch",
"network_performance": "ForceTrue",
"social_mode": "FacebookAndTwitter"
}{
"data": [
{
"application_id": 1,
"os": "Android",
"access_keys": [
{
"key": "AccessKey",
"secret": "AccessSecret",
"data_type": "token"
}
],
"crash_handling": "AppDefined",
"network_performance": "AppDefined",
"social_mode": "AppDefined",
"profile_merging": false,
"push_attribution_timer": 30,
"last_modified_on": "2014-11-05T20:09:46.577",
"data_type": "platform",
"created_on": "2014-06-11T19:43:48.697"
}
],
"dataType": "platform",
"errors": null
}| Name | Type | Description |
|---|---|---|
| os | string |
Valid values for the “os” field include “iOS”, “tvOS”, “Android”, “MobileWeb”, “Roku”, “Alexa”, “SmartTV”, “FireTV”, and “Xbox” |
| profile_merging | bool |
Enable or disable profile merging |
| push_attribution_timer | int |
Push attribution timer in minutes |
| crash_handling | string |
“AppDefined” or “ForceCatch” or “ForceIgnore” |
| network_performance | string |
“AppDefined” or “ForceTrue” or “ForceFalse” |
| social_mode | string |
“AppDefined” or “Facebook” or “Twitter” or “FacebookAndTwitter” |
| Name |
|---|
| Could not create platform: App does not exist or you do not have access. |
| Invalid os specified. |
| Platform already exists for the specified App. |
Creating a new app or app platform will generate a new Access Key and Secret for that app platform, which can be accessed through the “access_keys”. Note that this is the only time the Secret is transmitted - subsequent GET requests will only return the Access Key.
DELETE /apps/1/platforms/ios?accountId=1
curl \
-X DELETE \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
"https://api.mparticle.com/v1/apps/1/platforms/ios?accountId=1"GET /apps/1/platforms/ios/services?accountId=1
curl \
-X GET \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
"https://api.mparticle.com/v1/apps/1/platforms/ios/services?accountId=1`"{
"data": [
{
"account": "Default Account",
"name": "GoogleAnalyticsEventForwarder",
"isActive": true,
"isVisible": true,
"settings": [
{
"name": "apiKey",
"value": "*********** Key",
"isConfidential": true
}
],
"data_type": "service"
}
],
"dataType": "service",
"errors": null
}PUT /apps/1/platforms/ios/services?accountId=1
curl \
-X PUT \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
-H "Content-Type: application/json" \
-d "{\"account\": \"Default Account\", \"name\":\"GoogleAnalyticsEventForwarder\",\"isActive\":true,\"isVisible\": true,\"settings\":[{\"name\":\"apiKey\",\"value\":\"My Test App Key\"}]}" \
"https://api.mparticle.com/v1/apps/1/platforms/ios/services?accountId=1"{
"account": "Default Account",
"name":"GoogleAnalyticsEventForwarder",
"isActive":true,
"isVisible": true,
"settings":[
{
"name":"apiKey",
"value":"My Test App Key"
}
]
}| Name | Type | Description |
|---|---|---|
| account | string |
The name of the account you wish to configure. |
| name | string |
The name of the service you wish to configure. |
| isActive | bool |
Controls whether data is actually pushed to the service. |
| isVisible | bool |
Whether the service is visible in the UI. |
| settings | array |
Array of setting objects. |
| Name |
|---|
| Specified service not found. |
| Service does not support app platform. |
| Invalid settings entered while updating the service. |
| Provided setting not found. |
| Required setting not provided. |
| Setting value is required. |
To discover what settings are available for each service, you can call https://api.mparticle.com/v1/services?accountId=1 to discover all services and supported settings.
The “account” parameter allows you to forward data to more than one account per service. It is internal to mParticle, and can be set to any name of your choosing. If omitted or set to null, the account name will be set to “Default Account”.
The “isVisible” flag allows you to create services that forward data in the background, but are not visible in the mParticle UI. This allows you to have two active forwarders per combination of app platform and service. This field is not required and will default to true if omitted.
Google Analytics Settings
Google Analytics has a few configuration settings which require additional details to be set. These settings are listed below and are noted with a type of Custom in the services call.:
{
"account": "Default Account",
"name":"GoogleAnalyticsEventForwarder",
"isActive":true,
"isVisible": true,
"settings":[
{
"name":"apiKey",
"value":"My Test App Key"
},
{
"name":"customDimensions",
"value":"[{\"maptype\":\"EventAttributeClass.Name\",\"map\":\"Bitcoins\",\"value\":\"Dimension 3\"}]"
}
]
}Check Google Analytics for additional details on these settings and the limits on the supported custom dimensions and metrics. The value for these settings is a json array containing objects with maptype, map and value. You need to indicate if you are using an Event Attribute or a User Attribute, and then specify the mapping to the Custom Dimension or Custom Metric.
| Field | Description | Notes & examples |
|---|---|---|
| maptype | This indicates if you are passing an event or user attribute into the map. | EventAttributeClass.Name or UserAttributeClass.Name or ProductAttributeClass.Name. |
| map | The name of the event attribute, user attribute or product attribute. The attribute name must match exactly or it will not map correctly. | For example, Bitcoins. |
| value | The custom dimension or custom metric for the mapping. | For example, Dimension 3 or Metric 1 |
Was this page helpful?