Sign Up

Documentation

Developers

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

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Cordova

Cordova Plugin

Identity

Flutter

Getting Started

Usage

API Reference

iOS

Initialization

Configuration

Event Tracking

User Attributes

IDSync

Screen Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Opt Out

Error Tracking

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

Alexa

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

Quickstart
HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

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

Java 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

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

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Media SDKs

Android

iOS

Web

Tools

Linting Tools

mParticle Command Line Interface

Smartype

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

JavaScript Kit Integration

Android Kit Integration

iOS Kit Integration

Compose ID

Data Hosting Locations

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

Customer 360

Overview

User Profiles

Overview

User Profiles

Group Identity

Overview

Create and Manage Group Definitions

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Predictive Attributes

What are predictive attributes?

Predict Future Behavior

Create Future Prediction

Use Future Predictions in Campaigns

Assess and Troubleshoot Predictions

Next Best Action

Next Best Action Overview

Create a Next Best Action (NBA)

View and Manage NBAs

Activate Next Best Actions in Campaigns

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
Billing

Usage and Billing Report

The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

Event Forwarding

System Alerts

Trends

Introduction

Data Retention

Data Catalog

Connections

Activity

Data Plans

Live Stream

Filters

Rules

Blocked Data Backfill Guide

Tiered Events

mParticle Users and Roles

Analytics Free Trial

Troubleshooting mParticle

Usage metering for value-based pricing (VBP)

Segmentation
New Audiences Experience

Audiences Overview

Create an Audience

Connect an Audience

Manage Audiences

FAQ

Classic Audiences Experience

Real-time Audiences (Legacy)

Standard Audiences (Legacy)

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

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

Analytics

Introduction

Core Analytics (Beta)

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

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

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

User Attributes at Event Time

Understanding the Screen View Event

User Aliasing

Dashboards

Dashboards––Getting Started

Manage Dashboards

Organize Dashboards

Dashboard Filters

Scheduled Reports

Favorites

Time and Interval Settings in Dashboards

Query Notes in Dashboards

Analytics Resources

The Demo Environment

Keyboard Shortcuts

User Segments

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

APIs

User Segments Export API

Dashboard Filter API

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

Integrations

Aarki

Audience

Abakus

Event

24i

Event

ABTasty

Audience

Actable

Feed

Adikteev

Audience

Event

Adjust

Event

Feed

AdMedia

Audience

Adobe Audience Manager

Audience

Adobe Marketing Cloud

Cookie Sync

Platform SDK Events

Server-to-Server Events

Adobe Campaign Manager

Audience

AdChemix

Event

Adobe Target

Audience

AdPredictive

Feed

AgilOne

Event

Airship

Audience

Feed

Event

Algolia

Event

AlgoLift

Event

Feed

Alooma

Event

Amazon Advertising

Audience

Amazon Redshift

Data Warehouse

Amazon Kinesis

Event

Amazon Kinesis Firehose

Event

Audience

Amazon S3

Event

Amazon SQS

Event

Amazon SNS

Event

Amobee

Audience

Ampush

Audience

Event

Amplitude

Forwarding Data Subject Requests

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

Anodot

Event

Antavo

Feed

Apptentive

Event

AppLovin

Audience

Event

Apptimize

Event

Apteligent

Event

Attentive

Event

Feed

Attractor

Event

Batch

Event

Audience

Bing Ads

Event

Microsoft Azure Blob Storage

Event

Bidease

Audience

Bluecore

Event

Bluedot

Feed

Branch

Feed

Event

Forwarding Data Subject Requests

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Bugsnag

Event

Button

Event

Audience

Census

Feed

ciValue

Event

Feed

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Cadent

Audience

CleverTap

Audience

Event

Feed

comScore

Event

Conversant

Event

Cortex

Event

Feed

Forwarding Data Subject Requests

Criteo

Audience

Event

Cordial

Audience

Feed

Custom Feed

Custom Feed

Crossing Minds

Event

CustomerGlu

Feed

Event

Customer.io

Audience

Event

Feed

Databricks

Data Warehouse

Datadog

Event

Didomi

Event

Dynalyst

Audience

Dynamic Yield

Audience

Event

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Facebook

Audience

Event

Facebook Offline Conversions

Event

Everflow

Audience

Fiksu

Audience

Event

Google Analytics for Firebase

Event

Flurry

Event

Flybits

Event

Formation

Event

Feed

ForeSee

Event

Foursquare

Audience

Feed

FreeWheel Data Suite

Audience

Friendbuy

Event

Google Ads

