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

Custom Access Roles API

Bulk Profile Deletion API Reference

Data Planning API

Group Identity API Reference

Calculated Attributes Seeding API

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

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

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Xbox

Getting Started

Identity

Web

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

Xamarin

Getting Started

Identity

Web

Alexa

Media SDKs

iOS

Web

Android

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

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Compose ID

Data Hosting Locations

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

Dashboard Filters

Organize Dashboards

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

Integrations

24i

Event

Abakus

Event

ABTasty

Audience

Aarki

Audience

AdChemix

Event

Actable

Feed

Adikteev

Audience

Event

Adjust

Event

Feed

Adobe Marketing Cloud

Event

Cookie Sync

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

AdMedia

Audience

Adobe Target

Audience

AgilOne

Event

AdPredictive

Feed

Airship

Audience

Feed

Event

Algolia

Event

Alooma

Event

AlgoLift

Feed

Event

Amazon Advertising

Audience

Amazon Kinesis

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Redshift

Data Warehouse

Amazon S3

Event

Amazon SNS

Event

Adobe Marketing Cloud

Event

Amazon SQS

Event

Amobee

Audience

Ampush

Audience

Event

Amplitude

Event

Forwarding Data Subject Requests

Analytics

Audience

Event

Forwarding Data Subject Requests

Anodot

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Antavo

Feed

Apptentive

Event

Apptimize

Event

Apteligent

Event

Attentive

Event

Feed

Attractor

Event

Batch

Event

Audience

Microsoft Azure Blob Storage

Event

Bidease

Audience

Bing Ads

Event

Bluecore

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Branch

Event

Feed

Forwarding Data Subject Requests

Bugsnag

Event

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Button

Audience

Event

Cadent

Audience

Census

Feed

ciValue

Event

Feed

CleverTap

Audience

Event

Feed

comScore

Event

Conversant

Event

Cordial

Audience

Feed

Cortex

Event

Feed

Forwarding Data Subject Requests

Criteo

Audience

Event

Crossing Minds

Event

Custom Feed

Custom Feed

CustomerGlu

Event

Feed

Customer.io

Audience

Event

Feed

Databricks

Data Warehouse

Didomi

Event

Datadog

Event

Dynamic Yield

Event

Audience

Dynalyst

Audience

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Everflow

Audience

Facebook

Audience

Event

Fiksu

Audience

Event

Facebook Offline Conversions

Event

Google Analytics for Firebase

Event

Flybits

Event

ForeSee

Event

AppLovin

Audience

Event

Formation

Event

Feed

Flurry

Event

Google Ad Manager

Audience

Foursquare

Feed

Audience

FreeWheel Data Suite

Audience

Google Analytics

Event

Google Ads

Audience

Event

Google BigQuery

Audience

Data Warehouse

Google Analytics 4

Event

Google Enhanced Conversions

Event

Google Cloud Storage

Audience

Event

Google Marketing Platform

Cookie Sync

Audience

Event

Google Pub/Sub

Event

Google Tag Manager

Event

Google Marketing Platform Offline Conversions

Event

Heap

Event

Herow

Feed

Hightouch

Feed

Hyperlocology

Event

Impact

Event

Ibotta

Event

Indicative

Audience

Event

InMarket

Audience

InMobi

Audience

Event

Insider

Feed

Audience

Event

Inspectlet

Event

iPost

Audience

Feed

Intercom

Event

ironSource

Audience

Jampp

Audience

Event

Iterable

Event

Feed

Audience

Kafka

Event

Kayzen

Event

Audience

Kissmetrics

Event

Klaviyo

Audience

Event

Kubit

Event

Kochava

Event

Feed

Forwarding Data Subject Requests

LifeStreet

Audience

LaunchDarkly

Feed

Leanplum

Audience

Event

Feed

Liftoff

Event

Audience

Liveramp

Audience

Localytics

Event

LiveLike

Event

MadHive

Audience

Mailchimp

Audience

Event

Feed

Marigold

Audience

mAdme Technologies

Event

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mixpanel

Audience

