Dashboard JSON Properties

The dashboard JSON consists of properties that define layouts, pages, widgets, and steps. Some properties are exposed and editable in the Dashboard Designer user interface. Others are only editable via JSON.

Each dashboard JSON contains the following high-level properties.

Property Name	Type	Details
`label`	String	Name of the dashboard. Included in the Dashboard Designer’s user interface.
`mobileDisabled`	Boolean	Specifies whether the dashboard can be accessed in the mobile app. Use this parameter to hide dashboards that don’t perform well on mobile devices. Default is `false`. Included in the Dashboard Designer’s user interface.
`description`	String	Description of the dashboard. Included in the Dashboard Designer’s user interface.
`state`	Array	Specifies properties for all layouts, widgets, and steps defined in the dashboard. When you save a dashboard using the Dashboard Designer, the state of the dashboard is persisted in the JSON. Not included in the Dashboard Designer’s user interface.
`datasets`	Array	Specifies all datasets used by steps in the dashboard. Not included in the Dashboard Designer’s user interface.

The following sections describe the different properties nested under state.

dataSourceLinks JSON

The dataSourceLinks section defines all data sources configured for the dashboard.
gridLayouts JSON

The gridLayouts section defines all layouts built for the dashboard.
widgetStyle JSON and Properties

The widgetStyle key contains the default widget properties that can be applied to each widget.
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.
widgets JSON

The widgets section defines the widgets that appear in the dashboard. Each widget has a name.
filters JSON

The filters section defines the global filters added to a global filter panel widget, which is available in the dashboard designer.