Documentation

Developers

API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

Platform API

Platform API Overview

Accounts

Apps

Audiences

Calculated Attributes

Data Points

Feeds

Field Transformations

Services

Users

Workspaces

Warehouse Sync API

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

Client SDKs
AMP

AMP SDK

Android

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

Cordova Plugin

Identity

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Flutter

Getting Started

Usage

API Reference

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

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

Xbox

Getting Started

Identity

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Web

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

Xamarin

Getting Started

Identity

Web

Alexa

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Media SDKs

Android

Web

iOS

Quickstart
Android

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

HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

iOS Quick Start

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

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

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

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Data Hosting Locations

Compose ID

Glossary

Migrate from Segment to mParticle

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

Guides

Getting Started

Create an Input

Start capturing data

Connect an Event Output

Create an Audience

Connect an Audience Output

Transform and Enhance Your Data

Platform Guide
The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Span Glossary

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)

Analytics

Introduction

Setup

Sync and Activate Analytics User Segments in mParticle

User Segment Activation

Welcome Page Announcements

Settings

Project Settings

Roles and Teammates

Organization Settings

Global Project Filters

Portfolio Analytics

Analytics Data Manager

Analytics Data Manager Overview

Events

Event Properties

User Properties

Revenue Mapping

Export Data

UTM Guide

Query Builder

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

Analyses Introduction

Segmentation: Basics

Getting Started

Visualization Options

For Clauses

Date Range and Time Settings

Calculator

Numerical Settings

Segmentation: Advanced

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

Funnels: Basics

Getting Started with Funnels

Group By Settings

Conversion Window

Tracking Properties

Date Range and Time Settings

Visualization Options

Interpreting a Funnel Analysis

Funnels: Advanced

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

Cohorts

Getting Started with Cohorts

Analysis Modes

Save a Cohort Analysis

Export Results

Explore Users

Saved Analyses

Manage Analyses in Dashboards

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey Analysis

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

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

Analytics Resources

The Demo Environment

Keyboard Shortcuts

Tutorials

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

APIs

User Segments Export API

Dashboard Filter API

IDSync

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

Data Master
Group Identity

Overview

Create and Manage Group Definitions

Introduction

Catalog

Live Stream

Data Plans

Data Plans

Blocked Data Backfill Guide

Personalization
Predictive Attributes

Predictive Attributes Overview

Create Predictive Attributes

Assess and Troubleshoot Predictions

Use Predictive Attributes in Campaigns

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

Introduction

Profiles

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Audiences

Audiences Overview

Real-time Audiences

Standard Audiences

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

Journeys 2.0

Warehouse Sync

Data Privacy Controls

Data Subject Requests

Default Service Limits

Feeds

Cross-Account Audience Sharing

Approved Sub-Processors

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

Glossary

Video Index

Analytics (Deprecated)
Identity Providers

Single Sign-On (SSO)

Setup Examples

Settings

Debug Console

Data Warehouse Delay Alerting

Introduction

Developer Docs

Introduction

Integrations

Introduction

Rudderstack

Google Tag Manager

Segment

Data Warehouses and Data Lakes

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)

APIs

Dashboard Filter API (Deprecated)

REST API

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Commerce Events

Collecting accurate “commerce” data is vital if users can purchase any physical or virtual goods in your app. Some important use-cases powered by commerce data include:

  • Identifying users who have a high lifetime value
  • Tracking the success of your advertising campaigns
  • Driving predictive analysis, such as recommendations

The mParticle SDK provides dedicated commerce APIs to collect commerce data in a form that can be usefully passed on to your integrations. mParticle’s commerce data structure closely follows the standard created by the Google Analytics Enhanced Ecommerce API.

Some mParticle partners track commerce data at a granular level, others are only interested in the currency amount of a transaction, while others provide no commerce support at all. mParticle’s commerce schema is designed to be flexible to deterministically map to all integration types.

Tracking Basic Purchases

mParticle’s full commerce feature-set allows you to track a full purchase flow, from promotions, to product impressions, through multiple checkout steps. However, for some use cases it is sufficient to track only the purchase itself.

