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

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

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

Flutter

Getting Started

Usage

API Reference

Direct Url Routing

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

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

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

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

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Media SDKs

iOS

Web

Android

Guides

Partners

Introduction

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

Rules Developer Guide

Migrate from Segment to mParticle

Migrate from Segment to Client-side mParticle

Migrate from Segment to Server-side mParticle

Segment-to-mParticle Migration Reference

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

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

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 (Snowplow Schema)

AWS S3 Integration (Define Your Own 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

REST API

Dashboard Filter API (Deprecated)

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Profile API

The Profile API can be used to query identities, user attributes, audience memberships, and other data available on an mParticle User Profile, anywhere you can make an HTTP request. Profile API can be used to drive one-to-one personalized experiences for your users across any channel:

Deliver customized product or content recommendations
Identify churn-risk customers in an automated voice support flow and launch a win-back campaign.
Deliver personalized offers in brick and mortar stores by integrating your point-of-sale systems.

Base URL

The base URL for the Profile API is https://api.mparticle.com.

Authentication

The Profile API is authenticated with a bearer token. To create a bearer token, first create a set of API credentials in the UI.

Create your API credentials

Log in to your mParticle account.
Click the User Profile icon at the bottom of the left nav bar, click Settings, and select the API Credentials tab.
Click + Add Credential.
Enter a descriptive name for the Display name.
Check the box next to Profile API, and then expand the available workspaces by clicking the + button. Check the box next to each workspace you need to access user profile data for.
Click Save, and copy the Client ID and Client Secret displayed in the modal window before clicking Done.

Create a bearer token

To create a bearer token, send a POST request to mParticle’s SSO token endpoint at https://sso.auth.mparticle.com/oauth/token.

The JSON body of the request must contain:

client_id - the client ID, issued by mParticle when creating the API credentials
client_secret - the client secret, issued by mParticle when creating the API credentials
audience - set to a value of "https://api.mparticle.com"
grant_type - set to a value of "client_credentials"

Example curl request

curl --request POST \
  --url https://sso.auth.mparticle.com/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"your-client-id","client_secret":"your-client-secret","audience":"https://api.mparticle.com","grant_type":"client_credentials"}'

Example HTTP request

POST /oauth/token HTTP/1.1
Host: sso.auth.mparticle.com
Content-Type: application/json

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "audience": "https://api.mparticle.com",
  "grant_type": "client_credentials"
}

Using your bearer token

A successful POST request to the token endpoint results in a JSON response as follows:

{
  "access_token": "YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-",
  "expires_in" : 28800,
  "token_type": "Bearer"
}

Subsequent requests to the API can then be authorized by setting the authorization header to:

Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-

Rate limits

mParticle imposes default service limits on the Profile API. For the specific limits on retrieving user profiles using the Profile API, see Default Service Limits.

Best practices

Do not submit client-side queries to Profile API from your application’s frontend. Instead, maximize performance in your app by creating a backend personalization service to submit these queries, acting as an intermediary between your app and the mParticle Profile API. This service can be built directly into your app’s existing backend framework, or it can an independent service.

As an example workflow:

Your app’s client requests user information (like product recommendations) from your personalization service by providing an identifier for the current user.
Your personalization service queries the Profile API using the supplied identifier. Based on information in the returned profile, your personalization service determines the best behavior for your app.
Your personalization service send only the information necessary to implement the desired personalization to your app’s frontend. For example, an array of product recommendations.

A simple example personalization service implemented with Node and Express is available on GitHub.

Manage user profiles

Get a profile by mParticle ID

GET /userprofile/v1/{orgID}/{accountId}/{workspaceId}/{mpid}?fields=device_identities,user_identities,user_attributes,audience_memberships,attribution

Path parameters

Path Parameter	Type	Description
`{orgID}`	Integer	ID of the mParticle organization containing the user profile.
`{accountID}`	Integer	ID of the mParticle account containing the user profile.
`{workspaceID}`	Integer	ID of the mParticle workspace containing the user profile.
`{mpid}`	Integer	The mParticle ID for the user profile you want to retrieve.