Event

Audience

Google Ad Manager

Audience

Google Analytics

Event

Google BigQuery

Audience

Data Warehouse

Google Cloud Storage

Audience

Event

Google Analytics 4

Event

Google Enhanced Conversions

Event

Google Marketing Platform

Audience

Event

Cookie Sync

Google Marketing Platform Offline Conversions

Event

Google Pub/Sub

Event

Google Tag Manager

Event

Heap

Event

Hightouch

Feed

Herow

Feed

Ibotta

Event

Hyperlocology

Event

ID5

Kit

Impact

Event

InMarket

Audience

Insider

Event

Feed

Audience

InMobi

Audience

Event

Inspectlet

Event

iPost

Audience

Feed

ironSource

Audience

Iterable

Audience

Event

Feed

Jampp

Audience

Event

Kafka

Event

Kayzen

Audience

Event

Klaviyo

Event

Audience

Kissmetrics

Event

Kubit

Event

LaunchDarkly

Feed

Leanplum

Audience

Event

Feed

Kochava

Event

Forwarding Data Subject Requests

Feed

LifeStreet

Audience

Liftoff

Event

Audience

LinkedIn

LinkedIn Conversions API Integration

LiveLike

Event

Liveramp

Audience

Localytics

Event

MadHive

Audience

Mailchimp

Audience

Feed

Event

Intercom

Event

Marigold

Audience

mAdme Technologies

Event

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Mintegral

Audience

Microsoft Azure Event Hubs

Event

Mixpanel

Audience

Forwarding Data Subject Requests

Event

Moloco

Audience

Event

Monetate

Event

MoEngage

Audience

Event

Feed

Movable Ink

Event

Movable Ink - V2

Event

Multiplied

Event

Nami ML

Feed

myTarget

Audience

Event

Nanigans

Event

Narrative

Audience

Event

Feed

NCR Aloha

Event

Neura

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle BlueKai

Event

Oracle Responsys

Audience

Event

Persona.ly

Audience

Paytronix

Feed

Pilgrim

Event

Feed

Personify XP

Event

Pinterest

Audience

Event

PieEye

Inbound Data Subject Requests

Plarin

Event

Primer

Event

Postie

Audience

Event

Quadratic Labs

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Punchh

Audience

Event

Feed

Quantcast

Event

Qualtrics

Event

Radar

Feed

Event

Reddit

Audience

Event

Rakuten

Event

Regal

Event

Remerge

Audience

Event

Retina AI

Feed

Event

Reveal Mobile

Event

Rokt

Audience

Event

RevenueCat

Feed

RTB House

Audience

Event

Sailthru

Audience

Event

Salesforce Email

Feed

Audience

Event

Salesforce Mobile Push

Event

Samba TV

Audience

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

Shopify

Custom Pixel

Feed

Salesforce Sales and Service Cloud

Event

ShareThis

Audience

Feed

Signal

Event

SimpleReach

Event

Skyhook

Event

Singular

Event

Feed

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Audience

Event

Snapchat Conversions

Event

Snowflake

Data Warehouse

Singular-DEPRECATED

Event

Snowplow

Event

Split

Event

Feed

Splunk MINT

Event

Sprig

Event

Audience

StartApp

Audience

Stormly

Audience

Event

Statsig

Event

Feed

Swrve

Feed

Event

Talon.One

Event

Audience

Loyalty Feed

Feed

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Taptica

Audience

Teak

Audience

The Trade Desk

Cookie Sync

Audience

Event

Ticketure

Feed

TikTok Event

Audience

Audience (Deprecated)

Audience Migration

Event

Treasure Data

Audience

Event

Triton Digital

Audience

Twitter

Event

Audience

TUNE

Event

Valid

Event

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Xandr

Audience

Cookie Sync

Wootric

Event

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Zendesk

Feed

Event

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Pushwoosh

Audience

Event

Audience

Rokt is an ecommerce marketing technology that gives customers a more personalized and relevant experience while buying online.

Prerequisites

The outbound integration for Rokt supports two authentication methods: using a Rokt API key, or using a Rokt public key/secret key pair. Before setting up your configuration, reach out ot your Rokt account manager to obtain the necessary credentials depending on your authentication method.

Regardless of the authentication method you use, you will also need your Rokt Account ID. You can ask your Rokt account representative for your account ID, or you can find it yourself:

  1. Log into my.rokt.com
  2. Select the Rokt account you want to connect mParticle to in the left hand nav
  3. Copy the digits following my.rokt.com/accounts/ in the URL displayed in your web browser. This is your account ID.

