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
Audit Logs API
Calculated Attributes Seeding API
Bulk Profile Deletion API Reference
Custom Access Roles API
Data Planning API
Household Reach API Reference
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
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
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
Workspace Switching
Linting Data Plans
Troubleshooting the Android SDK
API Reference
Upgrade to Version 5
Upgrade to Version 6
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
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
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
AWS Kinesis (Snowplow)
Advanced Data Warehouse Settings
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
Predictive Audiences Overview
Using Predictive Audiences
Composable Audiences Overview
User Guide Overview
Audience Setup
Frequently Asked Questions
Troubleshooting mParticle
Default Service Limits
Glossary
Event
Audience
Audience
Feed
Event
Audience
Cookie Sync
Server-to-Server Events
Platform SDK Events
Audience
Audience
Event
Audience
Feed
Event
Event
Event
Event
Data Warehouse
Event
Audience
Event
Feed
Event
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Feed
Audience
Event
Event
Custom Feed
Event
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Event
Audience
Event
Audience
Data Warehouse
Event
Audience
Cookie Sync
Event
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Kit
Audience
Event
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Audience
Audience
Event
Event
Audience
Audience
Audience
Event
Microsoft Ads Audience Integration
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Event
Feed
Event
Audience
Event
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Audience
Custom Pixel
Feed
Event
Event
Event
Audience
Event
Event
Data Warehouse
Audience
Event
Event
Event
Event
Audience
Event
Audience
Feed
Loyalty Feed
Audience
Audience
Event
Audience
Audience
Audience
Cookie Sync
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Audience
Event
Audience
Cookie Sync
Event
Event
Audience
Cookie Sync
Feed
Audience
Event
The mParticle plugin allows you to access the mParticle APIs from your app built with Cordova.
cordova plugin add @mparticle/cordova-sdk@5Version 5 of the plugin requires Cordova CLI 12 or later. On iOS, it also requires cordova-ios 8 or later and an iOS deployment target of 15.0 or later. Projects on cordova-ios 7 or earlier need version 4.x of the plugin: see Staying on CocoaPods. To use version 5 in a project that already has an iOS platform on cordova-ios 7 or earlier, run cordova platform rm ios before you add the plugin, then follow the iOS steps below.
The plugin installs the mParticle Apple SDK (the mparticle-apple-sdk Swift package, 9.3.0 up to, not including, 10.0.0) on iOS and com.mparticle:android-core (6.0.0) on Android automatically.
Grab your mParticle key and secret from your app’s dashboard.
The plugin and the mParticle SDK are Swift packages, which cordova-ios 8 adds to the Xcode project for you. The mParticle plugins don’t use CocoaPods. Don’t add any mParticle or Rokt pods or Swift packages yourself: a second copy of the SDK builds, then fails at runtime.
Set the deployment target to iOS 15 or later in config.xml, before you add the iOS platform. cordova-ios 8.1.1 and earlier apply it to the plugins’ Swift packages only when the platform is added.
<platform name="ios">
<preference name="deployment-target" value="15.0" />
</platform>cordova platform add ios@8The mParticle SDK is initialized by calling the start(with:) method within the application(_:didFinishLaunchingWithOptions:) delegate call. Preferably the location of the initialization method call should be one of the last statements in application(_:didFinishLaunchingWithOptions:). The start(with:) method requires an options argument containing your key and secret and an initial Identity request.
Note that it is imperative for the SDK to be initialized in the
application(_:didFinishLaunchingWithOptions:)method. Other parts of the SDK rely on theUIApplicationDidBecomeActiveNotificationnotification to function properly. Failing to start the SDK as indicated will impair it. Also, please do not use GCD’sdispatch_asyncto start the SDK.
cordova-ios 8 generates platforms/ios/App/AppDelegate.swift. Add the start-up code to it. Cordova regenerates platforms/, so keep your copy outside it and copy it in with an after_prepare hook, as the example app does with its hook and AppDelegate.swift. This reapplies your changes before each build or run. Cordova runs only hooks declared in config.xml, so register yours:
<hook type="after_prepare" src="hooks/after_prepare/010_copy_platform_specific_files.js" />import UIKit
import mParticle_Apple_SDK
@main
#if compiler(>=6.1)
@objc @implementation
#else
@_objcImplementation
#endif
extension AppDelegate {
open override func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
let mParticleOptions = MParticleOptions(key: "<<<App Key Here>>>", secret: "<<<App Secret Here>>>")
// Optional - see the Identity page for more information on building this object
let request = MPIdentityApiRequest.withEmptyUser()
request.email = "email@example.com"
mParticleOptions.identifyRequest = request
mParticleOptions.onIdentifyComplete = { (apiResult, error) in
NSLog("Identify complete. userId = %@ error = %@", apiResult?.user.userId.stringValue ?? "Null User ID", error?.localizedDescription ?? "No Error Available")
}
// Start the SDK
MParticle.sharedInstance().start(with: mParticleOptions)
return super.application(application, didFinishLaunchingWithOptions: launchOptions)
}
// Keep the rest of the generated AppDelegate, such as application(_:configurationForConnecting:options:).
}Please see Identity for more information on supplying an MPIdentityApiRequest object during SDK initialization.
Other mParticle kits: cordova-ios 8 links only the Swift packages that plugins declare. To add another kit, wrap its Swift package in a small local plugin: see Other mParticle kits.
Upgrading from 4.x: version 5 takes the iOS SDKs from Swift Package Manager instead of CocoaPods, and needs cordova-ios 8. See Upgrade to Version 5.
MParticleOptions object.start from the onCreate method of your app’s Application class. It’s crucial that the SDK be started here for proper session management. If you don’t already have an Application class, create it and then specify its fully-qualified name in the <application> tag of your app’s AndroidManifest.xml.package com.example.myapp;
import android.app.Application;
import com.mparticle.MParticle;
import com.mparticle.MParticleOptions;
import com.mparticle.identity.IdentityApiRequest;
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// Optional - see the Identity page for more information on building this object
IdentityApiRequest identifyRequest = IdentityApiRequest.withEmptyUser().build();
MParticleOptions options = MParticleOptions.builder(this)
.credentials("REPLACE ME WITH KEY", "REPLACE ME WITH SECRET")
.logLevel(MParticle.LogLevel.VERBOSE)
.identify(identifyRequest)
.build();
MParticle.start(options);
}
}Warning: It’s generally not a good idea to log events in your
Application.onCreate(). Android may instantiate yourApplicationclass for a lot of reasons, in the background, while the user isn’t even using their device.
mparticle.logEvent('Test event', mparticle.EventType.Other, { 'Test key': 'Test value' })var product = new mparticle.Product('Test product for cart', 1234, 19.99)
var transactionAttributes = new mparticle.TransactionAttributes('Test transaction id')
var event = mparticle.CommerceEvent.createProductActionEvent(mparticle.ProductActionType.AddToCart, [product], transactionAttributes)
mparticle.logCommerceEvent(event)var promotion = new mparticle.Promotion('Test promotion id', 'Test promotion name', 'Test creative', 'Test position')
var event = mparticle.CommerceEvent.createPromotionEvent(mparticle.PromotionActionType.View, [promotion])
mparticle.logCommerceEvent(event)var product = new mparticle.Product('Test viewed product', 5678, 29.99)
var impression = new mparticle.Impression('Test impression list name', [product])
var event = mparticle.CommerceEvent.createImpressionEvent([impression])
mparticle.logCommerceEvent(event)mparticle.logScreenEvent('Test screen', { 'Test key': 'Test value' })If you have a high-volume event that you would like to forward to kits but exclude from uploading to mParticle, set a boolean flag per event.
By default, all events upload to the mParticle server unless explicitly set not to.
// Event
var event = new mparticle.Event()
.setName('Test event')
.setType(mparticle.EventType.Other)
.setInfo({ 'Test key': 'Test value' })
.setShouldUploadEvent(false) // Set false to prevent uploading, true or omit to upload
mparticle.logMPEvent(event)
// Commerce Event
var product = new mparticle.Product('Test product for cart', 1234, 19.99)
var transactionAttributes = new mparticle.TransactionAttributes('Test transaction id')
var commerceEvent = mparticle.CommerceEvent.createProductActionEvent(mparticle.ProductActionType.AddToCart, [product], transactionAttributes)
commerceEvent.setShouldUploadEvent(false) // Set false to prevent uploading, true or omit to upload
mparticle.logCommerceEvent(commerceEvent)Was this page helpful?