Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
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
Group Identity API Reference
Custom Access Roles API
Data Planning API
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
AMP SDK
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 Plugin
Identity
Direct URL Routing FAQ
Web
Android
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
Getting Started
Identity
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
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
Getting Started
Identity
Web
Alexa
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
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
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 1. Create an input
Step 2. Create an output
Step 3. Verify output
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Data Hosting Locations
Glossary
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
Overview
Overview
User Profiles
Overview
Create and Manage Group Definitions
Calculated Attributes Overview
Using Calculated Attributes
Create with AI Assistance
Calculated Attributes Reference
What are predictive attributes?
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
Usage and Billing Report
Observability Overview
Observability User Guide
Observability Troubleshooting Examples
Observability Span Glossary
The new mParticle Experience
The Overview Map
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)
Audiences Overview
Create an Audience
Connect an Audience
Manage Audiences
Real-time Audiences (Legacy)
Standard Audiences (Legacy)
Predictive Audiences Overview
Using Predictive Audiences
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
Introduction
Core Analytics
Sync and Activate Analytics User Segments in mParticle
User Segment Activation
Welcome Page Announcements
Project Settings
Roles and Teammates
Organization Settings
Global Project Filters
Portfolio Analytics
Analytics Data Manager Overview
Events
Event Properties
User Properties
Revenue Mapping
Export Data
UTM Guide
Analyses Introduction
Getting Started
Visualization Options
For Clauses
Date Range and Time Settings
Calculator
Numerical Settings
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
Getting Started with Funnels
Group By Settings
Conversion Window
Tracking Properties
Date Range and Time Settings
Visualization Options
Interpreting a Funnel Analysis
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
Saved Analyses
Manage Analyses in Dashboards
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––Getting Started
Manage Dashboards
Organize Dashboards
Dashboard Filters
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
The Demo Environment
Keyboard Shortcuts
User Segments
Warehouse Sync
Data Privacy Controls
Data Subject Requests
Default Service Limits
Feeds
Cross-Account Audience Sharing
Approved Sub-Processors
Import Data with CSV Files
CSV File Reference
Glossary
Video Index
Single Sign-On (SSO)
Setup Examples
Introduction
Introduction
Introduction
Rudderstack
Google Tag Manager
Segment
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)
Aliasing
Event
Event
Audience
Feed
Audience
Event
Audience
Cookie Sync
Server-to-Server Events
Platform SDK Events
Audience
Audience
Audience
Feed
Event
Event
Event
Audience
Event
Data Warehouse
Event
Event
Audience
Event
Event
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Audience
Feed
Event
Event
Event
Custom Feed
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Event
Audience
Event
Event
Audience
Data Warehouse
Event
Cookie Sync
Audience
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Event
Audience
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Audience
Audience
Audience
Audience
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Feed
Event
Audience
Event
Event
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Audience
Event
Audience
Feed
Loyalty Feed
Audience
Audience
Event
Audience
Audience
Feed
Audience
Cookie Sync
Event
Audience
Event
Event
Audience
Event
Event
Audience
Event
Event
Audience
Cookie Sync
Feed
Audience
Cookie Sync
Audience
Event
LiveRamp gives companies and their partners the power to connect, control, and activate data to transform customer experiences and generate more valuable business outcomes. Our integration with LiveRamp enables you to push user audiences created in Audience Manager into your LiveRamp account to execute various marketing use cases.
In order to enable the mParticle integration with LiveRamp, you will need the credentials for the SFTP location used to upload files to LiveRamp.
Contact your LiveRamp rep and request that uploads from mParticle be enabled. Let your LiveRamp rep know which of your LiveRamp audiences you wish to upload Device and PII data to.
The LiveRamp integration only supports SFTP for uploading data to LiveRamp.
The LiveRamp integration currently only supports forwarding real-time audiences and cannot be used for standard audiences.
The Liveamp integration is only available in the US data center - see Data Localization..
Send PII to LiveRamp is selected, you will be able to select the columns and data contained in the PII file that is sent to LiveRamp. You will also have the option of hashing all email and phone values sent to LiveRamp. If Send Device IDs to LiveRamp is selected, the standard LiveRamp file format for DeviceIDs will be used and you will have the option to choose the file’s contents.Depending on the Connection Settings that you select see Connection Settings, LiveRamp will use one or more of the following IDs to match users:
If Send Device IDs to LiveRamp is selected, a file containing the following IDs will be sent to LiveRamp, depending on which identities are chosen:
If Send PII to LiveRamp is selected, a file containing the fields specified in the Connection Settings will be sent to LiveRamp:
$Mobile user attribute)$Mobile user attribute)The LiveRamp Audience Integration uploads data to the SFTP location you specify nightly at 12am EST. When the integration is first configured and connected to an Audience the first file(s) will be sent at 12am EST. As long as the integration is active, each night the audience membership will be evaluated and new file(s) will be uploaded to LiveRamp. This allows you to keep the audiences in LiveRamp and other downstream systems in sync.
When you connect an mParticle audience to LiveRamp, mParticle will upload a CSV file to LiveRamp nightly for each selected data type (Device and PII). The files will be named using a combination of your mParticle Org ID, the Audience ID, the upload date, and the data type. For example 3242_17095-D_2020-04-01.csv. Each file will be available as a “segment” in LiveRamp. You should ignore these segments in LiveRamp, unless you specifically want to distribute the mParticle audience as it was on one particular day.
LiveRamp will also create segments with names based on the External Name of the mParticle audience. For example, if your mParticle audience is called High-value customers, then the segments in LiveRamp will be called High-value customers-D (Device) and High-value customers-PII (PII). LiveRamp updates these segments each night based on the data uploaded by mParticle. These are the segments you should add to LiveRamp distributions, since LiveRamp will keep your distributions up to date as mParticle sends more data.
LiveRamp enforces certain file limitations for all files sent to LiveRamp. If you attempt to send data to LiveRamp that does not meet these criteria LiveRamp may not process the files.
mParticle doesn’t delete the downstream audience when you delete an audience in mParticle.
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Configuration Name | string |
Blank | The name of the integration configuration. |
| SFTP Settings | |||
| Username | string |
Blank | Username for logging into the SFTP destination. |
| Password | string |
Blank | Password for logging into the SFTP destination. |
| SFTP URL | string |
Blank | SFTP URL. |
| SFTP Port | string |
Blank | SFTP Port. |
| File Settings | |||
| Enable multi-audience files | bool |
False | If enabled, each file sent will contain the data for every connected audience, so there will be 0-2 files sent each day. If disabled, each file sent will contain the data for only one audience, so the number of files sent will depend on the number of audiences connected. If you have a large number of audiences, consult with your LiveRamp representative to determine if enabling this setting may optimize your file processing efficiency. |
| Encrypt this file | bool |
False | If enabled, all files sent to LiveRamp will be GPG/PGP-encrypted using LiveRamp’s public key and will be automatically decrypted when automated ingestion is set up within LiveRamp. Even if this option is not selected, the data will be securely transmitted using the SFTP protocol. |
| Data Type Settings | |||
| Send Device IDs to LiveRamp | bool |
False | If enabled, mParticle will send all Device IDs to LiveRamp. |
| Send PII to LiveRamp | bool |
False | If enabled, mParticle will send PII values the user selects to LiveRamp. |