Authenticate via API Key

Credentials to obtain from your Rokt account representative:

  • Rokt API Key

Authenticate via Rokt public/secret key pair

Credentials to obtain from your Rokt account representative:

  • Rokt public key
  • Rokt secret key

Supported Identities

User Identities

mParticle can forward the following user identities to Rokt:

  • email
  • mpid
  • phone_number

Rokt audiences integration setup instructions

There are two stages to setting up the mParticle audience integration for Rokt:

  1. Create a Rokt audiences output configuration
  2. Connect an audiences to your Rokt output

1. Create a Rokt audiences output configuration

  1. Log in to your mParticle account, and navigate to the Data Platform > Setup > Directory.
  2. Search for “Rokt”, hover your cursor over the Rokt tile and click Setup.
  3. Check the box labeled Audiences and click Configure.
  4. Enter a descriptive name under Configuration Name.
  5. Enter your Rokt Account ID.

  6. Enter your authentication credentials. You can authenticate in two ways, but credentials for at least one method must be present to complete your configuration. If you provide credentials for both methods, mParticle will use your public/secret key pair by default.

    • Enter your Rokt API key you obtained from your Rokt account manager, or
    • Enter your Rokt public key and secret key.

  7. Use the Email encoding dropdown to select your email encoding settings:

    • Raw is the default setting, and forwards email addresses to Rokt unencoded.
    • Sha256 encodes email addresses using the SHA-256 hashing algorithm before sending them to Rokt.

  8. Use the Mobile number encoding dropdown to select your mobile number encoding settings:

    • None is the default setting. If you leave this set to None, no mobile phone numbers are sent to Rokt.
    • Raw sends unencoded mobile phone numbers to Rokt.
    • Sha256 encodes mobile phone numbers using the SHA-256 hashing algorithm before sending them to Rokt.
  9. Click Save.

2. Connect an audience to your Rokt output

  1. In the mParticle UI, hover your cursor over Segmentation in the left hand nav and select Audiences.
  2. Select the audience you want to send to Rokt and expand the audience configuration settings.
  3. Click +Connect Output and select your new Rokt audience output configuration.
  4. Toggle the Connection Status to Active to begin selecting user attributes to forward to Rokt.
  5. In the User Attribute Forwarding section of the connection settings, select which Account Level and Workspace Level user attributes you want forwarded with your audiences.

  6. Check Hash First Name, Hash Last Name, or Hash Zip Code if you want to encode any of these attributes before forwarding them to Rokt.

    • You must also select these user attributes under User Attribute Forwarding for them to be hashed and forwarded. Enabling hashing for an attribute will not automatically add it to the list of attributes to forward.
  7. Click Add Connection.

Settings

Configuration Settings

Setting Name Data Type Default Value Description
API Key string The Rokt API secret key for authenticating to the Rokt Events API. You must use your secret key, not your public key.
Rokt account id string Your Rokt Account ID.
Email encoding string Raw Determines if email addresses are encoded before being sent to Rokt. If you select Raw, addresses are not encoded. If you select Sha256, addresses are encoded using a SHA-256 hashing algorithm.
Mobile number encoding string None Determines if mobile phone numbers are sent to Rokt, and if they’re encoded before being forwarded. If you select None, mobile numbers are not forwarded to Rokt. If you select Raw, they will be forwarded unencoded. If you select Sha256, they are encoded using a SHA-256 hashing algorithm before being forwarded.
Rokt public key string Your Rokt public key obtained from your Rokt account representative.
Rokt secret key string Your Rokt secret key obtained from your Rokt account representative.

Connection Settings

Setting Name Data Type Default Value Description
Connection Status boolean Inactive Determines if mParticle is actively forwarding data to Rokt.
Hash First Name boolean False If enabled, $firstname is hashed using SHA256 with UTF-8 encoding before being sent to Rokt. You must also select $firstname in User Attribute Forwarding for this attribute to be forwarded.
Hash Last Name boolean False If enabled, $lastname is hashed using SHA256 with UTF-8 encoding before being sent to Rokt. You must also select $lastname in User Attribute Forwarding for this attribute to be forwarded.
Hash Zip Code boolean False If enabled, $zip is hashed using SHA256 with UTF-8 encoding before being sent to Rokt. You must also select $zip in User Attribute Forwarding for this attribute to be forwarded.
User Attribute Forwarding array n/a Allows you to select which user attributes within your mParticle Account and/or Workspace to include with the audience data sent to Rokt.
    Last Updated: April 25, 2025