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
Cordova Plugin
Identity
Direct URL Routing FAQ
Web
Android
iOS
Getting Started
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
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
Initialization
Content Security Policy
Configuration
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
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
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
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Data Hosting Locations
Compose ID
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 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
This guide is meant for integration partners who would like to add their own SDK or functionality to the mParticle platform. While each integration is unique, we follow a somewhat standard process for getting data from mParticle to our partners client-side.
The mParticle Core Web SDK is responsible for detecting, initializing, and forwarding data to the kit framework. By default, the Core SDK dependency does not include any kits. Individual kits are activated by customers. The kit framework allows you to hook into and listen for mParticle’s public APIs as well as crucial application lifecycle events. It’s the responsibility of the kit implementation to then map those APIs onto the respective partner APIs. Kits often load a 3rd-party SDK dynamically.
At runtime, the Web Core SDK will receive configuration options from the mParticle server, telling it which kits to initialize. In a typical scenario whereby a kit embeds and wraps a 3rd-party SDK, the configuration will include a map of settings, including the API credentials needed by the partner SDK. Customers use the mParticle dashboard to enable kits and provide their credentials.
In order to build and iterate on your kit, there are a few steps to get up and running:
mParticle provides a sample repository that you can fork in order to create your kit integration. To get started, fork and clone down the code. You should push your code to your public repository and work with the mParticle partnerships and engineering team to get your kit released.
Get the example kit implementation here
In your fork you will find a repository with a directory structure as follows. Asterisked files are the only files you will update. Do not touch any code inside the boilerplate files or folders.
mparticle-javascript-integration-example
|
|-- dist/
|–– src/
| |–– *commerce-handler.js
| |–– *event-handler.js
| |–– *identity-handler.js
| |–– *initialization.js
| |–– *session-handler.js
| |–– *user-attribute-handler.js
|–– test/
| |–– boilerplate/
| |–– karma.config.js
| |–– mockhttprequest.js
| |–– test-index.js
| |–– test-karma.js
| |–– end-to-end-testapp/
| |–– build/
| |–– *settings.js
| |–– *index.html
| |–– *tests.js
|–– README.md
Only the files with a * above should be edited in order to build your integration.
It is important to note that your integration should be built using ECMAScript 5 for maximum browser compatibility. For simplicity, we do not use Babel or other transpilers as part of our workflow for integrations.
Each xyz-handler.js
file has comments with more detailed instructions and schemas within them, but generally speaking, for the commerce-handler
, event-handler
, and session-handler
, an mParticle event object is routed through each method, and you must transform these event objects to match a schema that your SDK can ingest. In addition to the comments, we recommend viewing a partner example that we have created, such as the Optimizely Integration.
We use Browserify, which follows a node-like require
syntax, to modularize and compile our code to make creating an integration very easy for you. When necessary, you can create additional utility files in the integration-builder
folder to share across the xyz-handler.js
files. This may be necessary if you have certain settings or functions that need to be shared across files.
Once you have the code downloaded to your computer, open the directory in a command line window, then:
npm install
to install dependenciesKIT=NameOfYourKit npm run watch
, which watches all files in src/
and builds a file at dist/NameOfYourKit-Kit.iife.js
.test/index.html
, change dist/XYZ-Kit.iife.js
to dist/NameOfYourKit-Kit.iife.js
where noted.src/initialization.js
, change name: 'insertSDKNameHere'
to name: 'XYZ'
and fill out initForwarder to load your SDK.Please email partner-integrations@mparticle.com for your kit name
and kit ID
.
mParticle’s Core Web SDK loads via a <head>
tag. The integration you build will load your SDK via a dynamic script tag that gets placed into the header of the client’s webpage. In initialization.js
, modify the code to include the web address to pull your script down, as well as any other code necessary to initialize an instance of your SDK.
Kits should implement this interface in order to listen for eCommerce events. These can include events such as AddToCart
, RemoveFromCart
, PurchaseEvents
and more. A full list of supported mParticle commerce event types can be found here.
Kits should implement this listener to ensure they receive events as they are sent into the mParticle SDK. These can include Page Views or Search events. A full list of supported mParticle page event types can be found here.
Kits should implement this interface when their underlying service has the notion of a user with identities. You can read more about mParticle’s Identity system here.
Kits should implement this interface when their underlying service has the notion of sessions in order for mParticle and your sessions to be more aligned.
Kits should implement this interface when their underlying service has the notion of a user with attributes.
We use the popular frameworks Mocha/Should to test our integrations. Following a live example such as Optimizely is a great way to get started testing your integration before performing end-to-end testing. Some key things to point out:
test/tests.js
, you should stub all methods on your SDK that are called in your integration in the MockXYZForwarder
section.test/index.html
to run your tests and debug.Included in the dependencies of the example repo that you cloned is a framework that allows you to test the mappings you’ve made to your SDK. With this, you can confirm the proper network events are triggered when you log mParticle methods that you mapped. Follow the steps below to properly set up your test app to perform end-to-end testing of your integration before submitting it to mParticle for review and next steps.
test/end-to-end-testapp/settings.js
to include any required settings for SDK initialization. Common settings include an apiKey
that your customers use in order to send it to the proper integration.integration-builder
, run npm run testEndToEnd
. This will build a file that includes your built integration, as well as the settings from step 1 above. A very basic node server will start, and a browser window will open loading the test app as well as your integration and settings that were just built.logEvent method
. If you run mParticle.logEvent('test event')
in the console, you should see a network request triggered sending this event to your SDK in the schema you programmed when building your integration. If your SDK has an admin UI, you can confirm there that data is being sent from mParticle to your SDK successfully.Once you have verified that your integration works properly, there are a few additional steps to publish your kit:
mParticle provides a public API used for simplifying commerce events: mParticle.eCommerce.expandEcommerceEvent(event)
. This will output an array of objects with easy to read mapped items. Common schemas are below
// Purchases Example code:
var productName = 'iPhone',
sku = 'iPhone123'
price = 599,
quantity = 1,
variant = '6S',
brand = 'apple',
position = 'foo-position',
coupon = 'couponCode',
productAttributes = {
color: 'gold',
size: '64gb'
};
var product = mParticle.eCommerce.createProduct(productName, sku, price, quantity, variant, category, brand, position, coupon, productAttributes)
var transactionId = 'tID123',
affiliation = 'foo-affiliation',
couponCode = 'transCouponCode',
revenue = 599,
shipping = 10,
tax = 50;
var transactionAttributes = mParticle.eCommerce.createTransactionAttributes(transactionId, affiliation, transCouponCode, revenue, shipping, tax);
var eventAttributes = {
sale: 'blackFridaySale',
campaign: 'campaign001'
};
mParticle.eCommerce.logPurchase(transactionAttributes, product, false, eventAttributes);
// the above would create a `purchaseEvent` passed to your integration, which you could call the `expandEcommerceEvent` on as follows
var expandedEcommerceItems = mParticle.eCommerce.expandEcommerceEvent(purchaseEvent);
// yields --> expandedEcommerceItems = [
{
EventName: 'eCommerce - purchase - Total',
EventAttributes: {
'Transaction Id': 'tID123',
'Affiliation': 'foo-affiliation',
'Coupon Code': 'transCouponCode',
'Total Amount': 400,
'Shipping Amount': 10,
'Product Count': 1,
'Tax Amount': 8,
'Currency Code': 'foo-currency',
'sale': 'blackFridaySale',
'campaign': 'campaign001'
}
},
...
{
EventName: 'eCommerce - purchase - Item',
EventAttributes: {
'Coupon Code': 'foo-transaction-id',
'Brand': 'foo-affiliation',
'Category': 'foo-couponcode',
'Name': 400,
'Id': 10,
'Item Price': 1,
'Quantity': 8,
'Position': 'foo1',
'OtherProductAttributeKey1': 'fooPA1',
'OtherProductAttributeKey2': 'fooPA2'
}
}]
// if multiple products were purchased, each ensuing product would be similar to expandedEcommerceItems[1] above.
Purchase
events yield what we call a “Plus One” event, (the eCommerce - purchase - Total
object in expandedEcommerceItems[0] above) in addition to each purchase item.
Other eCommerce events map their event names similar to the above in snake case. See here product action types as well as promotion action types. ie:
eCommerce Type | Event Name |
---|---|
Add to Cart | eCommerce - add_to_cart - Item |
Remove from Cart | eCommerce - remove_from_cart - Item |
Checkout | eCommerce - checkout - Item |
Was this page helpful?