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
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
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
Cordova Plugin
Identity
Direct URL Routing FAQ
Web
Android
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
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
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
Dashboard Filters
Organize Dashboards
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 Attributes Overview
Create Predictive Attributes
Assess and Troubleshoot Predictions
Use Predictive Attributes in Campaigns
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
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
Event
Audience
Audience
Event
Feed
Event
Cookie Sync
Audience
Audience
Audience
Audience
Event
Feed
Event
Event
Audience
Event
Data Warehouse
Event
Event
Event
Event
Audience
Event
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Audience
Feed
Event
Event
Event
Custom Feed
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Audience
Event
Audience
Data Warehouse
Event
Event
Cookie Sync
Audience
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Event
Audience
Event
Event
Audience
Event
Event
Event
Audience
Feed
Audience
Event
Event
Audience
Audience
Event
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Audience
Feed
Event
Event
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Event
Data Warehouse
Event
Audience
Audience
Audience
Audience
Event
Audience
Audience
Cookie Sync
Event
Feed
Event
Audience
Event
Audience
Audience
Event
Event
Event
Event
Cookie Sync
Audience
Cookie Sync
Audience
Feed
Audience
Event
Singular has built the only unified marketing intelligence platform that delivers attribution, cost aggregation, creative reporting and workflow automation in one place, giving marketers access to unparalleled data granularity.
This integration was previously available under the name ‘Apsalar’, which was recently acquired by Singular. It also replaces the deprecated Singular event integration. If you are still using the deprecated integration, you can find docs here.
mParticle provides two methods of integrating with Singular: embedded kit and server-to-server.
By including the Singular kit in your mParticle SDK, every Singular feature represented in the mParticle SDK is supported, including deep linking/deferred deep linking.
To use the Deferred Deep Linking functionality, you will need to set a timeout in the Configuration Settings. This defaults to 60 seconds.
You can access the Singular deep link from within your app using mParticle’s deep linking APIs:
[[MParticle sharedInstance] kitInstance:@(MPKitInstanceSingular) completionHandler:^(id _Nullable kitInstance) {
[[MParticle sharedInstance] checkForDeferredDeepLinkWithCompletionHandler:^(NSDictionary<NSString *,NSString *> * _Nullable params, NSError * _Nullable error) {
//check for SINGULAR_DEEPLINK_KEY
}];
}];MParticle.getInstance().checkForDeepLink(new DeepLinkListener() {
@Override
public void onResult(DeepLinkResult result) {
if (result.getServiceProviderId() == ServiceProviders.SINGULAR) {
//handle Singular link
}
}
@Override
public void onError(DeepLinkError error) {
}
});The mParticle-Singular Web Kit enables event forwarding from the mParticle SDK to the Singular SDK.
When this connection is enabled in the mParticle platform, the mParticle SDK will initialize the Singular SDK and forward events.
mParticle forwards events to Singular via their Server-to-Server API. If you choose to forward ‘Launch’ events to Singular, a Launch event will be sent each time a session begins in your app. Singular will interpret the first Launch event for a device as an Install event. All App events, Screenview events and Commerce events will be forwarded. If you are using the mParticle SDKs in your app, standard device information will be forwarded automatically, along with a dictionary of product attributes, for commerce events, or event attributes, for app events and screenviews.
To activate mParticle’s Singular integration, you will need the API Key for each app that you’d like to setup. Please contact your Singular account representative if you need help locating your API Key. To use the embedded kit, you will also need your API Secret.
mParticle forwards events to Singular via their Server-to-Server API. If you choose to forward ‘Launch’ events to Singular, a Launch event will be sent each time a session begins in your app. Singular will interpret the first Launch event for a device as an Install event. All App events, Screenview events and Commerce events will be forwarded. If you are using the mParticle SDKs in your app, standard device information will be forwarded automatically, along with a dictionary of product attributes, for commerce events, or event attributes, for app events and screenviews.
See Singular’s documentation for the latest information about event limitations.
These parameters will be sent automatically with every event.
| Singular Field | mParticle Mapping | Notes |
|---|---|---|
Apple Advertising ID ( idfa ) |
device_info.ios_advertising_id |
Only one of four possible Device IDs is required. |
Apple Vendor ID (idfv) |
device_info.ios_idfv |
Only one of four possible Device IDs is required. |
Android Advertising ID (aifa) |
device_info.android_advertising_id |
Only one of four possible Device IDs is required. |
Android UUID (andi) |
device_info.android_uuid |
Only one of four possible Device IDs is required. |
IP address (ip) |
ip |
Raw IP address for the device. |
Version (ve) |
device_info.os_version or device_info.version_release(android) |
OS version |
Make (ma) |
device_info.device_manufacturer |
Device manufacturer, e.g., ‘Apple’, ‘Samsung’ |
Model (mo) |
device_info.device_model |
Device name, eg, ‘iPhone9,2’ |
Locale Code (lc) |
device_info.locale_language + device_info.locale_country |
Two-part IETF locale code for the device, eg. ‘en_US’ |
OS Build (bd) |
device_info.build_identifier |
OS Build identifier for iOS/tvOS/Android |
Application Longname (i) |
application_info.package |
|
Platform (p) |
device_info.platform |
iOS, tvOS, or Android |
Timestamp (umilisec) |
timestamp_unixtime_ms |
These parameters will be sent automatically with Launch events.
| Singular Field | mParticle Mapping | Notes |
|---|---|---|
Application Name (n) |
application_info.application_name |
|
Do not track (dnt) |
device_info.limit_ad_tracking |
This is enabled if the user has selected ‘limit ad tracking’ in their device options. |
Connection type (c) |
device_current_state.data_connection_type |
cellular or wifi |
Carrier name (cn) |
device_info.network_carrier |
mParticle will forward App events, Commerce Events and Screenview events to Singular with the following attributes.
| Singular Field | mParticle Mapping | Notes |
|---|---|---|
Event Name (n) |
event.data.event_name |
|
Total Amount (amt) |
event.data.product_action.total_amount |
|
Currency Code (cur) |
event.data.currency_code |
|
Event Attributes (e) |
event.data.custom_attributes, event.data.product_action.products |
See below |
Any additional attributes for each event will be forwarded as a JSON object. For Commerce events, a products array will be sent which includes id,
name, brand, category, and quantity for each product. For non-commerce events, any available event attributes will be forwarded.
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| API Key | string |
Your app’s Singular API Key can be found in your dashboard’s SDK page. | |
| Secret | string |
Your app’s Singular API Secret can be found in your dashboard’s SDK page. | |
| Deferred Deeplink Handler Timeout | int |
60 | Deferred deeplink timeout in seconds. If a deferred deeplink is not received within the configured timeout duration, the SDK will not be calling the deferred deeplink handler. |
| Setting Name | Data Type | Description |
|---|---|---|
| Product ID | string |
Required for Web data - A name for your website e.g. com.example.site |