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

REST API

Analytics offers a number of different endpoints for creating and modifying your data:

  • Track Events allows you to record events in Analytics
  • Identify Users allows you to set user properties for a specified user
  • Alias Users allows you to merge two user event streams and profiles together
  • Suppress User Data allows you to suppress further calls for a specified user from being processed
  • Delete User Data allows you to submit a request for deletion of data for a specified user

All Analytics API endpoints, with the exception of the track events endpoint, require the use of the POST method to invoke as well as a Content-Type header of application/json. The Analytics track events endpoint can be invoked through either the POST or the GET method. Additionally, all of Analytics API endpoints require specifying an API Key to identify Analytics project. This can be submitted either as part of your JSON request body or as a path parameter in each individual URL.

For each of Analytics’ API calls, our servers will respond with one of a few status codes indicating the outcome of your request:

Status Code Description
200 OK Your request successfully reached our servers and used the correct syntax.
400 Bad Request Your request contained malformed syntax. This may indicate that the API Key you used is incorrect.
422 Unprocessable Entity Your request used the correct syntax, but one or more JSON field values violated the constraints listed above.

Please note: Capitalization is important for all fields. 

Track Events

We offer two options for submitting events to our REST API: submitting one event at a time, or submitting batches of events.

Track a Single Event

Single events can be tracked either through the POST method or the GET method

POST Method

Our REST API’s single event endpoint is

https://api.indicative.com/service/event
or
https://api.indicative.com/service/event/{Your API KEY}

To send us an event, you’ll need to make a POST request to that URL with a Content-Type of ‘application/json’. In the POST body, include a JSON object with the following fields:

Name Type Description
apiKey String The API Key for this project. If the key you provide is invalid, we’ll return a 400 Bad Request error.
eventName String The name of the event. Must be between 1 and 255 characters in length, and cannot be null.
eventUniqueId String The unique identifier for the user triggering the event. Must be between 1 and 255 characters in length, and cannot be null.
properties JSON Object An internal JSON Object, listing property names and values as Strings. Values will be truncated at 255 characters.
eventTime Number The time that the event occurred. The value should be in unix timestamp (either in seconds or milliseconds) or ISO 8601 format. This field is optional, and will default to the current time if not set. Events with negative timestamps (i.e., dates before 1970 UTC) will be rejected.

As an example, your JSON Object would resemble the following:

{
    "apiKey": "Your-API-Key",
    "eventName": "Registration",
    "eventUniqueId": "user47",
    "properties":{
        "Gender": "Female",
        "Age": "23"
    }
}

Our servers will respond with one of a few status codes indicating the outcome of your request:

Status Code Description
200 OK Your request successfully reached our servers and used the correct syntax.
400 Bad Request Your request contained malformed syntax. This may indicate that the API Key you used is incorrect.
422 Unprocessable Entity Your request used the correct syntax, but one or more JSON field values violated the constraints listed above.

GET Method

Analytics supports GET requests via its HTTP API. To utilize, send the same arguments included in the JSON of a normal POST request encoded as query parameters, with the exception of the properties dictionary. To send properties, include multiple query parameters named “propertyNames” and “propertyValues” corresponding to the keys and values in the properties dictionary. Note that the number of propertyNames and propertyValues must be the same.

Our REST API’s single event endpoint is:

https://api.indicative.com/service/event

To send us an event, you’ll need to make a GET request to that URL with a Content-Type of ‘application/json’. In the GET body, include a JSON object with the following fields:

Name Type Description
apiKey String The API Key for this project. If the key you provide is invalid, we’ll return a 400 Bad Request error.
eventName String The name of the event. Must be between 1 and 255 characters in length, and cannot be null.
eventUniqueId String The unique identifier for the user triggering the event. Must be between 1 and 255 characters in length, and cannot be null.
propertyNames String The name of the property. Must be between 1 and 255 characters in length.
propertyValues String The value of the propertyName directly preceding. Must be between 1 and 255 characters in length.
eventTime Number The time that the event occurred. The value should be in unix timestamp (either in seconds or milliseconds) or ISO 8601 format. This field is optional, and will default to the current time if not set. Events with negative timestamps (i.e., dates before 1970 UTC) will be rejected.

As an example, your GET request would resemble the following:

https://api.indicative.com/service/event?apiKey={Your API Key}&eventName=EmailOpen&eventUniqueId=user123&propertyNames=prop1& propertyValues=val1&propertyNames=prop2&propertyValues=val2

Our servers will respond with one of a few status codes indicating the outcome of your request:

Status Code Description
200 OK Your request successfully reached our servers and used the correct syntax.
400 Bad Request Your request contained malformed syntax. This may indicate that the API Key you used is incorrect.
422 Unprocessable Entity Your request used the correct syntax, but one or more JSON field values violated the constraints listed above.

Track a Batch of Events

To send multiple events at once, you’ll want to use our batch endpoint at:

https://api.indicative.com/service/event/batch

It works similarly to the single event endpoint — it requires a POST with Content-Type: ‘application/json’ and a POST body containing the following:

Name Type Description
apiKey String The API Key for this project. If the key you provide is invalid, we’ll return a 400 Bad Request error.
events JSON Array The events to be recorded, in an array. Each object in this array should adhere to the format used to send up a single event, indicated above. The ‘apiKey’ field used in the single event is unnecessary here, and will be disregarded if included.

We recommend that your implementation include up to 100 events per batch. All events sent in a batch default to the current time. To override this, you can set the “eventTime” key for each event to a specific Unix timestamp value. As an example, a batch of two events that would be assigned with the current time would resemble the following:

{
        "apiKey": "Your-API-Key",
        "events": [
            {
                "eventName": "Registration",
                "eventUniqueId": "user47",
                "properties":{
                    "Gender": "Female",
                    "Age": "23"
                }
            },
            {
                "eventName": "Log-In",
                "eventUniqueId": "user752",
                "properties":{
                    "Gender": "Male",
                     "Age": "31"
                }
            }
        ]
}

The status codes returned by the batch endpoint are the same as the single event endpoint specified above. When sending either single or batched events, there is a rate limit of 250 events per second. If you need a higher rate limit, please contact support@mparticle.com.

Identify Users

Analytics’ Identify endpoint allows customers to update user properties for a specified unique key. User properties that are specified through this endpoint persist until the property value has been overwritten by another call to the Identify or Track Events APIs.

Our REST API’s Identify endpoint is:

https://api.indicative.com/service/identify
or
https://api.indicative.com/service/identify/{Your API KEY}

To call this method, make a POST request to the above URL with a Content-Type of ‘application/json’. In the POST body, include a JSON object with the following fields:

Name Type Description
apiKey String The API Key for this project. If the key you provide is invalid, we’ll return a 400 Bad Request error.
uniqueId String The unique identifier of the user to update. Must be between 1 and 255 characters in length, and cannot be null.
properties JSON Object An internal JSON Object, listing property names and values as strings. Values will be truncated at 255 characters.

Alias Users

Our REST API’s alias endpoint is:

https://api.indicative.com/service/alias
or
https://api.indicative.com/service/alias/{Your API KEY}

For more details on how aliasing works, see more detailed documentation here.

To send us an alias, you’ll need to make a POST request to that URL with a Content-Type of ‘application/json’. In the POST body, include a JSON object with the following fields:

Name Type Description
apiKey String The API Key for this project. If the key you provide is invalid, we’ll return a 400 Bad Request error.
previousId String The previous unique identifier for a user. This is most often an anonymous ID, which is generated before a user identifies themselves by registering or logging in.
newId String The new unique identified for a user. This is most often a user ID that uniquely identifies a user within your application.

Suppress User Data

Analytics’ Suppress endpoint allows customers to suppress future data from being processed for a specified unique key.

The REST API’s Suppress endpoint is:

https://api.indicative.com/service/suppress
or
https://api.indicative.com/service/suppress/{Your API KEY}

To call this method, make a POST request to the above URL with a Content-Type of ‘application/json’. In the POST body, include a JSON object with the following fields:

Name Type Description
apiKey String The API Key for this project. If the key you provide is invalid, we’ll return a 400 Bad Request error.
uniqueId String The unique identifier of the user whose data to suppress. Must be between 1 and 255 characters in length, and cannot be null.

Delete User Data

Analytics’ Delete endpoint allows customers to submit a request to irrevocably delete data for a specified unique key from Analytics. In addition, a call to this endpoint suppresses future data from being processed for a specified unique key.

The REST API’s Suppress endpoint is:

https://api.indicative.com/service/delete
or
https://api.indicative.com/service/delete/{Your API KEY}

To call this method, make a POST request to the above URL with a Content-Type of ‘application/json’. In the POST body, include a JSON object with the following fields:

Name Type Description
apiKey String The API Key for this project. If the key you provide is invalid, we’ll return a 400 Bad Request error.
uniqueId String The unique identifier of the user whose data to suppress. Must be between 1 and 255 characters in length, and cannot be null.

Was this page helpful?

    Last Updated: December 5, 2024