Query parameters

Query Parameter	Type	Required	Description
`{fields}`	String	Yes	A comma-separated list of fields you want returned for the user profile. See list below for permitted values.

List of supported fields that can be returned with a user profile:

device_identities
user_identities
user_attributes (includes any calculated attributes)
audience_memberships
attribution

Example curl request

curl \
  -X GET \
  -H "Authorization: Bearer {accessToken}" \
  "https://api.mparticle.com/userprofile/v1/{orgId}/{accountId}/{workspaceId}/{mpid}?fields=device_identities,user_identities,user_attributes,audience_memberships,attribution"

Example JSON request body

No request body.

Response

A successful request receives a 200 response with a JSON object for the user profile.

{
  "mpid": 9080350317581165000,
  "created_timestamp_ms": 1574704283462,
  "last_stored_timestamp_ms": 1575301484215,
  "is_opted_out": false,
  "limit_ad_tracking": null,
  "device_identities": [
    {
      "type": "android_id",
      "encoding": "none",
      "value": "8789c459016a94b0"
    },
    {
      "type": "unknown",
      "encoding": "none",
      "value": "0c48aafbd6c69b3e1921fab5ccb528397eb1000854db2b99b1efc8507884b07a"
    },
    {
      "type": "google_advertising_id",
      "encoding": "none",
      "value": "481c8a31-7d5d-4d96-93a0-2de7427167fc"
    },
    {
      "type": "unknown",
      "encoding": "none",
      "value": "1b4469f3fb1f7bee7ba6705d1ce4b9d8a23e76592c34aa6c4a4eea3d0a07aa64"
    }
  ],
  "user_identities": [
    {
      "type": "customer_id",
      "encoding": "none",
      "value": "Example-Customer-mxr15"
    },
    {
      "type": "email",
      "encoding": "none",
      "value": "Example-Customer-mxr15@example.com"
    }
  ],
  "account_user_attributes": null,
  "user_attributes": {
    "ml_product_recs": [
      "123849",
      "294933",
      "937592",
      "500422"
    ],
    "view_preference": "Dark Mode",
    "tp_age": "18-34",
    "tp_gender": "male",
    "last_purchase_category": "Home Decor",
    "churn_risk_score": "4",
    "ltv": "342.1",
    "$city": "New York",
    "$state": "NY",
    "$country": "USA",
    "$firstname": "Marky",
    "$lastname": "Mark"
  },
  "audience_memberships": [
    {
      "audience_id": 17802,
      "audience_name": "Meret final CA test",
      "expiration_timestamp_ms": null
    },
    {
      "audience_id": 17918,
      "audience_name": "Decor Remarketing",
      "expiration_timestamp_ms": null
    }
  ]
}

Get a profile by immutable ID

POST /userprofile/v1/resolve/{orgId}/{accountId}/{workspaceId}

Allows you to retrieve a profile without the mParticle ID. To use this method, your account must have an immutable identity configured in your identity strategy. An immutable identity is set only once and cannot be changed once it is set. It is usually the Customer ID.

Path parameters

Path Parameter	Type	Description
`{orgID}`	Integer	ID of the mParticle organization containing the user profile.
`{accountID}`	Integer	ID of the mParticle account containing the user profile.
`{workspaceID}`	Integer	ID of the mParticle workspace containing the user profile.

Query parameters

Query Parameter	Type	Required	Description
`{fields}`	String	Yes	A comma-separated list of fields you want returned for the user profile. See list below for permitted values.

List of supported fields that can be returned with a user profile:

device_identities
user_identities
user_attributes (including any calculated attributes)
audience memberships
attribution

Request body parameters

