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
Bulk Profile Deletion API Reference
Calculated Attributes Seeding API
Custom Access Roles API
Group Identity API Reference
Data Planning 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
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
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
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
The Developer's Guided Journey to mParticle
API Credential Management
Overview
Overview
User Profiles
Overview
Create and Manage Group Definitions
Calculated Attributes Overview
Using Calculated Attributes
Create with AI Assistance
Calculated Attributes Reference
What are predictive attributes?
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
Usage and Billing Report
The new mParticle Experience
The Overview Map
Observability Overview
Observability User Guide
Observability Troubleshooting Examples
Observability Span Glossary
Key Management
Event Forwarding
Notification Center (Early Access)
System Alerts
Trends
Introduction
Data Retention
Data Catalog
Connections
Activity
Data Plans
Live Stream
Filters
Rules
Blocked Data Backfill Guide
Tiered Events
mParticle Users and Roles
Analytics Free Trial
Troubleshooting mParticle
Usage metering for value-based pricing (VBP)
Audiences Overview
Create an Audience
Connect an Audience
Manage Audiences
FAQ
Real-time Audiences (Legacy)
Standard Audiences (Legacy)
New vs. Classic Experience Comparison
Predictive Audiences Overview
Using Predictive Audiences
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
Introduction
Core Analytics (Beta)
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
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
Audience
Event
Event
Audience
Event
Feed
Audience
Cookie Sync
Server-to-Server Events
Platform SDK Events
Audience
Audience
Audience
Feed
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Event
Audience
Event
Feed
Event
Event
Event
Event
Event
Event
Audience
Event
Event
Feed
Event
Audience
Event
Feed
Event
Event
Custom Feed
Event
Event
Data Warehouse
Audience
Event
Audience
Audience
Event
Event
Event
Audience
Event
Event
Event
Audience
Event
Audience
Event
Event
Data Warehouse
Audience
Event
Event
Audience
Cookie Sync
Event
Event
Event
Event
Feed
Event
Feed
Event
Event
Kit
Audience
Event
Event
Audience
Event
Event
Feed
Event
Audience
Event
Event
Audience
Audience
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Audience
Audience
Event
Feed
Loyalty Feed
Audience
Audience
Event
Audience
Audience
Audience
Cookie Sync
Event
Feed
Audience
Event
Event
Audience
Event
Audience
Event
Event
Event
Cookie Sync
Audience
Audience
Cookie Sync
Feed
Audience
Event
Iterable makes consumer growth marketing and user engagement simple. With Iterable, marketers send the right message, to the right device, at the right time.
Iterable is a multi-channel growth marketing and user engagement platform that powers marketing, transactional, and lifecycle campaigns on email, web and mobile. Iterable requires your application to be collecting email addresses. This can be done by calling the setUserIdentity SDK method.
In order to support Iterable’s features such as deeplinking, push notifications, in-app notifications, and more, you must also include the Iterable Kit as part of your mParticle SDK installation. See Iterable Kit Integration for the Kit’s full feature list and installation instructions.
The Iterable integration supports Android, iOS and Web data. All event data is forwarded server-side, even if the Iterable Kit is installed.
Iterable will not accept data more than 24 hours old.
In order to forward events to Iterable, you must have an account with Iterable. You can sign into your Iterable account at https://app.iterable.com/login/
Create a dedicated Mobile (client-side) API key for the Iterable Event integration:
mparticle-event-integration.If you will be sending push registration events, you will need to provide the Iterable Push Integration names as part of the mParticle configuration. This can be done from Iterable:
mParticle will forward the following identifiers to Iterable where available:
The Iterable integration will automatically map the following mParticle user attributes to corresponding Iterable user attributes:
| mParticle User Attribute | Iterable User Attribute | Description |
|---|---|---|
$Mobile |
phoneNumber |
The user’s mobile phone number. Iterable uses the phoneNumber attribute primarily for sending SMS text messages. For more information, see User Profile Fields Used By Iterable. |
The Iterable integration supports the following event types:
Iterable will map mParticle purchase events to Iterable’s track purchase api call.
An add to cart event is mapped to Iterable’s updateCart commerce event. Iterable does not aggregate partial cart updates. As a result, each outgoing add to cart event from mParticle overwrites a user’s cart contents, so the cart contents in Iterable will only reflect the most recent add to cart event’s product(s).
You can map a custom event to Iterable’s Update User Subscriptions api call. See the Platform Guide for general help with Custom Mappings. The ‘Update Subscriptions’ event takes the following attributes, all optional.
| Attribute Name | Description |
|---|---|
| Subscribed Email Lists | Comma-separated list of all Iterable Email lists that the user is subscribed to. |
| Unsubscribed Channel IDs | Comma-separated list of all Iterable Email channel ids to unsubscribe from. |
| Unsubscribed Message Type IDs | Comma-separated list of all Iterable individual message type ids to unsubscribe. This will not unsubscribe from the associated channel. |
| Campaign ID | Campaign to attribute unsubscribes |
| Template ID | Template to attribute unsubscribes |
Iterable’s client-side mParticle Kit enables the following features:
The Kit automatically handles user registration, push notifications, basic in-app messaging, and deeplinking by mapping mParticle’s APIs to analogous Iterable APIs. To learn more about these API mappings, you can review the source code:
To install the Iterable Kit for iOS:
# Sample Podfile
pod 'mParticle-Iterable', '~> 8.1.0'# Sample Cartfile
github "Iterable/mparticle-apple-integration-iterable" ~> 8.0.2To install the Iterable Kit for Android, add the Kit dependency to your build.gradle file:
// Sample build.gradle
dependencies {
compile 'com.mparticle:android-iterable-kit:5.14.+'
}To learn more about mParticle Kits and how to incorporate them when setting up mParticle’s SDK, please review the mParticle Kit documentation:
If your app includes the Iterable mParticle Kit, mParticle passes Iterable push notifications to the Kit for display. However, for this to work, you must first set up a mobile app and push integration (with associated push credentials) in Iterable.
See mParticle’s Push Notification documentation for more details:
Additional setup:
UNUserNotificationCenterDelegate calls to mParticleInstanceIdService, MPReceiver, MPService to AndroidManifest.xmlFor rich push notification support on iOS, you need to set up a Notification Service Extension. Please refer to the Iterable support documentation on Advanced iOS Push Notifications.
On Android, rich push notifications are automatically supported with the Iterable Kit installed.
In-app notifications are handled automatically by the bundled Iterable SDK. For more details and customization options, please refer to the Iterable documentation:
To handle deeplinks and custom actions from push notifications and in-app messages, you may need to define a urlDelegate (on iOS) or a urlHandler (on Android) on the IterableConfig object.
Whenever you need to pass custom configuration for the Iterable SDK, use the Kit API:
let config = IterableConfig()
config.urlDelegate = self
MPKitIterable.setCustomConfig(config) IterableConfig.Builder configBuilder = new IterableConfig.Builder()
.setUrlHandler(this);
IterableKit.setCustomConfig(configBuilder.build());| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| API Key | string |
API Key used to connect to the Iterable API - see the Integrations section of your Iterable account. | |
| GCM Push Integration Name | string |
GCM integration name set up in the Mobile Push section of your Iterable account. | |
| APNS Sandbox Integration Name | string |
APNS Sandbox integration name set up in the Mobile Push section of your Iterable account. | |
| APNS Production Integration Name | string |
APNS Production integration name set up in the Mobile Push section of your Iterable account. | |
| Coerce Strings to Scalars | boolean |
True | If enabled, mParticle will attempt to coerce string attributes into scalar types (integer, boolean, and float). Note: this setting does not apply to event attributes since mParticle will always attempt to coerce them into scalar types. |
| Setting Name | Data Type | Default Value | Platform | Description |
|---|---|---|---|---|
| User ID | string |
customerId | All | Select which user identity to forward to Iterable as your customer’s user ID. |