Documentation
Developers
API References
Platform API
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
Data Subject Request API
Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
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
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
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
Server SDKs
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
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
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
Python Quick Start
Step 1. Create an input
Step 2. Create an output
Step 3. Verify output
Guides
Partners
Introduction
Outbound Integrations
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
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
Data Hosting Locations
Rules Developer Guide
The Developer's Guided Journey to mParticle
API Credential Management
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
Personalization
Introduction
Profiles
Audiences
Audiences Overview
Create an Audience
Connect an Audience
Manage Audiences
Real-time Audiences (Legacy)
Standard Audiences (Legacy)
Calculated Attributes
Calculated Attributes Overview
Using Calculated Attributes
Create with AI Assistance
Calculated Attributes Reference
Predictive Audiences
Predictive Audiences Overview
Using Predictive Audiences
Journeys
Journeys Overview
Manage Journeys
Download an audience from a journey
Audience A/B testing from a journey
Journeys 2.0
Predictive Attributes
What are predictive attributes?
Platform Guide
Billing
Usage and Billing Report
The New mParticle Experience
The new mParticle Experience
The Overview Map
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
User Attributes at Event Time
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
Export Results from a Funnel
Explore Users from a Funnel
Saved Analyses
Manage Analyses in Dashboards
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
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
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
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 (Snowplow Schema)
AWS S3 Integration (Define Your Own 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)
Developer Basics
Aliasing
Integrations
Abakus
Event
24i
Event
AdChemix
Event
Aarki
Audience
Actable
Feed
ABTasty
Audience
AdMedia
Audience
Adobe Audience Manager
Audience
Adobe Marketing Cloud
Cookie Sync
Event
Adobe Campaign Manager
Audience
AdPredictive
Feed
Adobe Target
Audience
AgilOne
Event
Algolia
Event
Amazon Advertising
Audience
Alooma
Event
Amazon Kinesis
Event
Amazon Redshift
Data Warehouse
Amazon S3
Event
Amazon SNS
Event
Adobe Marketing Cloud
Event
Amazon SQS
Event
Amobee
Audience
Anodot
Event
Apptimize
Event
Apptentive
Event
Apteligent
Event
Attractor
Event
Microsoft Azure Blob Storage
Event
Antavo
Feed
Bing Ads
Event
Bidease
Audience
Bluecore
Event
Bluedot
Feed
Branch S2S Event
Event
Bugsnag
Event
Cadent
Audience
Census
Feed
comScore
Event
Conversant
Event
Crossing Minds
Event
Custom Feed
Custom Feed
Databricks
Data Warehouse
Datadog
Event
Dynalyst
Audience
Edge226
Audience
Didomi
Event
Emarsys
Audience
Epsilon
Event
Everflow
Audience
Facebook Offline Conversions
Event
Google Analytics for Firebase
Event
Flybits
Event
Flurry
Event
ForeSee
Event
FreeWheel Data Suite
Audience
Google Ad Manager
Audience
Google Analytics
Event
Google Analytics 4
Event
Google BigQuery
Audience
Data Warehouse
Google Marketing Platform
Audience
Cookie Sync
Event
Google Enhanced Conversions
Event
Google Tag Manager
Event
Heap
Event
Google Marketing Platform Offline Conversions
Event
Google Pub/Sub
Event
Herow
Feed
Hightouch
Feed
Hyperlocology
Event
Ibotta
Event
Impact
Event
InMarket
Audience
Inspectlet
Event
Intercom
Event
ironSource
Audience
Kafka
Event
Kissmetrics
Event
Kubit
Event
LaunchDarkly
Feed
LifeStreet
Audience
LiveLike
Event
Liveramp
Audience
Localytics
Event
MadHive
Audience
mAdme Technologies
Event
Marigold
Audience
MediaMath
Audience
Mediasmart
Audience
Microsoft Azure Event Hubs
Event
Mintegral
Audience
Monetate
Event
Movable Ink - V2
Event
Movable Ink
Event
Multiplied
Event
Nami ML
Feed
Nanigans
Event
NCR Aloha
Event
OneTrust
Event
Neura
Event
Oracle BlueKai
Event
Paytronix
Feed
Persona.ly
Audience
Personify XP
Event
Plarin
Event
Primer
Event
Quantcast
Event
Qualtrics
Event
Regal
Event
Reveal Mobile
Event
RevenueCat
Feed
Salesforce Mobile Push
Event
Scalarr
Event
Shopify
Custom Pixel
Feed
Signal
Event
SimpleReach
Event
Singular-DEPRECATED
Event
Skyhook
Event
Slack
Event
Smadex
Audience
SmarterHQ
Event
Snowflake
Data Warehouse
Snowplow
Event
Snapchat Conversions
Event
Splunk MINT
Event
StartApp
Audience
Talon.One
Event
Loyalty Feed
Audience
Feed
Tapad
Audience
Tapjoy
Audience
Taptica
Audience
Taplytics
Event
Teak
Audience
Ticketure
Feed
The Trade Desk
Audience
Cookie Sync
Event
Triton Digital
Audience
TUNE
Event
Valid
Event
Vkontakte
Audience
Vungle
Audience
Webhook
Event
Webtrends
Event
White Label Loyalty
Event
Xandr
Audience
Cookie Sync
Wootric
Event
Yahoo (formerly Verizon Media)
Cookie Sync
Audience
YouAppi
Audience
Yotpo
Feed
Quadratic Labs
Event
Event
Rokt is an ecommerce marketing platform that allows you to provide your customers with more personalized and relevant experience.
By forwarding your conversion event data from mParticle to Rokt, you can further increase the relevance of the ads and messaging your deliver to your customers.
Prerequisites
Before setting up the Rokt events integration, reach out ot your Rokt account manager to obtain:
- Your Rokt API secret key
-
Your Rokt Account ID
- You can also find your Rokt Account ID by logging into Rokt, selecting the Rokt account you want to connect mParticle to in the left hand nav, and copying the digits following
my.rokt.com/accounts/in the URL displayed in your web browser.
- You can also find your Rokt Account ID by logging into Rokt, selecting the Rokt account you want to connect mParticle to in the left hand nav, and copying the digits following
Supported inputs
The mParticle event integration for Rokt supports connections with the following inputs:
- iOS
- Android
- Web
- Data Feeds
- tvOS
- SmartTV
- Roku
- Xbox
- FireTV
- Alexa
Supported user identities
mParticle can forward the following user identities to Rokt:
emailotherother_id_2other_id_3other_id_4other_id_5other_id_6other_id_7other_id_8other_id_9other_id_10
Rokt events integration setup instructions
There are three stages to setting up the mParticle event integration for Rokt:
- Create a Rokt output configuration.
- Create a connection between an mParticle input and your new Rokt output configuration.
- Configure your custom mappings between mParticle events and Rokt events.
1. Create a Rokt output configuration
- Log in to your mParticle account, and navigate to the Integrations Directory.
- Search for “Rokt”, hover your cursor over the Rokt tile and click Setup.
- Check the box labeled Event and click Configure.
- Enter a descriptive name under Configuration Name.
-
Check the box “Use same settings for Development & Production” if you want to use the same configuration settings when testing the integration in your development environment.
- If you leave this unchecked, select whether this configuration will be for Production (Prod) or Development (Dev) environment data.
- Under API Key, enter the API secret key you obtained from your Rokt account manager.
- Enter your Rokt User ID under Rokt Account ID.
- Click Save.
2. Connect an input to your Rokt output
- From your mParticle account, navigate to Connections > Connect in the left hand navigation.
- Select one of the supported configured inputs.
- Click Connect Output, and select Rokt from the list of outputs. Select the configuration you just created from the Configuration Name dropdown menu and click Next.
-
Set Connection Status to Active or Inactive.
- You can always activate a connection later after completing the configuration, but only active connections will forward data to Rokt.
- Click Add Connection.
3. Configure custom mappings
In order to forward event data to Rokt, you must set up custom mappings for each of the supported event types and their respective event attributes. See the Event mapping section below for a reference of the supported Rokt event types and their attributes.
To configure your custom mappings:
- Click Custom Mapping from your Rokt connection page in the mParticle UI.
- For each Rokt event type listed under Custom Mappings, use the Event/Screen to Map dropdown to select the mParticle event you want to map to that Rokt event type.
- For each attribute, use the dropdown menu to select the mParticle event attribute you want to map to the Rokt event attribute.
- After you’ve configured your custom mapping for each event you want forwarded, click Save.
Event mapping
mParticle allows you to create custom mappings for each of the following Rokt event types and their corresponding event attributes.
Supported Rokt event types
- add_payment_info
- add_to_cart
- add_to_wishlist
- app_install
- conversion
- first_time_deposit
- purchase
- sign_up
- subscription_started
add_payment_info
Event attributes
| Rokt event attribute | Data type | Description |
|---|---|---|
ccbin |
String | The bank identification number for the credit or debit card provided. This is usually the first 6 to 8 digits of the card number. |
payment_type |
String | The type of payment added. For example: visa. |
add_to_cart
Event attributes
| Rokt event attribute | Data type | Description |
|---|---|---|
ammount |
Decimal | The total price of all items added to the cart. For example, set amount to 20.00 for $20. |
currency |
String | The currency code for the items added. For example: USD. |
productname |
String | The name of item added to the cart. For multiple items, provide a comma separated list of strings. |
quantity |
Integer | The number of items added to the cart. |
sku |
String | The SKU for the item added to the cart. If more than one item is added, do not provide any SKUs. |
add_to_wishlist
Event attributes
| Rokt event attribute | Data type | Description |
|---|---|---|
ammount |
Decimal | The total price of all items added to the cart. For example, set amount to 20.00 for $20. |
currency |
String | The currency code for the items added. For example: USD. |
productname |
String | The name of item added to the cart. For multiple items, provide a comma separated list of strings. |
quantity |
Integer | The number of items added to the cart. |
sku |
String | The SKU for the item added to the cart. If more than one item is added, do not provide any SKUs. |
app_install
Rokt does not accept any custom event attributes for the app_install event type.
conversion
Event attributes
| Rokt event attribute | Data type | Description |
|---|---|---|
ammount |
Decimal | The total price of all items. For example, if the total price of all items is $20, set amount to 20.00. |
ccbin |
String | The bank identification number for the credit or debit card provided. This is usually the first 6 to 8 digits of the card number. |
currency |
String | The currency code for the items. For example: USD. |
margin |
Decimal | The total profit margin of the conversion or transaction. |
payment_type |
String | The type of payment added. For example: visa. |
productname |
String | The name of the item(s). For multiple items, provide a comma separated list of strings. |
quantity |
Integer | The total number of items. |
sku |
String | The SKU for the item. If more than one item is present, do not provide any SKUs. |
first_time_deposit
Event attributes
| Rokt event attribute | Data type | Description |
|---|---|---|
ammount |
Decimal | The total price of all items. For example, if the total price of all items is $20, set amount to 20.00. |
ccbin |
String | The bank identification number for the credit or debit card provided. This is usually the first 6 to 8 digits of the card number. |
currency |
String | The currency code for the items. For example: USD. |
payment_type |
String | The type of payment added. For example: visa. |
productname |
String | The name of item added to the cart. For multiple items, provide a comma separated list of strings. |
purchase
Event attributes
| Rokt event attribute | Data type | Description |
|---|---|---|
ammount |
Decimal | The total price of all items. For example, if the total price of all items is $20, set amount to 20.00. |
ccbin |
String | The bank identification number for the credit or debit card provided. This is usually the first 6 to 8 digits of the card number. |
currency |
String | The currency code for the items. For example: USD. |
margin |
Decimal | The total profit margin of the conversion or transaction. |
payment_type |
String | The type of payment added. For example: visa. |
productname |
String | The name of the item(s). For multiple items, provide a comma separated list of strings. |
quantity |
Integer | The total number of items. |
sku |
String | The SKU for the item. If more than one item is present, do not provide any SKUs. |
sign_up
Rokt does not accept any custom event attributes for the sign_up event type.
subscription_started
Event attributes
| Rokt event attribute | Data type | Description |
|---|---|---|
ammount |
Decimal | The total price of all items. For example, if the total price of all items is $20, set amount to 20.00. |
ccbin |
String | The bank identification number for the credit or debit card provided. This is usually the first 6 to 8 digits of the card number. |
currency |
String | The currency code for the items. For example: USD. |
payment_type |
String | The type of payment added. For example: visa. |
productname |
String | The name of the item(s). For multiple items, provide a comma separated list of strings. |
Settings
Configuration settings
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| API key | string |
none | 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 |
none | Your Rokt Account ID. |
Connection settings
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Connection Status | boolean |
Inactive | Determines if mParticle is actively forwarding data to Rokt. |
- Last Updated: February 18, 2025