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
Use the Group Identity API to create and manage groups of users that are related by a single shared user identifier. Groups can contain shared attributes, where each profile of a user in a group inherits all of the shared attributes values.
Imagine you want to send a discount coupon to all of your users who own a dog, but you know that some of the users you want to reach might live in a household where only one person is identified as the dog owner.
By creating a group definition for members of a household, where a household consists of users who share the same physical address, you can create an attribute has_dog
(or use an existing attribute) that is inherited by all members of the group if any other member’s profile has that attribute.
You can then use the shared, or inherited, attribute when creating audiences of users.
First, we use the Group Identity API to create a new group definition for families by sending a POST
API request to /platform/workspaces/{workspace_id}/groups/
The body of our request is:
{
"id": "household",
"description": "users who share the same physical address",
"source_user_attribute": "$address",
"attributes": [
{
"id": "has_dog",
"type": "boolean_or"
}
]
}
The source_user_attribute
field is how mParticle determines if a user should be added to a group. In this example, two users who share the same $address
will be added to a new group.
Every group definition includes a list of group attributes in the attributes
array, where each attribute is represented by an object with an id
equaling the name of the user attribute to use as a group attribute and a type
specifying the aggregation logic used for attribute. To learn more about group attributes and attribute aggregation logic, see the Group attributes overview.
Group attributes are added to the profiles for all users who join a group. User profiles are updated with new group attributes every Monday on a weekly basis.
Once you have created a group definition, mParticle runs a search on a recurring, weekly schedule looking for any users with a user attribute matching a group identity’s source_user_attribute
. Users with matching attributes are added to a group instance created using the group definition. Their profiles then inherit any group attributes listed in the group’s definition.
In our example, imagine two users John Doe and Jane Doe where both John and Jane have the same address, "$address": "123 Main St"
. Since they share the same address, they are added to a new group using the household
group definition.
Both profiles for John and Jane then also display the new shared attribute has_dog
. If any member of the group has a user attribute has_dog: true
, then the group attribute household:has_dog=true
is added to all other members of the same group. Otherwise, the value of household:has_dog
remains false for all group members.
In the mParticle audience builder, we can now use our new group attributes, such as household:has_dog
, as criteria to create or supplement an audience that contains users who are members of a household that has a dog. For more information on how to create audiences, see Create an audience.
The Group Identity API allows you to create group definitions. mParticle then uses these definitions to create groups of users based on their shared user identifiers. This means you can create one group definition for families that results in the creation of multiple family groups. (For example, all the “Jones” family members and all the “Smith” family members.)
The Group Identity API can be authenticated using 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 credentialsclient_secret
- the client secret, issued by mParticle when creating the API credentialsaudience
- set to a value of "https://api.mparticle.com"
grant_type
- set to a value of "client_credentials"
curl --request POST \
--url https://sso.auth.mparticle.com/oauth/token \
--header 'content-type: application/json' \
--data '{"client_id":"...","client_secret":"...","audience":"https://api.mparticle.com","grant_type":"client_credentials"}'
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"
}
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-
Tokens cannot be revoked, but they expire every eight hours. The initial token request can take between one and three seconds, so mParticle recommends that you cache the token and refresh it only when necessary.
GET
https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}
Path Parameter | Type | Description |
---|---|---|
{workspace_id} |
Integer | The ID of the workspace containing the group definition you want to retrieve. |
{group_id} |
String | The ID for the group definition you want to retrieve. |
curl --location --request GET 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \
--header 'Authorization: Bearer <access_token>'
No request body.
A successful request receives a 200
response with a JSON object for the group.
{
"id": "neustar-household-group",
"description": "A group of users related by shared Neustar household ID",
"source_user_attribute": "neustar-household-id",
"attributes": [
{
"id": "has_dog",
"type": "boolean_or"
}
],
"created_on": "2023-11-13T21:50:17.732Z",
"created_by": "developer@example.com",
"last_modified_on": "2023-11-13T21:50:17.732Z",
"last_modified_by": "developer@example.com"
}
GET
https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/
Path Parameter | Type | Description |
---|---|---|
{workspace_id} |
Integer | The ID of the workspace containing the group definitions you want to retrieve. |
curl --location --request GET 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups' \
--header 'Authorization: Bearer <access_token>'
No request body.
A successful request receives a 200
response with an array containing all groups.
[
{
"id": "neustar-household-group",
"description": "A group of users related by shared Neustar household ID",
"source_user_attribute": "neustar-household-id",
"attributes": [
{
"id": "has_dog",
"type": "boolean_or"
}
],
"created_on": "2023-11-13T21:50:17.732Z",
"created_by": "developer@example.com",
"last_modified_on": "2023-11-13T21:50:17.732Z",
"last_modified_by": "developer@example.com"
}
]
POST
https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/
Field | Description |
---|---|
id |
A unique ID used to identify the group definition. |
description |
A human readable description for the group definition. For example: users who all share the same Neustar household ID |
source_user_attribute |
A single user attribute that mParticle uses to determine users’ group memberships. For example: $neustar-household-id |
attributes |
An array of group attribute objects, where each attribute contains an id and type .
|
curl --location --request POST 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups' \
--header 'Authorization: Bearer <access_token>'
{
"id": "neustar-household-group",
"description": "A group of users related by shared Neustar household ID",
"source_user_attribute": "neustar-household-id",
"attributes": [
{
"id": "has_dog",
"type": "boolean_or"
}
]
}
A successful request receives a 200
response with a JSON object for the new group.
{
"id": "neustar-household-group",
"description": "A group of users related by shared Neustar household ID",
"source_user_attribute": "neustar-household-id",
"attributes": [
{
"id": "has_dog",
"type": "boolean_or"
}
],
"created_on": "2023-11-13T21:50:17.732Z",
"created_by": "developer@example.com",
"last_modified_on": "2023-11-13T21:50:17.732Z",
"last_modified_by": "developer@example.com"
}
PUT
https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}
Path Parameter | Type | Description |
---|---|---|
{workspace_id} |
Integer | The ID of the workspace containing the group definition. |
{group_id} |
String | The ID for the group definition you want to update. |
curl --location --request PUT 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \
--header 'Authorization: Bearer <access_token>'
{
"description": "A group of users related by shared Neustar household ID",
"source_user_attribute": "neustar-household-id",
"attributes": [
{
"id": "has_dog",
"type": "boolean_or"
}
]
}
A successful request receives a 200
response with a JSON object for the group.
{
"id": "group-id",
"description": "A group of users related by shared Neustar household ID",
"source_user_attribute": "neustar-household-id",
"attributes": [
{
"id": "has_dog",
"type": "boolean_or"
}
],
"created_on": "2023-11-13T21:53:57.917Z",
"created_by": "developer@example.com",
"last_modified_on": "2023-11-13T21:53:57.917Z",
"last_modified_by": "developer@example.com"
}
PATCH
https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}
Path Parameter | Type | Description |
---|---|---|
{workspace_id} |
Integer | The ID of the workspace containing the group definition. |
{group_id} |
String | The ID for the group definition you want to add attributes to. |
curl --location --request PUT 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \
--header 'Authorization: Bearer <access_token>'
{
"attributes": [
{
"id": "has_dog",
"type": "boolean_or"
},
{
"id": "country",
"type": "latest"
}
]
}
A successful request receives a 200
response with a JSON object for the group.
{
"id": "group-id",
"description": "A group of users related by shared Neustar household ID",
"source_user_attribute": "neustar-household-id",
"attributes": [
{
"id": "id of the attribute shared by the group",
"type": "either 'latest' or 'boolean_or'"
}
],
"created_on": "2023-11-13T21:57:26.947Z",
"created_by": "developer@example.com",
"last_modified_on": "2023-11-13T21:57:26.947Z",
"last_modified_by": "developer@example.com"
}
DELETE
https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}
Path Parameter | Type | Description |
---|---|---|
{workspace_id} |
Integer | The ID of the workspace containing the group definition you want to delete. |
{group_id} |
String | The ID of the group definition you want to delete. |
curl --location --request DELETE 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \
--header 'Authorization: Bearer <access_token>'
No request body.
A successful request receives a 204
response with an empty body.
Limit | Description |
---|---|
Group ID | Must be between 3 and 32 characters |
Group description | Must be between 0 and 255 characters |
Group attribute ID’s | Must be between 1 and 223 characters |
Number of group definitions per workspace | 1 |
Number of attributes per group | 10 |
Number of users per group | 10 |
Response code | Error message | Description |
---|---|---|
400 | No user ID provided | You must provide a valid user ID when attempting to view a user. |
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 specified resource was not found. |
422 | Unprocessable entity | The request was understood but cannot be processed. |
Was this page helpful?