---
schema_version: "1"
id: 866f9c33e29d4149e72dc13e527db6499a10cf2ee33a1bbacfa574a7d4900017
title: Dashboard JSON Properties
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/analytics/bi_dev_guide_json/guides/bi-dbjson-properties.md
canonical_url: https://developer.salesforce.com/docs/analytics/bi-dev-guide-json/guide/bi-dbjson-properties.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: e7cd67a5685af37fefac3eee4ac755393454c1019b5c3c8712374884657d8cad
products:
  - Analytics Dashboard JSON Developer Guide
  - analytics
---

# 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](https://developer.salesforce.com/docs/analytics/bi-dev-guide-json/guide/bi-dbjson-datasourcelinks.md)**


    The `dataSourceLinks` section defines all data sources configured for the dashboard.

- **[gridLayouts JSON](https://developer.salesforce.com/docs/analytics/bi-dev-guide-json/guide/bi-dbjson-gridlayouts.md)**


    The `gridLayouts` section defines all layouts built for the dashboard.

- **[widgetStyle JSON and Properties](https://developer.salesforce.com/docs/analytics/bi-dev-guide-json/guide/bi-dbjson-widgetstyle.md)**


    The `widgetStyle` key contains the default widget properties that can be applied to each widget.

- **[steps JSON](https://developer.salesforce.com/docs/analytics/bi-dev-guide-json/guide/bi-dbjson-steps-properties.md)**


    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](https://developer.salesforce.com/docs/analytics/bi-dev-guide-json/guide/bi-dbjson-widgets.md)**


    The `widgets` section defines the widgets that appear in the dashboard. Each widget has a name.

- **[filters JSON](https://developer.salesforce.com/docs/analytics/bi-dev-guide-json/guide/bi-dbjson-filters.md)**


    The `filters` section defines the global filters added to a global filter panel widget, which is available in the dashboard designer.