Event

Forwarding Data Subject Requests

Mintegral

Audience

MoEngage

Audience

Event

Feed

Monetate

Event

Moloco

Audience

Event

Movable Ink

Event

Multiplied

Event

Movable Ink - V2

Event

myTarget

Event

Audience

Nanigans

Event

Nami ML

Feed

Narrative

Audience

Event

Feed

Neura

Event

NCR Aloha

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle BlueKai

Event

Persona.ly

Audience

Paytronix

Feed

Oracle Responsys

Audience

Event

Personify XP

Event

PieEye

Inbound Data Subject Requests

Pinterest

Event

Audience

Pilgrim

Event

Feed

Plarin

Event

Postie

Event

Audience

Primer

Event

Punchh

Audience

Event

Feed

Qualtrics

Event

Quantcast

Event

Radar

Event

Feed

Regal

Event

Reddit

Audience

Event

Remerge

Audience

Event

Retina AI

Event

Feed

Reveal Mobile

Event

RevenueCat

Feed

RTB House

Audience

Event

Rokt

Audience

Sailthru

Event

Audience

Salesforce Email

Audience

Feed

Event

Salesforce Mobile Push

Event

Samba TV

Audience

Event

SendGrid

Audience

Feed

Scalarr

Event

ShareThis

Audience

Feed

SessionM

Event

Feed

Shopify

Custom Pixel

Feed

Signal

Event

SimpleReach

Event

Singular

Feed

Event

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Audience

Event

Snapchat Conversions

Event

Snowplow

Event

Snowflake

Data Warehouse

Split

Event

Feed

Splunk MINT

Event

Sprig

Audience

Event

StartApp

Audience

Statsig

Event

Feed

Stormly

Audience

Event

Swrve

Event

Feed

Talon.One

Audience

Event

Feed

Tapad

Audience

Tapjoy

Audience

Taptica

Audience

Taplytics

Event

Teak

Audience

The Trade Desk

Audience

Cookie Sync

Event

TikTok Event

Audience

Audience (Deprecated)

Event

Audience Migration

Ticketure

Feed

Treasure Data

Audience

Event

TUNE

Event

Twitter

Audience

Event

Triton Digital

Audience

Valid

Event

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Wootric

Event

Xandr

Cookie Sync

Audience

Yahoo (formerly Verizon Media)

Cookie Sync

Audience

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Zendesk

Feed

Event

Quadratic Labs

Event

Pushwoosh

Event

Audience

Event

Apptentive’s mobile customer engagement platform empowers you to measure shifts in customer emotion, intelligently engage user segments, and gather actionable feedback through in-app messages, surveys, and ratings prompts.

mParticle’s Apptentive integration is provided via the Apptentive Kits for the mParticle Apple and Android SDKs. This kit-only integration solely supports client-side data forwarding.

mParticle Apptentive Implementation Scenarios

The mParticle SDK allows you to include the Apptentive kit which provides Apptentive interface features, including tools for gathering customer feedback as well as analyzing results at scale.

Engagement:

  • Love Dialogs - An intelligent, flexible prompt that allows you to keep your finger on the pulse of customers and acts as a jump-off point for further engagement, while tracking customer sentiment with a quick yes or no question.
  • Rating Dialogs - Engage the ‘silent majority’ of your customers, requesting ratings and reviews.
  • Surveys - Collect in-app feedback from your customers to make product decisions, measure sentiment while capturing both qualitative and quantitative data.
  • Notes - Drive customer engagement and improve communication through customizable in-app prompts. Use Notes to announce new features, app updates, and more.
  • Message Center - Turn your mobile app into a communication channel with Apptentive’s two-way messaging capability. Gather feedback and communicate directly with customers through the app.

Analysis:

  • Fan Signals™ - Capture, analyze, and act on the feelings of your consumers, building critical emotion data over time. Fan Signals enables customer segmentation tied to categories of emotion to help you predict churn, boost revenue, and retain customers throughout their mobile journey.
  • Customer Insights - Dig into open-ended feedback received across App and Play Store reviews, Message Center conversations, and free-form Survey responses. Through machine learning, Insights identifies and stack ranks significant phrases found across all open-ended feedback, visualizing how your customers feel. Understand the why behind your data.

