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

Calculated Attributes Seeding API

Bulk Profile Deletion API Reference

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

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

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

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

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

Web

Alexa

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Compose ID

Data Hosting Locations

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

Glossary

Rules Developer Guide

Media SDKs

Android

Web

iOS

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

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

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

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

Dashboard Filters

Organize Dashboards

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

Integrations

24i

Event

Aarki

Audience

Abakus

Event

AdChemix

Event

Actable

Feed

Adjust

Event

Feed

AdMedia

Audience

ABTasty

Audience

Adikteev

Audience

Event

Adobe Marketing Cloud

Cookie Sync

Event

Adobe Audience Manager

Audience

Adobe Target

Audience

Adobe Campaign Manager

Audience

AdPredictive

Feed

AgilOne

Event

Airship

Audience

Event

Feed

Algolia

Event

AlgoLift

Event

Feed

Alooma

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Advertising

Audience

Amazon Kinesis

Event

Amazon S3

Event

Amazon Redshift

Data Warehouse

Amazon SNS

Event

Amazon SQS

Event

Amobee

Audience

Adobe Marketing Cloud

Event

Amplitude

Event

Forwarding Data Subject Requests

Analytics

Audience

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

Anodot

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Apptentive

Event

Apptimize

Event

Apteligent

Event

Attentive

Event

Feed

Attractor

Event

Microsoft Azure Blob Storage

Event

Batch

Event

Audience

Bidease

Audience

Bing Ads

Event

Bluecore

Event

AppLovin

Audience

Event

Bluedot

Feed

Branch

Event

Feed

Forwarding Data Subject Requests

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Bugsnag

Event

Branch S2S Event

Event

Blueshift

Event

Feed

Forwarding Data Subject Requests

Cadent

Audience

Button

Audience

Event

Census

Feed

ciValue

Feed

Event

CleverTap

Audience

Event

Feed

Conversant

Event

Cordial

Feed

Audience

comScore

Event

Cortex

Event

Feed

Forwarding Data Subject Requests

Crossing Minds

Event

Criteo

Audience

Event

Custom Feed

Custom Feed

Customer.io

Audience

Event

Feed

CustomerGlu

Event

Feed

Datadog

Event

Didomi

Event

Dynalyst

Audience

Edge226

Audience

Dynamic Yield

Audience

Event

Epsilon

Event

Emarsys

Audience

Facebook

Audience

Event

Everflow

Audience

Fiksu

Audience

Event

Facebook Offline Conversions

Event

Google Analytics for Firebase

Event

Flybits

Event

Flurry

Event

ForeSee

Event

Foursquare

Audience

Feed

Formation

Event

Feed

FreeWheel Data Suite

Audience

Google Ad Manager

Audience

Google Ads

Audience

Event

Google Analytics

Event

Google Analytics 4

Event

Google BigQuery

Audience

Data Warehouse

Google Enhanced Conversions

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Marketing Platform Offline Conversions

Event

Google Cloud Storage

Audience

Event

Google Pub/Sub

Event

Heap

Event

Google Tag Manager

Event

Herow

Feed

Hyperlocology

Event

Ibotta

Event

Hightouch

Feed

Impact

Event

Indicative

Audience

Event

InMobi

Audience

Event

InMarket

Audience

Insider

Event

Audience

Feed

Intercom

Event

Inspectlet

Event

iPost

Audience

Feed

Iterable

Audience

Feed

Event

ironSource

Audience

Antavo

Feed

Jampp

Audience

Event

Kafka

Event

Kayzen

Audience

Event

Kissmetrics

Event

Klaviyo

Event

Audience

Kubit

Event

LaunchDarkly

Feed

Kochava

Event

Feed

Forwarding Data Subject Requests

Leanplum

Event

Audience

Feed

Liftoff

Audience

Event

LiveLike

Event

LifeStreet

Audience

Liveramp

Audience