Basic purchase tracking is a three-step process:

  1. Create the product or products

    • This step creates a representation of each product being purchased
    • At a minimum, products must have a name, an SKU, and a price
    • If multiple units of a product are being purchased, a quantity can be set. If not set, quantity defaults to 1.
    • Like users and events, products can also have a free-form map of custom attributes.
  2. Summarize the transaction details include:

    • (required) Transaction ID- each transaction must have a unique ID
    • Revenue - the total amount of the transaction
    • Shipping - the amount of revenue used for shipping
    • Tax - the amount of revenue collected for taxation.
  3. Log the purchase event - the purchase event includes the products and transaction summary created above, as well as an optional map of custom attributes.
// 1. Create the products
MPProduct *product = [[MPProduct alloc] initWithName:@"Double Room - Econ Rate"
                                                 sku:@"econ-1"
                                            quantity:@4
                                               price:@100.00];

// 2. Summarize the transaction
MPTransactionAttributes *attributes = [[MPTransactionAttributes alloc] init];
attributes.transactionId = @"foo-transaction-id";
attributes.revenue = @430.00;
attributes.tax = @30.00;

// 3. Log the purchase event
MPCommerceEventAction action = MPCommerceEventActionPurchase;
MPCommerceEvent *event = [[MPCommerceEvent alloc] initWithAction:action
                                                         product:product];
event.transactionAttributes = attributes;
[[MParticle sharedInstance] logEvent:event];
// 1. Create the products
let product = MPProduct.init(name: "Foo name",
                             sku: "Foo sku",
                             quantity: 4,
                             price: 100.00)

// 2. Summarize the transaction
let attributes = MPTransactionAttributes.init()
attributes.transactionId = "foo-transaction-id"
attributes.revenue = 430.00
attributes.tax = 30.00

// 3. Log the purchase event
let action = MPCommerceEventAction.purchase;
let event = MPCommerceEvent.init(action: action, product: product)
event.transactionAttributes = attributes
MParticle.sharedInstance().logEvent(event)

Product Events

Product-based commerce events measure all interactions with a product that can lead up to a purchase. Product events can include:

  • tapping or viewing products
  • adding or removing products from a cart or wishlist
  • advancing through a multi-step checkout process
  • purchases
  • refunds

The first step in any product-based event is to create the products. See basic purchase tracking for help creating products.

Once you have your products, there are two paths you can follow. You can build and log events manually, or you can use the dedicated “cart” API to track your purchase flow and let mParticle log events for you.

Create events manually

If you don’t need to track every interaction that leads to a purchase, or if your checkout flow is highly customized, it may be easiest to manually create the events you need. All product events take a product (or list of products), a product “action,” which identifies the action being captured. Purchases and refunds require a transaction attribuges object.

The complete list of possible product actions includes:

  • Add to cart
  • Remove from cart
  • Checkout
  • Checkout option
  • Click
  • View Detail
  • Purchase
  • Refund
  • Add to wishlist
  • Remove from wishlist

You can choose to track all of these actions, or any combination that suits your needs.

Use the Cart API

If your app follows a standard commerce flow, you can use the Cart API to simplify the process of tracking Product events. The Cart is a property of the Current User. The key advantage to using the Cart API is that you don’t need to manually add the same products to each event. Once you add the products to your Cart, they will automatically be included in all product actions logged by the Commerce API.

All products added to the cart are persisted in local storage.

  1. Get the current user to access the cart
  2. Add or remove products to the cart Once products are in your cart, any checkout or purchase events will automatically include the products in your cart. Products stay in the cart until they are removed, purchased, or until persistence is reset or the user changes. When you add or remove events from your cart, an optional second argument boolean determines whether to log an Add to Cart or Remove from Cart event.
  3. Log a Purchase To log the Purchase you need to create the TransactionAttributes object. See basic purchase tracking for an example. You don’t need to include the products, as they are automatically added from the Cart.
// Get the cart
MParticleUser *currentUser = [[[MParticle sharedInstance] identity] currentUser];
MPCart *cart = currentUser.cart;

