Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
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
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
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
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
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
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
API Credential Management
The Developer's Guided Journey to mParticle
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
Event Forwarding
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)
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
Feed
Event
Audience
Cookie Sync
Server-to-Server Events
Platform SDK Events
Audience
Audience
Audience
Feed
Event
Event
Event
Event
Audience
Data Warehouse
Event
Event
Audience
Event
Event
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Audience
Feed
Event
Event
Event
Data Warehouse
Custom Feed
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Event
Event
Audience
Event
Audience
Data Warehouse
Event
Event
Event
Audience
Cookie Sync
Event
Feed
Event
Event
Event
Feed
Event
Event
Audience
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Audience
Event
Event
Audience
Audience
Audience
Event
Audience
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Audience
Event
Feed
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
Loyalty Feed
Feed
Audience
Event
Audience
Audience
Audience
Cookie Sync
Audience
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Event
Event
Event
Cookie Sync
Audience
Audience
Cookie Sync
Feed
Audience
Event
Airship is a Customer Engagement Platform (CXP) that helps you drive loyalty, engagement, and revenue through channels such as mobile apps, email, and SMS. Airship provides push messaging services, including segmentation and targeting capabilities. To learn more about what you can do with Airship, see Airship’s documentation. This integration allows you to set tags in Airship at the channel and named user level, which provides segmentation and targeting capabilities.
Complete the following prerequisites.
In order to forward mParticle audiences to Airship, you will need your App Key and App Secret - one for each App that you are planning to forward audiences to.
To find your Key/Secrets, do the following:
For more information about Airship’s implementations, see Airship’s Getting Started.
For an in-depth definitions of App Keys and Security, see Airship’s App Keys & Security: Security topic.
Create a Tag Group in Airship. The Tag Group is used to distinguish tags set via API from tags created on a device. Follow Airship’s docs to create a Tag Group and record your chosen Group Key. Provide the Group Key as the Tag Group Name in the Connection Settings.
You will need to specify a Tag name which maps to the mParticle audience to complete the setup. The tag is created by mParticle and must be unique for your account.
mParticle sets the tags at Channel level in Airship. Additionally, if you check Enable Named User Tags in your connection settings when connecting an audience to your Airship output, tags are also set at Named User level in Airship based on the Named User ID Type connection setting you select. mParticle sets tags on a Named User using Airship’s REST API.
The Airship audience integration relies on you having an event connection to Airship, so that we can retrieve a channel_id if it doesn’t already exist in the profile.
When forwarding audience data to Airship, mParticle will send the Airship Channel created from a Push Registration Token or auto generated if the token does not exist.
| 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. | |
| Token | string |
Airship generated string identifying the Bearer token. | |
| Domain | enum |
US | The Airship site your credentials belong to, either ‘US’ or ‘EU’. |
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Tag Group Key | string |
The Airship Tag Group Key which tags created will be put under. This is created by you on the Airship Dashboard. | |
| Tag Name | string |
The Airship tag name which represents this mParticle audience in your account. This is created by mParticle. | |
| Enable Named User Tags | boolean |
false |
If enabled, mParticle also sets tags at Named User level in Airship. |
| Named User ID Type | string |
The user identity you want mParticle to forward to Airship as the named user ID. Can be either Other, Hashed email address, or Customer ID. This setting is only applicable if you check Enable Named User Tags. |
All mParticle user attributes are forwarded to Airship as tags, which can be used to further identify and segment your audience.
Most clients prefer for all tags to remain constant if set. However, a tag can be removed manually by invoking removeTag directly on the Airship SDK as shown bellow.
private func removeTag(key: String) {
if (!key.isEmpty) {
Airship.channel.editTags { editor in
editor.remove(key)
}
Airship.channel.updateRegistration()
}
} - (void)removeTag:(nonnull NSString *)key {
if (key && (NSNull *)key != [NSNull null] && ![key isEqualToString:@""]) {
[[UAirship channel] editTags:^(UATagEditor * _Nonnull editor) {
[editor removeTag:key];
[editor apply];
}];
[[UAirship channel] updateRegistration];
}
} UAirship.shared().getChannel().editTags()
.removeTag("some_tag")
.apply();