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
Custom Access Roles API
Bulk Profile Deletion API Reference
Data Planning API
Group Identity API Reference
Calculated Attributes Seeding 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
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
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
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
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
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)
Introduction
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
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 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
Dashboards––Getting Started
Manage Dashboards
Dashboard Filters
Organize Dashboards
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
User Aliasing
The Demo Environment
Keyboard Shortcuts
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 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
Overview
Create and Manage Group Definitions
Introduction
Catalog
Live Stream
Data Plans
Blocked Data Backfill Guide
Predictive Attributes Overview
Create Predictive Attributes
Assess and Troubleshoot Predictions
Use Predictive Attributes in Campaigns
Predictive Audiences Overview
Using Predictive Audiences
Introduction
Profiles
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 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)
Aliasing
Event
Event
Audience
Audience
Event
Feed
Event
Cookie Sync
Audience
Audience
Audience
Audience
Event
Feed
Event
Event
Audience
Event
Data Warehouse
Event
Event
Event
Event
Audience
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
Audience
Event
Audience
Data Warehouse
Event
Event
Cookie Sync
Audience
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Event
Audience
Event
Event
Audience
Event
Event
Event
Audience
Feed
Audience
Event
Event
Audience
Audience
Event
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Audience
Feed
Event
Event
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Event
Data Warehouse
Event
Audience
Audience
Audience
Audience
Event
Audience
Audience
Cookie Sync
Event
Feed
Event
Audience
Event
Audience
Audience
Event
Event
Event
Event
Cookie Sync
Audience
Cookie Sync
Audience
Feed
Audience
Event
AgilOne is is a predictive marketing cloud that helps retailers deliver omni-channel experiences in order to increase customer loyalty and profitability.
In order to enable mParticle’s integration with AgilOne, you will need to work with your AgilOne representative to obtain credentials for your AgilOne environment. See Configuration Settings for details.
The AgilOne integration supports one Custom Flag: AgilOne.SubType. This custom flag is necessary for sending checkout events to AgilOne. Allowed values for this custom flag are: "Demand", "Canceled", "Shipped", or "Returned". If this flag is not set for an event where it is required, it defaults to "Demand".
mParticle forwards all custom events and user attributes to AgilOne, but for these to be captured, they must first be defined in the AgilOne dashboard. For this reason, unlike most integrations, the event filter for AgilOne initially sets all events to Off. You must manually enable each event you want to forward to AgilOne and ensure that the necessary event and attribute names are defined in the AgilOne dashboard.
You can provide credentials for both your Production and CS AgilOne environments in the configuration settings. mParticle will identify Development and Production events and forward them to the appropriate AgilOne environment. To use a development environment, you must explicitly set up separate event configurations for Production and Development. You cannot check Use same settings for Development and Production.
Each message forwarded to AgilOne contains up to four sections:
events: type and attributes of the event that occurred,customers: users involved in the event,transactions: id and attributes of any transaction in a commerce eventtransactionItems list of items involved in the transaction.We support the following AgilOne event types
| AgilOne Event | mParticle trigger |
|---|---|
productBrowsed |
Product Action - View Detail |
cartUpdated |
Product Action - Add to Cart / Remove from cart |
checkout |
Product Action - Purchase |
{{ custom event name }} |
Custom Event |
The following AgilOne events can also be supported with Custom Mappings
login logout onsiteSearch productBrowsed categoryBrowsedbrandBrowsedcartUpdated| AgilOne | mParticle | Required | Notes |
|---|---|---|---|
Type |
event.data.event_name |
Yes | Event type for standard events will be set as above. This mapping applies to custom types only, but the custom event must be defined in AgilOne before it can be captured. |
SourceCustomerNumber |
user_identities |
Yes | Customer ID used if available, if not, email can be used. If neither are available the event is not sent. |
SourceTransactionNumber |
event.data.product_action.transaction_id |
Only for checkout events. |
|
SourceProductNumber |
product.id |
Only for productBrowsed and cartUpdated events. |
|
EventTimestamp |
event.data.timestamp_unixtime_ms |
||
Variables |
device_info.http_header_user_agent |
mParticle forwards only a single key-value pair containing the UserAgent header. | |
UserClient |
Static value A is used for all events. |
||
cookie |
device_info |
Yes | Device ID - IDFV or GAID - is forwarded |
| AgilOne | mParticle | Required | Notes |
|---|---|---|---|
SourceCustomerNumber |
user_identities |
Yes | Customer ID used if available, if not, email can be used. If neither are available the event is not sent. |
Email |
user_identities |
Recommended | User identity where identity_type == "email", if available. |
MobileAdvertisingID |
device_info |
IDFA for iOS devices, GAID for Android. | |
MobileDeviceId |
device_info |
IDFV for iOS devices, Android ID for Android. | |
{{ custom attributes }} |
user_attributes |
User attributes are sent by mParticle but must be defined in AgilOne before they can be captured. |
These apply only to checkout events
| AgilOne | mParticle | Required | Notes |
|---|---|---|---|
SourceTransactionNumber |
event.data.product_action.transaction_id |
Yes | |
SourceOrganizationNumber |
Yes | Defined in configuration settings. | |
SourceCustomerNumber |
user_identities |
Yes | Customer ID used if available, if not, email can be used. If neither are available the event is not sent. |
Tax |
event.data.product_action.tax_amount |
||
Type |
Yes | For checkout events this value will always be purchase. |
These apply only to checkout events
| AgilOne | mParticle | Required | Notes |
|---|---|---|---|
SourceTransactionItemNumber |
event.data.product_action.transaction_id |
Yes | |
SourceOrganizationNumber |
Yes | Defined in configuration settings. | |
SaleRevenue |
product.quantity x product.price |
Recommended | |
Type |
Yes | For checkout events this value will always be purchase. |
|
SubType |
event.custom_flags.AgilOne.SubType |
Yes | This custom flag must be set to one of the following values: "Demand", "Canceled", "Shipped", or "Returned". If the custom flag is not set, the value defaults to "Demand". |
Discount |
product.coupon_code |
||
{{ product attributes }} |
product |
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Username | string |
Username for your AgileOne Account | |
| Password | string |
Password for your AgileOne Account | |
| Tenant | string |
The Tenant for your AgilOne Account | |
| Source Organization Number | string |
The Source Organization Number for your AgilOne Account |