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

Data Hosting Locations

Each mParticle customer tenant (aka “Organization”) exists in a specific segment (or “Pod”) of mParticle’s infrastructure. A pod is a self-contained instance of the entire mParticle service for a subset of organizations. Pods are completely independent of each other with redundancy built into each layer of the architecture, including the application servers, database, IaaS, and CDN to ensure maximum availability.

Data Localization

mParticle offers the option of hosting a pod in a localized data center outside the US, in particular in the Europe and Australia regions. For customers interested in data localization outside these regions, please contact us.

As part of the onboarding process, your mParticle account manager will let you know which pod your organization resides in.

Depending on the pod your organization is hosted in, you will need to note a few key differences described below.

Logging into mParticle

You can log in to your localized mParticle pod using the following URLs:

Region Pod Login URL
United States US1 https://app.mparticle.com, https://app.us1.mparticle.com
United States US2 https://app.us2.mparticle.com
Europe EU1 https://app.eu1.mparticle.com
Australia AU1 https://app.au1.mparticle.com

For all API endpoints, mParticle routes the request to the appropriate region based on the authorization token.

Sending Data into mParticle

Most mParticle SDKs route data to your mParticle pod automatically based on your API keys. The following SDKs require that you configure your pod name:

  • Go
  • Java
  • Node
  • Python
  • Ruby

The following features require mParticle pod-dependent changes before data flows from an input into mParticle:

Events API

Our Events API has the following data center specific URLs. Learn more about our Events API here.

Pod API Endpoint
US1 events https://s2s.mparticle.com/v2/events, https://s2s.us1.mparticle.com/v2/events
bulkevents https://s2s.mparticle.com/v2/bulkevents, https://s2s.us1.mparticle.com/v2/bulkevents
bulkevents/historical https://s2s.mparticle.com/v2/bulkevents/historical, https://s2s.us1.mparticle.com/v2/bulkevents/historical
US2 events https://s2s.us2.mparticle.com/v2/events
bulkevents https://s2s.us2.mparticle.com/v2/bulkevent
bulkevents/historical https://s2s.us2.mparticle.com/v2/bulkevents/historical
EU1 events https://s2s.eu1.mparticle.com/v2/events
bulkevents https://s2s.eu1.mparticle.com/v2/bulkevents
bulkevents/historical https://s2s.eu1.mparticle.com/v2/bulkevents/historical
AU1 events https://s2s.au1.mparticle.com/v2/events
bulkevents https://s2s.au1.mparticle.com/v2/bulkevents
bulkevents/historical https://s2s.au1.mparticle.com/v2/bulkevents/historical

Rules

ARN

When providing an Amazon Resource Number (ARN) for your Rule, follow these conventions:

Pod ARN Rule Convention
US1 arn:aws:lambda:us-east-1:999999999999:function:mprmylambdafunction:PROD
arn:aws:lambda:us-east-1:999999999999:function:mprmylambdafunction:$LATEST
US2 arn:aws:lambda:us-east-1:999999999999:function:mprmylambdafunction:PROD
arn:aws:lambda:us-east-1:999999999999:function:mprmylambdafunction:$LATEST
EU1 arn:aws:lambda:eu-central-1:999999999999:function:mprmylambdafunction:PROD
arn:aws:lambda:eu-central-1:999999999999:function:mprmylambdafunction:$LATEST
AU1 arn:aws:lambda:ap-southeast-2:999999999999:function:mprmylambdafunction:PROD
arn:aws:lambda:ap-southeast-2:999999999999:function:mprmylambdafunction:$LATEST

Learn more about how to set an ARN when hosting a Rule here.

IAM

When setting IAM permissions, specify the following resources:

Pod IAM Permissions
US1 arn:aws:logs:us-east-1:*:log-group:/aws/lambda/mpr*
arn:aws:lambda:us-east-1:*:function:mpr*
US2 arn:aws:logs:us-east-1:*:log-group:/aws/lambda/mpr*
arn:aws:lambda:us-east-1:*:function:mpr*
EU1 arn:aws:logs:eu-central-1:*:log-group:/aws/lambda/mpr*
arn:aws:lambda:eu-central-1:*:function:mpr*
AU1 arn:aws:logs:ap-southeast-2:*:log-group:/aws/lambda/mpr*
arn:aws:lambda:ap-southeast-2:*:function:mpr*

Learn more about how to set IAM permissions when hosting a Rule here.

SFTP Servers

When sending data to mParticle for file based integrations (Salesforce, Custom CSV, etc), the following hostname and IP should be used:

Pod Hostname and IP
US1 Hostname: sftp.mparticle.com:4422, Hostname: sftp.us1.mparticle.com:4422
IP: 34.199.76.170
US2 Hostname: sftp.us2.mparticle.com:4422
IP: 52.45.156.86
EU1 Hostname: sftp.eu1.mparticle.com:4422
IP: 18.157.92.224
AU1 Hostname: sftp.au1.mparticle.com:4422
IP: 13.55.216.94

Sending Data Out of mParticle

The following features require mParticle pod-dependent changes for data flowing out of mParticle:

AWS Regions

Create your downstream AWS services in the following AWS Regions aligned to your pod for optimal performance:

Pod AWS Region
US1 us-east-1
US2 us-east-1
EU1 eu-central-1
AU1 ap-southeast-2

Amazon S3 Bucket

If you are using role-based authentication, create an S3 bucket with a custom bucket policy.

Use this link docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-s3 for information on S3 ARN Syntax.

To create the bucket and set the custom bucket policy:

  1. Create an S3 Bucket. The bucket name must begin with mp-forwarding-.

  2. Create a New Policy from the AWS S3 Bucket Policy Template below and be sure to:

    1. Replace the word {bucket} with the name of the S3 bucket created in step 1.
    2. Replace {arn1} and {arn2} with the ARN details below.
  3. Assign Policy to Bucket. In the Bucket Policy Editor

    1. Click Properties.
    2. Click Permissions.
    3. Click Add bucket policy.
    4. Paste the JSON from step 2 above.

AWS S3 Bucket Policy Principal

Pod ARN # AWS S3 Bucket Policy Principal
US1 {arn1} arn:aws:iam::338661164609:role/Prod-Role-DG12-Default
{arn2} arn:aws:iam::338661164609:role/role-lambda-verifyrequest
US2 {arn1} arn:aws:iam::386705975570:role/Prod-Role-DG12-Default
{arn2} arn:aws:iam::386705975570:role/verifyrequest_lambda
EU1 {arn1} arn:aws:iam::583371261087:role/Prod-Role-DG12-Default
{arn2} arn:aws:iam::583371261087:role/verifyrequest_lambda
AU1 {arn1} arn:aws:iam::526464060896:role/Prod-Role-DG12-Default
{arn2} arn:aws:iam::526464060896:role/verifyrequest_lambda

AWS S3 Bucket Policy Template

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "s3:PutObject",
                "s3:PutObjectAcl"
            ],
            "Effect": "Allow",
            "Resource": "arn:aws:s3:::{bucket}/*",
            "Principal": {
                "AWS": [
                    "{arn1}"
                ]
            }
        },
        {
            "Action": [
                "s3:PutObject",
                "s3:PutObjectAcl"
            ],
            "Effect": "Allow",
            "Resource": "arn:aws:s3:::{bucket}/*",
            "Principal": {
                "AWS": [
                    "{arn2}"
                ]
            }
        }
    ]
}

Learn more about how to set your bucket policy here.

IP Whitelisting

If you want to whitelist data being sent from mParticle to an integration, use the following information:

All https://api.mparticle.com/ip-ranges

Learn more about setting up IP Whitelisting for Redshift and Snowflake.

Was this page helpful?

    Last Updated: December 5, 2024