Analytics Dashboard JSON Developer Guide
jSpring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
CRM Analytics Dashboard JSON Overview
View or Modify a Dashboard JSON File
CRM Analytics Dashboard JSON Example
widgetStyle JSON and Properties
columns Properties
grain Step Type Properties
saql Step Type Properties
soql Step Type Properties
source Step Type Properties
staticflex Step Type Properties
visualizationParameters Properties
filters Properties
steps JSON
The steps key defines all steps available in a
CRM Analytics dashboard. It contains a separate node for each step. Each step node has
properties that define the query or list of static values. It also contains properties that
control the behavior of the step, like whether to facet the step. The properties and JSON
syntax vary based on the step type and whether the step is in compact form or SAQL
form.
-
aggregateflex Step Type Properties
Use the aggregateflex step type to perform aggregate queries on a Analytics dataset. An aggregate query summarizes rows, like returning one row per grouping. For example, this step type can return the total amount per sales rep. -
apex Step Type Properties
Use to include custom Apex functionality in a dashboard to access Salesforce platform features that aren’t inherently supported in Analytics. For example, pull in data using any API, manipulate data using your Apex classes, or apply simple case statements or complex machine learning. You can even harness AppExchange for things like integrating Twitter with Analytics—all in a way that is familiar. -
columns Properties
Use the columns property to add a column to a step query source in Compact form 2.0. -
grain Step Type Properties
Use the grain step type for a values table. Values tables have no groupings, just a list of dataset fields to display as columns in the table. -
saql Step Type Properties
Use the saql step type for special cases when querying a Analytics dataset. With this step type, you can write a custom SAQL query to create derived fields in a values table. You can specify dimensions without groupings. Also, you can bind the dataset name or entire query. For example, you can bind this step type to a static step that provides different SAQL queries or datasets based on a selection. -
soql Step Type Properties
Use to directly query Salesforce objects—both standard and custom—to get Salesforce data that’s not available in datasets. You can also query external objects created with an OData adapter for Salesforce Connect. To view the results in the dashboard, the user viewing the dashboard must have access to the object and fields queried by the soql step. The SOQL query returns only records to which the user has access. -
source Step Type Properties
Use the sources property to add columns, groups, filters, and formulas to a step query. -
staticflex Step Type Properties
Use the staticflex step type to manually define your own set of data. For example, you can use this step to populate a list of static values in a toggle or list widget. It can also be used to provide values to a binding. For example, it can provide possible filters, groups, measures, sort order, and limits. -
visualizationParameters Properties
The visualizationParameters key contains chart properties defined for the step. When you associate the step with a widget, the widget properties override these settings. -
filters Properties
Use the filters property to add a filter to a step query. Although you can create filters for query steps in the user interface, you have to manually define filters for static steps in the dashboard JSON.