// Add products to the cart
MPProduct *doubleRoom = [[MPProduct alloc] initWithName:@"Double Room - Econ Rate"
                                                 sku:@"econ-1"
                                            quantity:@4
                                               price:@100.00];
[[cart] addProduct:doubleRoom]; // Generates an Add to Cart event

MPProduct *spaPackage = [[MPProduct alloc] initWithName:@"Spa Package"
                                                 sku:@"Spa/Hya"
                                            quantity:@1
                                               price:@170.00];
[[cart] addProduct:spaPackage]; // Generates an Add to Cart event

// Remove products from the cart
[cart removeProduct:spaPackage]; // Generates a Remove from Cart event

// Sumarize the transaction
MPTransactionAttributes *attributes = [[MPTransactionAttributes alloc] init];
attributes.transactionId = @"foo-transaction-id";
attributes.revenue = @430.00;
attributes.tax = @30.00;

// Log a purchase with all items currently in the cart
MPCommerce *commerce = [[MParticle sharedInstance] commerce];
[commerce purchaseWithTransactionAttributes:attributes
                                  clearCart:YES];
// Create products
let doubleRoom = MPProduct.init(name: "Double Room - Econ Rate",
                             sku: "econ-1",
                             quantity: 4,
                             price: 100.00)

let spaPackage = MPProduct.init(name: "Spa Package",
                             sku: "Spa/Hya",
                             quantity: 1,
                             price: 170.00)

// Get the cart
let currentUser = MParticle.sharedInstance().identity.currentUser
if let cart = currentUser?.cart {
    // Add products to the cart
    cart.addProduct(doubleRoom) // Generates an Add to Cart event
    cart.addProduct(spaPackage) // Generates an Add to Cart event
    // Remove products from the cart
    cart.removeProduct(spaPackage) // Generates a Remove from Cart event
}

// Sumarize the transaction
let attributes = MPTransactionAttributes.init()
attributes.transactionId = "foo-transaction-id"
attributes.revenue = 430.00
attributes.tax = 30.00

// Log a purchase with all items currently in the cart
let commerce = MParticle.sharedInstance().commerce
commerce.purchase(with: attributes,
                  clearCart: true)

Promotion Events

“Promotion” events are used to represent internal offers - such as discounts - that might be displayed in a banner advertisement. Promotion events are created by specifying a promotion action string, and one or more promotions. When constructing a promotion it’s recommended to specify at least an ID or a name.

MPPromotion *promotion = [[MPPromotion alloc] init];
promotion.promotionId = @"my_promo_1";
promotion.creative = @"sale_banner_1";
promotion.name = @"App-wide 50% off sale";
promotion.position = @"dashboard_bottom";

MPPromotionContainer *container =
    [[MPPromotionContainer alloc] initWithAction:MPPromotionActionView
                                       promotion:promotion];

MPCommerceEvent *event =
    [[MPCommerceEvent alloc] initWithPromotionContainer:container];

[[MParticle sharedInstance] logEvent:event];
let promotion = MPPromotion.init()
promotion.promotionId = "my_promo_1"
promotion.creative = "sale_banner_1"
promotion.name = "App-wide 50% off sale"
promotion.position = "dashboard_bottom"

let container = MPPromotionContainer.init(action: MPPromotionAction.view, promotion: promotion)

let event = MPCommerceEvent.init(promotionContainer: container)

MParticle.sharedInstance().logEvent(event)

Impression Events

“Impression” events are used to represent any time one or more products are displayed on the screen. Optionally, you can specify a name for the location or list in which the products appeared.

MPCommerceEvent *event =
    [[MPCommerceEvent alloc] initWithImpressionName:@"suggest products list"
                                            product:product];
[[MParticle sharedInstance] logEvent:event];
let event = MPCommerceEvent.init(impressionName: "suggest products list", product: product)
MParticle.sharedInstance().logEvent(event)

Expanding Commerce Events

