Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
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
Data Planning API
Group Identity API Reference
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
AMP SDK
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 FAQ
Web
Android
iOS
Cordova Plugin
Identity
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
Getting Started
Identity
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
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
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
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
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)
Introduction
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
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 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
Dashboards––Getting Started
Manage Dashboards
Organize Dashboards
Dashboard Filters
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
User Aliasing
The Demo Environment
Keyboard Shortcuts
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 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
Create and Manage Group Definitions
Introduction
Catalog
Live Stream
Data Plans
Blocked Data Backfill Guide
Predictive Audiences Overview
Using Predictive Audiences
Predictive Attributes Overview
Create Predictive Attributes
Assess and Troubleshoot Predictions
Use Predictive Attributes in Campaigns
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
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
Snowplow Schema Overview
Snowflake (Snowplow Schema)
Snowflake (Define Your Own Schema)
Aliasing
A DataPoint represents a unique data item that has been detected by our system. A DataPoint can be created by calling methods on our SDK such as logEvent, or they can be created using the Events API. Examples of DataPoints are Screen Views, Purchase Events, Navigation Events and Search events among others. All DataPoints are specific to a particular App.
GET /apps/1/datapoints
Retrieves a list of DataPoints that exist for an App. The 1 after /apps/ is a placeholder for the Application ID.
curl \
-X GET \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
"https://api.mparticle.com/v1/apps/1/datapoints?accountId=1"{
"data": [
{
"name": "my event",
"attribute_name": null,
"type": "Event",
"event_type": "navigation",
"data_type": "datapoint",
"created_on": "2015-06-04T18:11:06.027"
},
{
"name": "my event",
"attribute_name": "my event attribute",
"type": "EventAttribute",
"event_type": "navigation",
"data_type": "datapoint",
"created_on": "2015-06-04T18:53:23.25"
},
{
"name": "my screen view",
"attribute_name": null,
"type": "ScreenView",
"event_type": null,
"data_type": "datapoint",
"created_on": "2015-06-04T18:53:23.25"
},
{
"name": "my screen view",
"attribute_name": "my screen view attribute",
"type": "ScreenViewAttribute",
"event_type": null,
"data_type": "datapoint",
"created_on": "2015-06-04T18:53:23.25"
}
],
"dataType": "datapoint",
"errors": null
}| Name | Description |
|---|---|
| Event | A standard event. |
| EventAttribute | An attribute of an event. |
| UserAttribute | A user attribute. |
| ScreenView | A screen view. |
| ScreenViewAttribute | An attribute of a screen view. |
| Identity | A user identity type. |
| Commerce | A commerce event. |
| CommerceAttribute | An attribute of a commerce event. |
If a DataPoint is of type “Event” or “EventAttribute”, then the EventType field will be populated with one of the following values:
| Name | Description |
|---|---|
| unknown | Unknown Event. |
| navigation | Navigation Event. |
| location | Location Event. |
| search | Search Event. |
| transaction | Transaction Event. |
| user_content | User Content Event. |
| user_preference | User Preference Event. |
| social | Social Event. |
| other | Other Event. |
| media | Media Event. |
If a DataPoint is of type Commerce or CommerceAttribute, then the EventType field will be populated
with one of the following values:
| Name | Description |
|---|---|
| product_add_to_cart | Add to Cart Event. |
| product_remove_from_cart | Remove from Cart Event. |
| product_checkout | Checkout Event. |
| product_checkout_option | Checkout Option Event. |
| product_click | Click Event. |
| product_view_detail | View Detail Event. |
| product_purchase | Purchase Event. |
| product_refund | Refund Event. |
| promotion_view | Promotion View Event. |
| promotion_click | Promotion Click Event. |
PUT /apps/1/datapoints
Adds a new DataPoint for an App.
curl \
-X PUT \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
-H "Content-Type: application/json" \
-d "{\"name\":\"my event\",\"type\":"event",\"event_type\": "navigation"}" \
"https://api.mparticle.com/v1/apps/1/datapoints?accountId=1"[
{
"name": "my event",
"type": "event",
"event_type": "navigation"
}
]Accepts an array of DataPoint objects, which have the following properties:
| Name | Type | Description |
|---|---|---|
| name | string |
The name of the DataPoint. |
| attribute_name | string |
An attribute name (optional). |
| type | enum |
The type of DataPoint. |
| event_type | enum |
Can only be set if DataPoint type is “Event”, “EventAttribute”, “Commerce” or “CommerceAttribute”. |
The “type” field can be set to one of the following values:
| Name | Description |
|---|---|
| Event | A standard event. |
| EventAttribute | An attribute of an event. |
| UserAttribute | A user attribute. |
| ScreenView | A screen view. |
| ScreenViewAttribute | An attribute of a screen view. |
| Identity | A user identity type. |
| Commerce | A commerce event. |
| CommerceAttribute | An attribute of a commerce event. |
The “event_type” field can be set to one of the following values. This field is only required when the “type” is set to “Event” or “EventAttribute”.
| Name | Description |
|---|---|
| unknown | Unknown Event. |
| navigation | Navigation Event. |
| location | Location Event. |
| search | Search Event. |
| transaction | Transaction Event. |
| user_content | User Content Event. |
| user_preference | User Preference Event. |
| social | Social Event. |
| other | Other Event. |
| media | Media Event. |
You can add new DataPoints for an App using the API. DataPoints are automatically detected when data is received from your App, however it may be more convenient to insert this data using the API in advance, rather than waiting until your App is fully instrumented using the mParticle SDK. This will allow you to configure features such as Data Filtering without having to wait for App instrumentation to be completed.
GET /apps/1/GoogleAnalyticsEventForwarder?accountId=1
Get default filtering behavior for a service.
curl \
-X GET \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
"https://api.mparticle.com/v1/apps/1/GoogleAnalyticsEventForwarder?accountId=1"{
"data": [
{
"name": "GoogleAnalyticsEventForwarder",
"sendNewDataPointsByDefault": true
}
],
"dataType": "datapoint",
"errors": null
}This call shows any filtering configuration that exists at the Service level. Currently, this is just one property, "sendNewDataPointsByDefault", which controls whether newly detected DataPoints are sent to this Service by default.
PUT /apps/1/GoogleAnalyticsEventForwarder?accountId=1
curl \
-X PUT \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
-H "Content-Type: application/json" \
-d "{\"sendNewDataPointsByDefault\":false}" \
"https://api.mparticle.com/v1/apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1"{
"sendNewDataPointsByDefault": false
}| Name | Type | Description |
|---|---|---|
| sendNewDataPointsByDefault | bool | Controls whether newly detected DataPoints are sent to this service by default. |
Setting "sendNewDataPointsByDefault" to false will prevent newly detected DataPoints from being sent to the specified Service. Any existing DataPoints will not be affected, and will continue to be sent or filtered based on the existing configuration.
GET /apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1
Retrieve a list of DataPoint filters for a specific App and Service.
curl \
-X GET \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
"https://api.mparticle.com/v1/apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1"{
"data": [
{
"name": "my event",
"attribute_name": null,
"type": "Event",
"event_type": "navigation",
"enabled": true,
"data_type": "datapoint_filter"
},
{
"name": "my event",
"attribute_name": "my event attribute",
"type": "EventAttribute",
"enabled": false,
"event_type": "navigation",
"data_type": "datapoint_filter"
}
],
"dataType": "datapoint_filter",
"errors": null
}Note that this list of DataPoints are filtered by types that are supported by the service. If the service does not support the ScreenView DataPoint for example, then this DataPoint will not appear in the list.
The DataPoint types "EventAttribute", "ScreenViewAttribute", and "CommerceAttribute" are child DataPoints that have a parent DataPoint. In these cases, "attribute_name" will contain the name of the attribute, and "name" will contain the name of the parent.
PUT /apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1
curl \
-X PUT \
-H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
-H "Content-Type: application/json" \
-d "[{\"name\":\"my event\", \"type\":\"event\", \"event_type\": \"navigation\", \"enabled\": true},{\"name\": \"my event\",\"attribute_name\": \"my event attribute\",\"event_type\": \"navigation\",\"type\": \"eventattribute\",\"enabled\": false}]"
"https://api.mparticle.com/v1/apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1"[
{
"name": "my event",
"type": "Event",
"event_type": "navigation",
"enabled": true
},
{
"name": "my event",
"attribute_name": "my event attribute",
"type": "EventAttribute",
"event_type": "navigation",
"enabled": false
}
]Accepts an array of DataPoint Filter objects, which have the following properties:
| Name | Type | Description |
|---|---|---|
| name | string |
The name of the DataPoint. |
| attribute_name | string |
An attribute name (optional). |
| type | enum |
The type of DataPoint. |
| event_type | enum |
Can only be set if DataPoint type is “Event”, “EventAttribute”, “Commerce” or “CommerceAttribute”. |
| enabled | bool |
Set to false to prevent this DataPoint from being sent to this service. |
The "type" field can be set to one of the following values:
| Name | Description |
|---|---|
| Event | A standard event. |
| EventAttribute | An attribute of an event. |
| UserAttribute | A user attribute. |
| EventType | Filter all app events of a particular type. |
| ScreenView | A screen view. |
| ScreenViewAttribute | An attribute of a screen view. |
| UserIdentity | A user identity type. |
| Commerce | A commerce event. |
| CommerceAttribute | An attribute of a commerce event. |
| All_User_Attributes | Used to toggle on/off all user attributes. |
| All_Workspace_User_Attributes | Used to toggle on/off all workspace level user attributes. |
| All_Account_User_Attributes | Used to toggle on/off all account level user attributes, if this feature is enabled. |
If the "type" is set to "UserIdentity", then the "name" field should be set to one of the following allowed values:
| Name | Description |
|---|---|
| CustomerId | Customer Id. |
| Facebook Id. | |
| Twitter Handle. | |
| Google Id. | |
| Microsoft | Microsoft Id. |
| Yahoo | Yahoo Id. |
| Email Address. | |
| Other | Other. |
If the "type" is set to "Event" or "EventAttribute", the "event_type" field can be set to one of the following values. If "type" is set to "EventType", then the "name" field should be set to one of the values below:
| Name | Description |
|---|---|
| unknown | Unknown Event. |
| navigation | Navigation Event. |
| location | Location Event. |
| search | Search Event. |
| transaction | Transaction Event. |
| user_content | User Content Event. |
| user_preference | User Preference Event. |
| social | Social Event. |
| other | Other Event. |
| media | Media Event. |
If the "type" is set to "Commerce" or "CommerceAttribute", the "event_type" field can be set to one of the following values:
| Name | Description |
|---|---|
| product_add_to_cart | Add to Cart Event. |
| product_remove_from_cart | Remove from Cart Event. |
| product_checkout | Checkout Event. |
| product_checkout_option | Checkout Option Event. |
| product_click | Click Event. |
| product_view_detail | View Detail Event. |
| product_purchase | Purchase Event. |
| product_refund | Refund Event. |
| promotion_view | Promotion View Event. |
| promotion_click | Promotion Click Event. |
When configuring DataPoints of type "EventAttribute" or "ScreenViewAttribute" or "CommerceAttribute", you must include the name of the attribute in "attribute_name", and the name of the parent DataPoint in "name".
When configuring DataPoints of type "Event" or "EventAttribute", you must set the "event_type" field. Failure to do so will cause an error to occur. The "event_type" field is ignored for other types of DataPoints other than “Event” and "EventAttribute".
If the DataPoint specified does not exist, it will be created automatically. Please note that to avoid creating duplicate DataPoints unintentionally, "type", "name", "attribute_name" and "event_type" should all be set correctly.
Due to the hierarchical nature of DataPoints, disabling some types of DataPoints will cause child DataPoints to also become disabled automatically. For example, turning off EventType "Navigation" will cause all Events and EventAttributes of that Event Type to become disabled. Turning off an Event will cause all child Event Attributes to become disabled.
Was this page helpful?