Name	Type	Required	Description
`environment_type`	`string`	Yes	Either `development` or `production`.
`identity.type`	`string`	Yes	The type of identity being sent. Must be an immutable identity type, like `customer_id` or `other`
`identity.value`	`string`	Yes	The identity value.

Example curl request

curl \
  -X POST \
  -H "Authorization: Bearer {accessToken}" \
  "https://api.mparticle.com/userprofile/v1/resolve/{orgId}/{accountId}/{workspaceId}?fields=device_identities,user_identities,user_attributes,audience_memberships,attribution" \
  -d "{ \"environment_type\": \"production\", \
    \"identity\": {\"type\": \"customer_id\",\"value\": \"12345\"}}"

Example JSON request body

{
  "environment_type": "production",
  "identity": {
    "type": "customer_id",
    "value": "12345"
  }
}

Response

A successful request receives a 200 response with a JSON object for the user profile.

{
  "mpid": 9080350317581165000,
  "created_timestamp_ms": 1574704283462,
  "last_stored_timestamp_ms": 1575301484215,
  "is_opted_out": false,
  "limit_ad_tracking": null,
  "device_identities": [
    {
      "type": "android_id",
      "encoding": "none",
      "value": "8789c459016a94b0"
    },
    {
      "type": "unknown",
      "encoding": "none",
      "value": "0c48aafbd6c69b3e1921fab5ccb528397eb1000854db2b99b1efc8507884b07a"
    },
    {
      "type": "google_advertising_id",
      "encoding": "none",
      "value": "481c8a31-7d5d-4d96-93a0-2de7427167fc"
    },
    {
      "type": "unknown",
      "encoding": "none",
      "value": "1b4469f3fb1f7bee7ba6705d1ce4b9d8a23e76592c34aa6c4a4eea3d0a07aa64"
    }
  ],
  "user_identities": [
    {
      "type": "customer_id",
      "encoding": "none",
      "value": "Example-Customer-mxr15"
    },
    {
      "type": "email",
      "encoding": "none",
      "value": "Example-Customer-mxr15@example.com"
    }
  ],
  "account_user_attributes": null,
  "user_attributes": {
    "ml_product_recs": [
      "123849",
      "294933",
      "937592",
      "500422"
    ],
    "view_preference": "Dark Mode",
    "tp_age": "18-34",
    "tp_gender": "male",
    "last_purchase_category": "Home Decor",
    "churn_risk_score": "4",
    "ltv": "342.1",
    "$city": "New York",
    "$state": "NY",
    "$country": "USA",
    "$firstname": "Marky",
    "$lastname": "Mark"
  },
  "audience_memberships": [
    {
      "audience_id": 17802,
      "audience_name": "Meret final CA test",
      "expiration_timestamp_ms": null
    },
    {
      "audience_id": 17918,
      "audience_name": "Decor Remarketing",
      "expiration_timestamp_ms": null
    }
  ]
}

Error handling

Response code	Error message	Description
400	Bad request	The request syntax is invalid or the requested profile is invalid.
401	Unauthorized	Verify that you have created the correct API credentials for the FeatureName API and that you are using the correct authentication method.
403	Forbidden	Verify that you have created the correct API credentials for the FeatureName API and that you are using the correct authentication method.
404	Not found	The user profile either does not exist, or has expired.
429	Too Many Requests	You have exceeded your provisioned limit. The endpoints may return a Retry-After response header with a value containing a non-negative decimal integer indicating the number of seconds to delay. If the header is not present, we recommend retrying your request in an exponential backoff pattern. Learn more about API throttling in Default Service Limits.
503	Service Unavailable	The service is unavailable, we recommend retrying your request in an exponential backoff pattern.
5xx	Server Error	A server-side error occured, try your request again.

Profile expiration

User profiles expire and will not be returned by the Profile API if they are not accessed or updated for a period of 90 days. The default 90 day expiration period may be adjusted depending on your contract with mParticle. For more information about your account’s profile expiration period, contact your account representative.

Was this page helpful?

Last Updated: November 12, 2024