Analytics Dashboard JSON Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

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
Dashboard JSON Properties
dataSourceLinks JSON
gridLayouts JSON
widgetStyle JSON and Properties
steps JSON
widgets JSON
filters JSON
PDF

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 Details
label
Type
String
Exposed in the Dashboard Designer's User Interface
Yes
Description

Name of the dashboard.
mobileDisabled
Type
Boolean
Exposed in the Dashboard Designer's User Interface
Yes
Description

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.
description
Type
String
Exposed in the Dashboard Designer's User Interface
Yes
Description

Description of the dashboard.
state
Type
Array
Exposed in the Dashboard Designer's User Interface
No
Description

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.
datasets
Type
Array
Exposed in the Dashboard Designer's User Interface
No
Description

Specifies all datasets used by steps in the dashboard.

The following sections describe the different properties nested under state.