mParticle commerce events can capture a transaction including multiple products in a single event. Many of our partners take a different approach and only capture purchases at the level of a product. At the simplest end of the spectrum, some partners are only interested in logging the increase in a user’s lifetime value and capture no product details at all. For this reason, it’s important that both your individual products and the transaction summary are complete and correct.

When instrumenting your app with mParticle, you don’t need to worry about the requirements of individual partners. Capture your purchase events in as much detail as you have and mParticle takes care of transforming the data for each partner. Most commonly, this involves “expanding” a commerce Event. This means automatically creating a new separate event for each product in the original event and copying the shared attributes to each new event.

Commerce events are only expanded if needed:

  • If the event is forwarded using an mParticle SDK with an embedded kit that doesn’t implement logCommerceEvent, then the event is expanded to ensure that no data is lost.
  • If the event is forwarded server-to-server or using an mParticle SDK with an embedded kit that does support logCommerceEvent, then no expansion is needed, and no data is lost.

In addition, the expansion behavior is different depending on the commerce event type:

  • Product commerce events and impression commerce events expand to one event per product.
  • Purchase or refund commerce events add an additional event with the total value.
  • Promotion commerce events expand to one event per promotion action type such as “click” or “view.”

The following tables show the results after expansion:

Product commerce events expand into one event per product with all available key/value pairs.

Beautified Key Name
Event Object Key
Value Type
Expected Values
Event Name n String Example: """eCommerce - %@ - Item"" where %@ is the name of the action type (""add_to_cart"" ""purchase"" ""refund”)"
Event Type et String transaction
Custom Attributes attrs Dictionary Contains all of the following key/value pairs if they are available
Brand Brand String
Name Name String
Id Id String
Item Price Item Price Number
Quantity Quantity Number
Category Category String
Coupon Code Coupon Code String
Variant Variant String
Position Position Integer
Total Product Amount Total Product Amount Number Product Quantity * Product Price
Transaction Id Transaction Id
Custom Keys %@ Any All custom attributes set on the commerce event by the client

Purchase or Refund Commerce Events expand into an additional event with all available key/value pairs.

Beautified Key Name
Event Object Key
Value Type
Expected Values
Event Name n String """eCommerce - %@ - Total"" where %@ is the name of the action type (""purchase"" or ""refund"")"
Event Type et String transaction
Custom Attributes attrs Dictionary Contains all the following key/value pairs if they are available
Currency Code Currency Code String
Product Count Product Count Number
Affiliation Affiliation String
Shipping Amount Shipping Amount Number
Tax Amount Tax Amount Number
Total Amount Total Amount Number
Transaction Id Transaction Id String
Coupon Code Coupon Code String
Product Action List Product Action List String
Product List Source Product List Source String
Checkout Options Checkout Options String
Checkout Step Checkout Step String
Custom Keys %@ Any All custom attributes set on the commerce event by the client

Promotion commerce events expand to an additional event with all available key/value pairs.

Beautified Key Name
Event Object Key
Value Type
Expected Values
Event Name n String """eCommerce - %@ - Total"" where %@ is the name of the promotion action type (""click"" or ""view"")"
Event Type et String transaction
Custom Attributes attrs Dictionary Contains the following key/value pairs if they are available
Promotion List pl Dictionary
Creative Creative String
Name Name String
Position Position String
Id Id String

Impression Commerce events expand to an event for every product in the impression with all available key/value pairs.

Beautified Key Name
Event Object Key
Value Type
Expected Values
Event Name n String eCommerce - Impression - Item
Event Type et String transaction
Custom Attributes attrs Dictionary Contains all the following key/value pairs if they are available
Product Impression List Product Impression List String
Brand Brand String
Name Name String
Id Id String
Item Price Item Price Number
Quantity Quantity Number
Category Category String
Coupon Code Coupon Code String
Variant Variant String
Position Position Integer
Total Product Amount Total Product Amount Number Product Quantity * Product Price
Product Custom Keys %@ Any All custom attributes set on the product by the client
Custom Keys %@ Any All custom attributes set on the commerce event by the client

API Reference

Reference the complete API reference for a deep dive into the commerce APIs.

Was this page helpful?

    Last Updated: December 5, 2024