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

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Flutter

Getting Started

Usage

API Reference

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

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

Xbox

Getting Started

Identity

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Web

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

Xamarin

Getting Started

Identity

Web

Alexa

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Media SDKs

Android

Web

iOS

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

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Data Hosting Locations

Compose ID

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

Organize Dashboards

Dashboard Filters

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

Group Identity API Reference

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.

Example use case

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.

Step 1: Create a group definition

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.

Step 2: mParticle automatically adds users to a group

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.

Step 3: Create an audience using your new group definition and group attributes

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.)

Authentication

The Group Identity API can be authenticated using a bearer token.

Authenticate with 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":"...","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"
}

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 a specific group definition by its group ID

GET https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}

Path parameters

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.

Example cURL request

curl --location --request GET 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \
--header 'Authorization: Bearer <access_token>'

Example JSON request body

No request body.

Response

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 all group definitions contained in a workspace

GET https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/

Path parameters

Path Parameter Type Description
{workspace_id} Integer The ID of the workspace containing the group definitions you want to retrieve.

Example cURL request

curl --location --request GET 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups' \
--header 'Authorization: Bearer <access_token>'

Example JSON request body

No request body.

Response

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"
  }
]

Create a new group definition in a workspace

POST https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/

Request body options

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.
  • The id can be any string value you want to use to identify the attribute.
    For example, has_dog
  • The type represents the aggregation logic used for the attribute. Valid options are: latest, boolean_or, sum, or average. Read more about attribute aggregation logic here.

Example cURL request

curl --location --request POST 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups' \
--header 'Authorization: Bearer <access_token>'

Example JSON request body

{
  "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"
    }
  ]
}

Response

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"
}

Update a group definition

PUT https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}

Path parameters

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.

Example cURL request

curl --location --request PUT 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \
--header 'Authorization: Bearer <access_token>'

Example JSON request body

{
  "description": "A group of users related by shared Neustar household ID",
  "source_user_attribute": "neustar-household-id",
  "attributes": [
    {
      "id": "has_dog",
      "type": "boolean_or"
    }
  ]
}

Response

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"
}

Set attributes for a group

PATCH https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}

Path parameters

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.

Example cURL request

curl --location --request PUT 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \
--header 'Authorization: Bearer <access_token>'

Example JSON request body

{
  "attributes": [
    {
      "id": "has_dog",
      "type": "boolean_or"
    },
    {
      "id": "country",
      "type": "latest"
    }
  ]
}

Response

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 a group

DELETE https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}

Path parameters

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.

Example cURL request

curl --location --request DELETE 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \
--header 'Authorization: Bearer <access_token>'

Example JSON request body

No request body.

Response

A successful request receives a 204 response with an empty body.

Limitations

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

Error handling

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?

    Last Updated: December 5, 2024