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

Manage Dashboards

Any Segmentation, Funnel, Cohort, or Users query may be saved to a dashboard. Dashboards are often used to:

  • Monitor your core KPIs regularly
  • Quickly explore data anomalies
  • Share periodic results with a team, department, or executives

From the Manage dialog in the upper right corner of every dashboard, you can:

Growth enterprise

Dashboard settings

To access your Dashboard Settings:

  1. Click the Saved section in the left-hand navigation menu and select a dashboard.
  2. Select Manage in the top right corner of your dashboard.
  3. Select Dashboard Settings to open the dialog.

From Dashboard Settings, you can perform the following tasks:

Modify dashboard title

In the Dashboard Settings dialog, type your desired dashboard name in the Title field. You can also rename your dashboard by clicking on the title in the top left corner of your dashboard.

Title

Modify dashboard description

In the Dashboard Settings dialog, type a description in the Description field.

Your new description will be reflected in the top left corner of your dashboard.

Description

Change widget layout flow

In the Dashboard Settings dialog, select a Widget Layout Flow.

Widget layout flow
  • Free Flow lets you place your dashboard analyses wherever you choose.
  • Auto Flow automatically compacts analyses to the top of your dashboard.

Check out the Dashboard Visualization article for more information on organizing your dashboard.

Change dashboard layout mode

In the Dashboard Settings dialog, choose how to display your dashboard: screen or print mode.

Dashboard layout mode
  • Screen Mode is optimized for web browsers. This is the default layout mode.
  • Print Mode is optimized for printing your dashboard and for scheduled reports.

In print mode, you may choose to display the following:

  • Show simulated paper
  • Show title
  • Show description
  • Show date uploaded

Check out the Dashboard Visualization article for more information on screen and print modes.

Change widget color matching

The Widget Color Matching feature within dashboard settings allows Analytics users to easily digest the widgets of their dashboards. Widgets that share the same series match visualization colors for easy comparison across the dashboard.

Note that undefined values will always be black.

To enable widget color matching, go to Manage > Dashboard Settings, and then select On.

Widget color matching

Once selected, widgets in the same series will match:

Widget color matching

Note: Colors persist even when opening a widget from a dashboard.

Although different widgets may query different events, series can still color match if they share the same breakout value.

Notice that the Funnel widget and the Segmentation widget below share the same breakout values. Although both widgets measure different events, their overlapping breakout values share the same color.

Breakout values display

Identical series are defined as the following:

  • Segmentation: Identical series are defined by the Total Count Of/Users Who Performed selection, event name, and breakout values
  • Frequency: Identical series are defined by frequency groupings
  • Funnel: Each step within a funnel is defaulted to a green color unless there are breakout values
  • Journeys: Defined by event name

Switch to full screen

In the Dashboard Settings dialog, toggle full-screen mode settings.

Full screen

You may toggle the following:

  • Show title
  • Show description

You may also copy to your clipboard a direct link to a full-screen version of your dashboard. For more information on full-screen mode, visit the Organize Dashboards article.

Enable public access

A dashboard may also be made publicly available. This means that anyone with the Public Access Link can view your dashboard.

To make a dashboard publicly available, from the Dialog Settings dialog, check the “Public Access” checkbox. Then, simply click to copy your shareable link to your clipboard. You may also generate a new public link by clicking Reset Access.

Public access

Filter public dashboards via API

Analytics supports the ability to filter public dashboards programmatically via an API. You may create variants of your public dashboards by bulk adjusting each analysis’ Date Ranges, Time Zones, Query Intervals, and Property Filters.

The Dashboard Settings dialog provides the dashboard variant API endpoint:

Filtering public dashboards via API

However, please see our Dashboard Filter API documentation to filter public dashboards via the API. This feature requires advanced instrumentation from a technical resource.

Analytics uses an algorithm to balance data ‘freshness’ and efficient resource utilization when refreshing dashboards. When you apply a new filter to a dashboard or widget, please allow up to 15 minutes for changes to be reflected in the dashboard’s variants. Subsequently, each request to render a dashboard or widget will display the most recently cached result before initiating an update.

Dashboard privileges

If you are on the Enterprise plan and are the Dashboard Owner, you can control whether or not team members can edit a dashboard. All team members with the correct user permissions can edit a dashboard by default. Dashboard privileges do not override user permissions.

To change the dashboard editing privileges for team members:

  1. Click the Saved section in the left-hand navigation menu and select a dashboard. Filtering public dashboards via API
  2. Select Manage in the top right corner of your dashboard. Filtering public dashboards via API
  3. Select Dashboard Privileges to open the dialog: Filtering public dashboards via API
  4. Select Selected Teammates to show a list of all teammates who have sufficient privileges: Filtering public dashboards via API
  5. Click the checkbox next to each name you wish to add or remove, and then select Save. Teammates are notified when their privileges are updated.

Note the following:

  • If you wish to change the editing privileges on a dashboard you don’t own, you can change the dashboard owner by making a support request.
  • Editing privileges don’t override any other permissions or privileges in Analytics. For example, if a team member has Read Only permissions, they won’t appear in the list of teammates to select or exclude.
  • You can duplicate a dashboard even if you can’t edit it. You’ll be the duplicated dashboard owner and can make any changes, including the dashboard privileges setting.

Duplicate dashboard

To duplicate a dashboard:

  1. Click the Saved section in the left-hand navigation menu and select a dashboard. Filtering public dashboards via API
  2. Select Manage in the top right corner of your dashboard. Filtering public dashboards via API
  3. Select Duplicate Dashboard.
Filtering public dashboards via API
  1. Select a name for your new dashboard, and select a folder to save your dashboard in.
  2. Click Duplicate to finalize your dashboard duplication or Cancel if you’ve changed your mind.

Note the following:

  • You may also duplicate your dashboard by hovering in the Views dropdown.
  • You can duplicate a dashboard even if you don’t have editing privileges.

Delete dashboard

To delete a dashboard:

  1. Click the Saved section in the left-hand navigation menu and select a dashboard. Filtering public dashboards via API
  2. Select Manage in the top right corner of your dashboard. Filtering public dashboards via API
  3. Select Delete Dashboard. You will be asked to confirm if you want to delete your dashboard because any analyses saved to a deleted dashboard will not be recoverable.

You may also delete your dashboard by hovering in the Views dropdown.

Delete dashboard

Was this page helpful?

    Last Updated: November 15, 2024