Localytics

Event

MadHive

Audience

Marigold

Audience

Mailchimp

Audience

Event

Feed

mAdme Technologies

Event

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mixpanel

Audience

Forwarding Data Subject Requests

Event

MoEngage

Audience

Event

Feed

Moloco

Audience

Event

Movable Ink

Event

Monetate

Event

Movable Ink - V2

Event

Multiplied

Event

myTarget

Audience

Event

Nami ML

Feed

Nanigans

Event

NCR Aloha

Event

Narrative

Audience

Event

Feed

Neura

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle BlueKai

Event

Persona.ly

Audience

Oracle Responsys

Audience

Event

Paytronix

Feed

PieEye

Inbound Data Subject Requests

Personify XP

Event

Pilgrim

Feed

Event

Pinterest

Audience

Event

Plarin

Event

Postie

Audience

Event

Primer

Event

Punchh

Audience

Event

Feed

Quadratic Labs

Event

Pushwoosh

Event

Audience

Radar

Event

Feed

Reddit

Audience

Event

Regal

Event

Remerge

Event

Audience

Retina AI

Event

Feed

Reveal Mobile

Event

RevenueCat

Feed

Sailthru

Audience

Event

Rokt

Audience

Salesforce Mobile Push

Event

Salesforce Email

Audience

Event

Feed

RTB House

Audience

Event

Samba TV

Audience

Event

Scalarr

Event

SessionM

Event

Feed

SendGrid

Audience

Feed

ShareThis

Audience

Feed

Shopify

Custom Pixel

Feed

Signal

Event

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Audience

Event

Snowflake

Data Warehouse

Snapchat Conversions

Event

Snowplow

Event

Split

Event

Feed

Splunk MINT

Event

Sprig

Event

Audience

StartApp

Audience

Stormly

Audience

Event

Swrve

Event

Feed

Statsig

Event

Feed

Talon.One

Audience

Event

Feed

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Taptica

Audience

Teak

Audience

The Trade Desk

Audience

Cookie Sync

Event

Ticketure

Feed

TikTok Event

Audience (Deprecated)

Audience

Event

Audience Migration

Treasure Data

Audience

Event

Triton Digital

Audience

TUNE

Event

Twitter

Audience

Event

Valid

Event

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Wootric

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

YouAppi

Audience

Zendesk

Event

Feed

Z2A Digital

Audience

Event

Quantcast

Event

Qualtrics

Event

Event

This integration supports forwarding events to the Reddit Conversions API (CAPI). By activating this integration, you’ll be able to track conversions and measure the performance of your advertising campaigns on Reddit.

Prerequisites

To take advantage of the Reddit CAPI integration, you’ll need to:

  1. Create a Reddit Ads account
  2. Set up and authenticate a Reddit application

Supported Platforms

The mParticle integration with CAPI can support iOS, Android, and Web events; however, all events are ingested as Web events for now.

Supported Identifiers

Events are matched to redditors using matching parameters. Hashes of the following user identifiers are used, if available:

  • Customer ID
  • Email address

Note: mParticle will forward to Reddit the current consent state of the user at the time of the event. Learn more about the consent state object

Event Data Mapping

mParticle Commerce Event Reddit EventType Value
Page Visit PageVisit
View Content ViewContent
Add to Cart AddToCart
Add to Wishlist AddToWishList
Purchase Purchase

All mParticle events will be forwarded to Reddit as custom events using the event name passed. Additionally, specific mapping exists for the following mParticle configured custom events.

mParticle Custom Event Reddit EventType Value
Lead Lead
Signup SignUp
Search Search

Custom Event Mappings

In order to support alternative Reddit event types that don’t map one-to-one with mParticle events, we allow customers to manually configure Custom Mappings for a particular connection within our UI. This feature allows incoming mParticle events to be mapped to known Reddit event types, including with specific attributes and outgoing parameters.

