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
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
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
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
Server SDKs
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
Guides
Partners
Introduction
Outbound Integrations
Outbound Integrations
Firehose Java SDK
Inbound Integrations
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
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
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
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
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
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 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)
Developer Basics
Aliasing
Calculated Attributes Reference
Use the following tables and lists to help you define each calculated attribute.
Calculations
The following table lists all supported calculations.
| Group | Calculation Type | Format | Example | Trigger |
|---|---|---|---|---|
| Count | Count | Numeric | 123 |
*synchronous |
| Aggregation | Sum | Numeric | 123.123 |
*synchronous |
| Aggregation | Minimum | Numeric | 123.123 |
*synchronous |
| Aggregation | Maximum | Numeric | 123.123 |
*synchronous |
| Aggregation | Average | Numeric | 123.123 |
asynchronous |
| Aggregation | Most frequent | Dynamic | romance |
asynchronous |
| Aggregation | Unique values count | Numeric | 34 |
asynchronous |
| Occurrence | First value | Dynamic | comedy |
asynchronous (until observed) |
| Occurrence | Last value | Dynamic | action |
asynchronous |
| Occurrence | First timestamp | Timestamp | 2020-01-01T22:14:47.1051728Z |
asynchronous (until observed) |
| Occurrence | Last timestamp | Timestamp | 2020-01-10T22:14:47.1051728Z |
*synchronous |
| List | Unique list | Comma separated list of dynamic values; maximum of 100. | "Item 1","Item 2","Item 3" |
*synchronous |
*Setting the date range to Within the Last causes all calculations to be asynchronous.
Be aware of the following before creating your calculation attributes:
- Calculated attributes require server-side forwarding. Therefore, this feature isn’t available for kit-only integrations that solely support client-side forwarding.
- All timestamp values are in ISO 8601 format in the UTC timezone.
- Several calculations produce results with types that depend on the type of the event attribute selected; for example,
FirstValue` returns a string if the selected event attribute is a string. All attribute values in our platform are stored as strings, including calculated attributes. - Calculation speeds listed are after the values have been initialized.
- For unique lists, up to 100 values are calculated. The values are selected based roughly on the order in which mParticle received the data, though the ordering is not guaranteed. When viewing and using unique lists values (in User activity view, Profile API etc.), values are returned in alphabetical order.
- When using aliasing to transition from an anonymous to a known user profile, mParticle doesn’t copy the calculated attribute or trigger a recalculation on the resulting profile.
-
For aggregation CAs:
- More than one attribute may occur the same number of times, creating a tie. To break the tie, mParticle sorts the attribute name alphabetically and chooses the first attribute.
- After the first 100 values are collected for a
Most FrequentorUnique ListCA, no more values are collected. ForMost Frequent, the frequency of the first 100 are continuously evaluated, but no new values are added. ForUnique List, mParticle keeps only the first 100 seen values. To trigger a re-collection of values for either calculation type, edit the CA definition or create a new one.
Calculation date range
The following date ranges in calculated attributes are supported:
- Within the Last: limit calculations to the period of a specified number of days or weeks ago to now. For example, “most frequent product categories viewed over the last 30 days.”
- Since: limit calculations to the period of a specified start date to now.
Type conversions
Some calculated attributes, like sum, require numeric event attributes to function. If you select an attribute that is not detected as the correct type, the platform will warn you about using those fields in the calculated attribute definition. You can still use the calculated attribute despite the warning, and it will attempt to convert the string values into numerics. For example, if you pass the attribute amount in as a numeric string like "34.32", a sum calculation will still work correctly: the string "34.32" will be converted to the decimal value 34.32.
Conditions
When you define a calculated attribute, you can add conditional logic. For example, if you wanted to count the total number of times a promotion was clicked, but only for certain currencies, you could add the condition “where the currency code is only AUD or EUR.”
The following conditions are available for all four categories of calculated attributes (Count, Aggregation, Occurrence, and List):
- Contains
- Does not Contain
- Exact Match
- Does not Match
- Pattern
- Exists
- Not Exists
- Is Empty
- Is In List
Commerce quantity fields
The following behaviors affect commerce event attributes (commerce_events) in some calculated attributes:
Product events
The product action (product_action) and product impression (product_impression) attributes can be used in the quantity field for calculations. Note the following behaviors:
- Average uses the quantity field in a product array when averaging the value of the price field.
- First value picks the first product in an array if the product attribute is selected.
- Last value picks the last product in an array if the product attribute is selected.
- First timestamp is the batch timestamp.
- Last timestamp is the batch timestamp.
- Unique list can pick any field in an events or products array.
- Most frequent uses quantity for calculating the most frequent for non-numeric fields such as brand, category, or coupon code.
Promotion events
The promotion action (promotion_action) attribute can be used in the quantity field for calculations. Note the following behaviors:
- First value picks the first promotion in a promotions array.
- Last value picks the last promotion in a promotions array.
- First timestamp is the batch timestamp.
- Last timestamp is the batch timestamp.
- Unique list can pick any field in an events or promotions array.
- Most frequent can pick any field in an events or promotions array.
Was this page helpful?
- Last Updated: November 20, 2024