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
Custom Access Roles API
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
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
Cordova Plugin
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
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
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
Export Results from a Funnel
Explore Users 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
Event
Audience
Event
Audience
Feed
Event
Audience
Cookie Sync
Event
Audience
Audience
Audience
Feed
Event
Event
Event
Audience
Event
Data Warehouse
Event
Event
Event
Event
Audience
Event
Event
Event
Feed
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Feed
Audience
Event
Event
Custom Feed
Event
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Audience
Event
Event
Audience
Data Warehouse
Event
Audience
Cookie Sync
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Audience
Event
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Audience
Event
Event
Audience
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Audience
Cookie Sync
Audience
Feed
Event
Audience
Audience
Event
Audience
Event
Event
Event
Cookie Sync
Audience
Audience
Cookie Sync
Feed
Audience
Event
Event
Event
Airship helps you drive loyalty, engagement, and revenue in your app and beyond. Airship provides push messaging services, including segmentation and targeting capabilities.
For more information about Airship’s implementations, see Airship’s Getting Started Guide.
mParticle supports two methods for sending event data to Airship:
mParticle’s client-side Kit integrations for iOS and Android were built in partnership with Airship and support the full feature-set of the Airship platform. The integration will bundle Airship’s native SDK as an add on to the mParticle core SDKs, and as with all integrations allows for server-side dynamic enable/disable, configuration, and filtering.
The Kit integrations perform the following automatically by mapping mParticle’s APIs onto the analogous Airship APIs:
The source code to each kit is available if you would like to learn exactly how the above mappings occur:
The features above can be leveraged entirely via mParticle’s APIs. All other features of the Airship SDK, such as the message-center, are still supported by the kit integration by making direct API calls to the Airship SDK.
This step will add the mParticle SDK (if not present already), the Airship SDK, along with the Airship kit, which acts as a bridge between the two SDKs. See the iOS and Android examples below, and reference the Apple SDK and Android SDK GitHub pages to learn more about kits.
If you’re using CocoaPods, add the following to your app’s Podfile:
pod 'mParticle-UrbanAirship', '~> 8'
Or if you’re using SPM, using the standard Xcode interface to add the following package to your project:
https://github.com/mparticle-integrations/mparticle-apple-integration-urbanairship
Add the following to your app’s build.gradle file:
dependencies {
compile ('com.mparticle:android-urbanairship-kit:5.+')
}
In the Airship platform:
Create a new app if necessary, or use an existing app.
Note: Part of Airship’s wizard for setting up a new app involves sending a test message to your app. This process assumes you are using the regular Airship SDK instead of mParticle. You will not receive a test message in your app at this stage but, in order to proceed with setting up your app, you need to ‘confirm’ that you received the test push notification, when asked by the setup wizard.
For an in-depth definitions of App Keys and Security, see Airship’s App Keys & Security: Security topic.
The steps accomplish the equivalent of Airship’s quickstart guide - after this you’ll be setup to track session, events, and much more!
As long as the Airship Kit is included in your app, mParticle will pass any Push Notifications from Airship to the kit for display. However, you will need to provide credentials in the Airship dashboard.
See the main Push Notification documentation for more detail for the various platforms:
For Android push notifications you will need to provide your Server Key to Airship. See Airship’s Android Push Notifications documentation for more information.
For iOS push notifications you will need to upload your APNs Push SSL certificate to Airship. See the Airship’s iOS Push Notifications documentation for more information.
In case you’re integrating with Airship and need to implement a Service Extension for user notifications, please refer to this Airship’s Extension’s Documentation.
Airship tags can be used to easily group your users. Use them to track categories of interest, preferences, user behaviors and more. Each device can have multiple tags, and each tag can represent millions of devices.
mParticle has directly analogous user attribute and tag APIs, which mParticle’s kit integration maps onto Airship’s tag APIs. If there are some attributes that you would not like to map as tags, you may filter them individually via mParticle’s data filtering.
The mParticle kit integration can automatically set Airship tags when particular events and/or event attributes are detected. When enabling and configuring Airship, you may select the events that you’ve sent to mParticle in the past, and customize exactly which tag(s) those events should trigger. In the screenshot below, when an event named “Map View” is fired, mParticle will set the tag “my tag” within the Airship platform and when an event attributed named “Transaction Id” is seen, mParticle will set the tag “transaction”.
The S2S integration will forward Commerce, and Custom event types captured through the mParticle web SDK to Airship and allows for server-side dynamic enable/disable, configuration, and filtering.
The S2S integration will not create users in Airship. When data is sent to Airship without a known Named User you will not see these events or users in your Airship account.
Event Filters in mParticle will show all events supported between kit and S2S integrations. Because the S2S integration sends a subset of these events, only filters set on S2S-supported events will affect the forwarded data.
To configure an S2S integration, simply configure the connection according to the settings below.
Mapping of mParticle events to Airship events occurs automatically in both kit and S2S implementations. mParticle eCommerce events are mapped to Airship events as follows:
mParticle Product Action Event | Airship Mapped Name |
---|---|
Purchase | purchased |
Add To Cart | added_to_cart |
Click | browsed |
Add to Wishlist | starred_item |
If your Airship configuration uses the same App Key for Mobile and Web, all 3 configuration settings are required.
If your Airship configuration is for Web only, enter an App Key, and enable the This App Key is for Web only in my Airship Setup.
setting.
Setting Name | Data Type | Default Value | Description |
---|---|---|---|
App Key | string |
Airship generated string identifying the app setup. Used in the application bundle. | |
App Secret | string |
Airship generated string identifying the app setup secret. Used in the application bundle, and only used for Mobile configurations. | |
Domain | enum |
US | The Airship site your credentials belong to, either ‘US’ or ‘EU’. |
App Key is for Web | boolean |
false | If enabled, this configuration will only be used for Web configurations. |
Setting Name | Data Type | Default Value | Platform | Description |
---|---|---|---|---|
Token | string |
All | Airship generated string identifying the Bearer token. | |
Notification Icon Name | string |
Application Icon | Android | Name of the drawable resource to use for the notification icon, for example, ic_notification. |
Notification Accent Color | string |
System default | Android | Accent color to be used when constructing the notification, for example, #ff0000. |
Named User ID Type | string |
All | Set to “None,” “Other,” “Hashed e-mail address,” or “Customer ID” to define which identity to send to Airship. If a request does not include the Named User ID Type it will be dropped. Airship will return an error if ‘Other’ is selected but the ‘Other’ identity is not present in the event batch | |
Event Names that map to User Tags | Custom Field |
All | Define the mapping of mParticle event names to the corresponding Airship tags. | |
Event Attributes that map to User Tags | Custom Field |
All | Define the mapping of mParticle event attributes to the corresponding Airship tags. | |
Enable Tags | bool |
True | All | If enabled, tags will be sent to Airship. |
Send all user attributes as tags | bool |
False | All | If enabled, all user tags and user attributes will be forwarded to Airship as tags. If not enabled, only user tags will be forwarded to Airship. This setting is dependent on the value of the ‘Enable Tags’ setting. |