Event Attributes not mapped will still send to Reddit as is.

Mappable Reddit Event Mappable Reddit Event Properties
AddToCart Currency, Item Count, Value Decimal, Product ID, Product Category, Product Name
AddToWishlist Currency, Item Count, Value Decimal, Product ID, Product Category, Product Name
Custom Currency, Item Count, Value Decimal, Product ID, Product Category, Product Name
Lead
PageVisit
Purchase Currency, Item Count, Value Decimal, Product ID, Product Category, Product Name
Search
SignUp
ViewContent Currency, Item Count, Value Decimal, Product ID, Product Category, Product Name

Event Metadata

When mParticle maps a commerce event, mParticle will send the following event metadata, if available:

  • Currency code
  • Item count
  • Value

Reddit Custom Flags

Reddit.ClickURL

Note: Important: Don’t hash this value! Hashing can obscure its uniqueness, making it difficult to accurately attribute conversions back to the original click. This can lead to discrepancies in conversion tracking and misallocation of credit for conversions.

You can specify a Custom Flag on each valid incoming event. This parameter represents the web page where the event took place and must be a complete URL, including its protocol (for example, https://).

  • The flag should be specified with the Reddit.ClickURL key.
  • We recommend explicitly retaining rdt_cid with a redirect to ensure this parameter appears to aid with increasing match rates. mParticle will look for the value of Reddit.ClickURL and forward it to Reddit.

Reddit.ConversionsId

The Reddit.ConversionsId custom flag links to a specific conversion event. Setting this flag can help prevent conversion events from being double-counted when they’re sent across both signal sources. You should pass a unique value per event to avoid impacting attribution and campaign performance

If the Reddit.ConversionsId is unhashed, Reddit will use SHA-256 to hash it before storing it in its system.

Reddit.UUID

Note: Important: Don’t hash this value! Hashing can obscure its uniqueness, making it difficult to accurately attribute conversions back to the original click. This can lead to discrepancies in conversion tracking and misallocation of credit for conversions.

An optional Reddit.UUID Custom Flag can be specified to pass the unique user ID from the _rdt_uuid cookie on your domain to Reddit. You can use the full value or the UUID portion when sending the value.

Reddit strongly recommends passing this information to help with attribution coverage and deduplication. If this isn’t done, Reddit can’t deduplicate events against corresponding matching Reddit Pixel and CAPI events.

Deduplication

The Reddit CAPI includes deduplication support through the Reddit.ConversionsId Custom Flag. This flag can be used to account for both single and multichannel redundancy.

Multichannel Deduplication

You can pass a unique Reddit.ConversionsId for every distinct event to its corresponding CAPI event. Reddit will determine which events are duplicates based on the Reddit.ConversionsId and the conversion event name. This is the best and most accurate way to ensure proper deduplication, and we recommend this method since there’s less risk of incorrect integration, which can impact our attribution accuracy.

To ensure your events are deduplicated:

  • Create a unique Reddit.ConversionsId for every distinct event. You can set this as a random number or ID. Similarly, you could set this to the order number when tracking purchase events.
  • Include the event in CAPI.
  • Ensure the conversion event name and Reddit.ConversionsId for its corresponding events match. Note: Important: If the Reddit.ConversionsId is improperly passed to too many multiple events, those events will be marked as duplicates and will not be attributed, impacting campaign performance.

Single Channel Deduplication

If the Reddit.ConversionsId isn’t specified for multichannel redundancy, Reddit the integration will set the field on outgoing events to facilitate single-channel deduplication. If so, the Reddit.ConversionsId field is set according to the given unique mParticle Event Identity field.

Configuration Settings

Setting Name Data Type Default Value Description
Advertiser ID string Your Advertiser ID, which you can find by navigating to Business > Users on Reddit Ads
Conversion Token string Your Reddit Conversion API Token obtained from the Conversion Access Token page
    Last Updated: November 15, 2024