Supported Features

Apptentive will process the following events forwarded via this integration. However, event attributes will not be available within Apptentive.

  • Custom Events
  • User Attributes
  • Screen Views

Prerequisites

In order to enable mParticle’s integration with Apptentive, you will need your Apptentive App Key and Apptentive App Signature for each respective app and environment which you can get from Apptentive’s API and Development page. If you need assistance to get an account, you can contact your Apptentive representative or reach out here.

Apptentive Kit Integration

The mParticle Apptentive integration requires that you add the Apptentive kit to your iOS or Android app, so that the mParticle SDK initializes and automatically maps mParticle method calls directly to Apptentive method calls. Thus, every feature of the Apptentive SDKs that is in the mParticle SDK is supported, as if you had integrated Apptentive directly.

Add the Apptentive Kit to your iOS or Android app as shown in the following examples.

//Sample Podfile
target '<Your Target>' do
    pod 'mParticle-Apptentive', '~> 6'
end
//Sample build.gradle
dependencies {
    compile ('com.mparticle:android-apptentive-kit:5.+')
}
//Sample build.gradle
dependencies {
    implementation 'com.mparticle:android-apptentive-kit:5+'
}

Apptentive mParticle Configuration

Create an Apptentive Output Configuration in mParticle Dashboard

  1. Select Directory, and click the Apptentive tile.
  2. Click Add Apptentive to Setup.
  3. Select the Output Event Integration Type and click Add to Setup.
  4. Select the Apptentive output configuration group to configure an output event configuration.
  5. Enter a Configuration Name and your Apptentive configuration settings and click Save.

Configure Custom Events, Screen Views and User Attributes to pass to Apptentive in mParticle Dashboard

  1. Select Connections.
  2. Select the Input for the connection definition.
  3. Click Connect Output.
  4. Select the Apptentive configuration.
  5. Enter your connection configuration settings.
  6. Toggle the Status to Sending.
  7. Click Save.

Configure Interactions within Apptentive:

  1. Create a new Apptentive Dashboard or use an existing one.
  2. Be sure to trigger all Events and Screen Views within your app while connected to Apptentive. This will ensure that the kit is set up properly and all Events are available for use within Apptentive. To view which Events have been triggered and are available, go to Interactions then Events on your Apptentive Dashboard.
  3. From the Interactions tab of Apptentive, set up the desired Interaction. Configure the wording, then set targeting using Events and/or Person Custom Data, then Launch.

Note: if launching in a production app, real customers will be eligible to see the Interaction. We recommend testing in a dev app prior to launching in production.

For full details on the Apptentive mParticle integration, please refer to the Apptentive documentation:

After performing these three steps, you’ve successfully added Apptentive to your app. The mParticle SDK will take care of initializing Apptentive and forwarding data to it.

Advanced Topics

Using Message Center

If you choose to use Apptentive’s Message Center, we recommend that you add a feedback button somewhere in your app. Details can be found here:

Interface Customization

By default, Apptentive inherits global app styles. To override those and update the look and feel of Apptentive Surveys and Message Center, use these guides:

Type Detection for User Attributes

By default, each user attribute will be passed as a string, but if detected that it can also be sent as either a boolean or number it will be sent twice with a suffix added to show its type (which can be either “flag” or “number”)

Configuration Settings

Setting Name Data Type Default Value Description
Apptentive App Key string Apptentive App Key, available from the API and Development page in the Apptentive dashboard.
Apptentive App Signature string Apptentive App Signature, available from the API and Development page in the Apptentive dashboard.

Connection Settings

Setting Name Data Type Default Value Platform Description
Initialize Apptentive Immediately bool True iOS Initialize Apptentive Immediately - when disabled, the mParticle SDK will not automatically initialize the Apptentive SDK. You must manually initialize Apptentive using client side APIs.
    Last Updated: November 20, 2024