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
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
Getting Started
Identity
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
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
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
Getting Started
Identity
Web
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
Data Hosting Locations
Compose ID
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
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
Explore Users from a Funnel
Export Results 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
We started this tutorial by creating an input using the Higgs Shop sample app, setting up a webhook output, and creating a connection between the two. We then learned how to collect data about specific events.
If the Higgs Shop were a real app, these events would be triggered by users. Building an understanding of who these users are and how they’re interacting with the app is the final piece of our data puzzle.
We track users with IDSync, mParticle’s identity resolution and management tool. IDSync provides three main benefits:
IDSync accepts requests from the Android SDK to identify the current user of your app. These requests include any available identifiers (either from cookies or the browser’s local storage) that are used to search for a matching user profile in mParticle. If there is a match, then the found profile is attributed with the data collected during the current session. If a match isn’t found, the user remains anonymous and any future events they trigger are attributed to an anonymous profile.
There are several components and concepts involved in identity resolution:
All users are considered to be either known or anonymous. A known user has an existing profile containing a login ID. For example, a user who has already created an account using a login ID is considered known.
An anonymous user does not have a profile with a login ID. In other words, a user could have previously used your app, generating data attributed with a profile, but if they didn’t created an account using a login ID they are considered anonymous.
The process of identifying users (a process often referred to as “identity resolution”) involves three steps:
An identify call is made, passing in any available identifiers. These might be identifiers like a device ID stored within the browser’s local storage or a cookie, or they could be a login ID like an email address or username that the user entered into a login form..
IDSync looks for a matching user profile using the identifiers included with the identification request in order of preference as defined by your identity priority. For example, an email address will return a matching user profile with a higher degree of confidence than a device ID, so email address is usually listed higher in your identity priority.
If a match is found, IDsync returns the corresponding mParticle ID (MPID), the user becomes known, and all previous and following events are associated with this MPID. If a match wasn’t found, the SDK continues to use the original MPID generated for the current user, as per the default identity strategy.
Now that we’re familiar with the concepts of identity resolution, let’s learn how to use the Android SDK to identify and track users in the Higgs Shop sample app.
IDsync provides four methods for tracking and managing users:
identify
: Called automatically when the SDK is initialized.login
: Used when a user logs into an account.logout
: Used when a user logs out of an account.modify
: Used when you need to add or change the identities associated with a profile, such as when a user updates their email address or phone number.You can identify a user when initializing the Android SDK by creating an IdentityAPIRequest
.
If the user is already logged in or you already have some identifiers for the user, create an identity request using IdentityApiRequest.withEmptyUser()
when initializing the Android SDK in the HiggsShopSampleApplication.kt
file. Set the identifers for your user using .email()
and .customerId()
, as in the following example.
Make sure to include import com.mparticle.identity.BaseIdentityTask
and import com.mparticle.identity.IdentityApiRequest
, otherwise you will not have access to the IDSync API.
package com.mparticle.example.higgsshopsampleapp;
import android.app.Application
import com.mparticle.MParticle
import com.mparticle.MParticleOptions
import com.mparticle.identity.BaseIdentityTask
import com.mparticle.identity.IdentityApiRequest
class HiggsShopSampleApplication: Application() {
val TAG = "HiggsShopSampleApplication"
override fun onCreate() {
super.onCreate()
val identityRequest = IdentityApiRequest.withEmptyUser()
.email("janedoe@example.com")
.customerId("123456")
.build()
val identifyTask = BaseIdentityTask()
.addFailureListener { identityHttpResponse ->
//handle failure - see below
}.addSuccessListener { identityApiResult ->
val user = identityApiResult.user
user.setUserAttribute("example attribute key", "example attribute value")
}
val options: MParticleOptions = MParticleOptions.builder(this)
.credentials(BuildConfig.HIGGS_SHOP_SAMPLE_APP_KEY, BuildConfig.HIGGS_SHOP_SAMPLE_APP_SECRET)
.environment(MParticle.Environment.Development)
// logLevel can be 'NONE', 'ERROR', 'WARNING', 'DEBUG', 'VERBOSE', or 'INFO
.logLevel(MParticle.LogLevel.VERBOSE)
.identify(identityRequest)
.identifyTask(identifyTask)
.build()
MParticle.start(options)
}
}
If you don’t provide any identities in an identityRequest
object, then the SDK uses browser local storage based on the most recent user.
You will notice that the Higgs Shop is not configured to handle a failed IDSync request, but the SDK does provide this functionality. Learn more in Error Handling.
You can configure your app to call the login
method whenever a user performs the corresponding action in your app. The login
method accepts an identity request as shown above, in addition to an optional callback function.
Following is a generic example of the use of the login
method to log in a user with a known email address and customer ID:
val identityRequest = IdentityApiRequest.withEmptyUser()
.email("foo@example.com")
.customerId("123456")
.build()
MParticle.getInstance().Identity().login(identityRequest)
In the Higgs Shop, login behavior is defined in the file AccountFragment.kt
:
binding.accountCta.setOnClickListener {
when(MParticle.getInstance()?.Identity()?.currentUser?.isLoggedIn) {
false -> {
//no user so login
val identityRequest = IdentityApiRequest.withEmptyUser()
.email("higgs@mparticle.com")
.customerId("higgs123456")
.build()
MParticle.getInstance()?.Identity()?.login(identityRequest)?.addSuccessListener {
accountViewModel.login()
showIdentityAlert("mParticle Login Call")
}
}
true -> {
//user exists in sample app so logout
MParticle.getInstance()?.Identity()?.logout()?.addSuccessListener {
accountViewModel.logout()
showIdentityAlert("mParticle Logout Call")
}
}
else -> {}
}
}
The logout
method is very similar to login
. You can include any anonymous identifiers you want to associate with the logged-out state of the user. The more common approach is to omit the IdentityApiRequest
which results in the logged-out user remaining entirely anonymous, with no associated identifiers.
MParticle.getInstance().Identity().logout()
// exluding the identity request from any IDSync API is the same as invoking the following:
MParticle.getInstance().Identity().logout(IdentityApiRequest.withEmptyUser().build())
In the Higgs Shop, log out behavior is handled in the same file as the login behavior, AccountFragment.kt
:
binding.accountCta.setOnClickListener {
when(MParticle.getInstance()?.Identity()?.currentUser?.isLoggedIn) {
false -> {
//no user so login
val identityRequest = IdentityApiRequest.withEmptyUser()
.email("higgs@mparticle.com")
.customerId("higgs123456")
.build()
MParticle.getInstance()?.Identity()?.login(identityRequest)?.addSuccessListener {
accountViewModel.login()
showIdentityAlert("mParticle Login Call")
}
}
true -> {
//user exists in sample app so logout
MParticle.getInstance()?.Identity()?.logout()?.addSuccessListener {
accountViewModel.logout()
showIdentityAlert("mParticle Logout Call")
}
}
else -> {}
}
}
To modify a user’s profile, the same IdentifyApiRequest.withEmptyUser()
method is called.
When you make a modify request, the Android SDK assigns the current user’s MPID to the request if you don’t supply a user when creating the request object.
In the following example, the SDK would either update the existing email address associated with the user or add the email address if one didn’t already exist.
IdentityApiRequest modifyRequest = IdentityApiRequest.withEmptyUser()
.email("updated-email@example.com")
.build()
MParticle.getInstance().Identity().modify(modifyRequest)
Was this page helpful?