Bi Dev Guide Json

Analytics Dashboard JSON
Reference
Salesforce, Spring ’20
@salesforcedocs
Last updated: April 28, 2020
© Copyright 2000–2020 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc.,
as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS
Analytics Dashboard JSON Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
View or Modify a Dashboard JSON File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Analytics Dashboard JSON Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Dashboard JSON Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

dataSourceLinks JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
gridLayouts JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
widgetStyle JSON and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
steps JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
widgets JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
filters JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
ANALYTICS DASHBOARD JSON OVERVIEW
The easiest way to build dashboards in Analytics is to use the dashboard designer. However, if needed, you can further customize
dashboards by editing their JSON files. The JSON defines the components of the dashboard and how they interact.
Modify a dashboard’s JSON file to perform advanced customization tasks that can’t be accomplished in the designer’s user interface,
like:
• Manually set up bindings to override the default faceting behavior and specify the relationships between the steps that aren’t bound
by default.
• Set query limits.
• Specify columns for a values table.
1
VIEW OR MODIFY A DASHBOARD JSON FILE
Use the JSON Editor to modify the JSON for a dashboard or lens.
EDITIONS
JSON Editor displays the JSON of a lens or dashboard and lets you quickly see the effect of your
edits in the running asset. Available in Salesforce
Classic and Lightning
1. To access JSON Editor, open the lens or dashboard you want to edit, and press CTRL+E for PCs
Experience.
or CMD+E for Macs.
2. Modify the JSON in the editor. You can use standard keyboard shortcuts for editing functions Available for an extra cost in
and search. Enterprise, Performance,
and Unlimited Editions. Also
3. To go back to the explorer and see how edits to the JSON appear in the lens or dashboard, click available in Developer
Done. Edition.
4. To retain your edits, save the lens or dashboard. Changes made in the JSON editor are not saved
until you explicitly save the lens or dashboard.
USER PERMISSIONS
In JSON Editor, the following shortcuts let you perform basic actions from your keyboard.
To modify the JSON file that
JSON Editor Keyboard Shortcut Description defines a dashboard:
• Create and Edit Analytics
CRTL+3 (Windows); CMD+3 (Mac) Disregard changes and load the original JSON Dashboards
CRTL+X (Windows); CMD+X (Mac) Cut
CRTL+C (Windows); CMD+C (Mac) Copy
CRTL+V (Windows); CMD+V (Mac) Paste
CRTL+Z (Windows); CMD+Z (Mac) Undo
SHIFT+CRTL+Z (Windows); SHIFT+CMD+Z Redo

(Mac)
CRTL+F (Windows); CMD+F (Mac) Search (RegExp, case-sensitive, or whole word

searches available)
CRTL+E (Windows); CMD+E (Mac) View dashboard with changes to JSON
2
ANALYTICS DASHBOARD JSON EXAMPLE
The JSON for each Analytics dashboard contains multiple levels of properties. Review the sample JSON provided in this section to learn
about the basic JSON structure of a dashboard.
Example: The sample JSON defines this dashboard.
The Account Analysis dashboard consists of the following objects.

• Layouts:
– Default, which has pages:
• Page 1
• Page 2
– Mobile
• Widgets:
– Values table table_1 based on step lens_1 (Not shown in the screenshot because it exists only on Page 2.)
– Global filter panel filterpanel_1
– Link link_1
– Horizontal Bar Chart chart_1 based on step Amount_by_Acct_Owner_1
• Steps:
– Amount_by_Acct_Owner_1
– Account_Owner_Name_1
– lens_1
3
Analytics Dashboard JSON Example
• Dataset 0FbB000000017QxKAI
{
"label": "Account Analysis",
"mobileDisabled": false,
"state": {
"dataSourceLinks": [],
"filters": [
{
"dataset": {
"id": "0FbB000000017QxKAI",
"name": "opportunity",
"url": "/services/data/v41.0/wave/datasets/0FbB000000017QxKAI"
},
"fields": [
"Account.Owner.Name"
],
"label": "Account.Owner.Name",
"locked": false,
"operator": "in",
"value": [
"Annie Kelly",
"Bill Johnson",
"Chan Lao",
"Ellen Bruxton",
"Erin Baker",
"Frank Tom",
"Jason Hunt",
"Jennifer McCarthy",
"Leslie Pham",
"Michelle Nguyen",
"Nathan Sinha",
"Norman Truman",
"Priya Anand",
"Rob Wilkens",
"Sam Gunderson",
"Valerie Thom",
"Walker Chan",
"Wang Lee"
]
},
{
"dataset": {
"id": "0FbB000000017QxKAI",
},
"fields": [
"Close Date"
],
"label": "Close Date",
"locked": false,
"operator": ">=<=",
"value": [
[
4
1451635200000,
1564642800000
]
]
}
],
"gridLayouts": [
{
"name": "Default",
"numColumns": 9,
"pages": [
{
"label": "Page 1",
"name": "41f040d6-48a6-4dc7-9166-eb985df7e9d8",
"widgets": [
{
"colspan": 9,
"column": 0,
"name": "filterpanel_1",
"row": 0,
"rowspan": 3,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 9,
"column": 0,
"name": "chart_1",
"row": 3,
"rowspan": 5,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 2,
"column": 0,
"name": "link_1",
"row": 8,
"rowspan": 1,
"widgetStyle": {
"borderEdges": []
}
}
]
},
{
"label": "Page 2",
"name": "ac750443-1729-47fb-8d60-a35703076bf7",
"widgets": [
{
"colspan": 9,
"column": 0,
5
"row": 0,
"rowspan": 3,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 9,
"column": 0,
"name": "table_1",
"row": 3,
"rowspan": 7,
"widgetStyle": {
"borderEdges": []
}
}
]
}
],
"rowHeight": "normal",
"selectors": [],
"style": {
"alignmentX": "left",
"alignmentY": "top",
"backgroundColor": "#44A2F5",
"cellSpacingX": 4,
"cellSpacingY": 4,
"fit": "original",
"gutterColor": "#A3B8CC"
},
"version": 1
},
{
"name": "Mobile",
"numColumns": 2,
"pages": [
{
"label": "Page 1",
"widgets": [
{
"colspan": 2,
"column": 0,
"row": 0,
"rowspan": 2,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 2,
"column": 0,
6
"name": "chart_1",
"row": 2,
"rowspan": 10,
"widgetStyle": {
"borderEdges": []
}
}
]
}
],
"selectors": [
"maxWidth(599)"
],
"style": {
"backgroundColor": "#2EC2BA",
"cellSpacingX": 4,
"cellSpacingY": 4,
"fit": "original",
"gutterColor": "#091A3E"
},
"version": 1
}
],
"layouts": [],
"steps": {
"Amount_by_Acct_Owner_1": {
"broadcastFacet": true,
"datasets": [
{
"id": "0FbB000000017QxKAI",
"label": "Opportunities",
}
],
"isGlobal": false,
"label": "Amount by Acct Owner",
"query": {
"measures": [
[
"count",
"*"
]
],
"groups": [
],
"order": [
[
"count",
7
{
"ascending": false
}
]
]
},
"receiveFacet": true,
"selectMode": "multi",
"type": "aggregateflex",
"useGlobal": true,
"visualizationParameters": {
"options": {},
"parameters": {
"autoFitMode": "none",
"showValues": true,
"bins": {
"breakpoints": {
"high": 100,
"low": 0
},
"bands": {
"high": {
"color": "#008000",
"label": ""
},
"low": {
"color": "#B22222",
"label": ""
},
"medium": {
"color": "#ffa500",
"label": ""
}
}
},
"legend": {
"showHeader": true,
"show": true,
"customSize": "auto",
"position": "right-top",
"inside": false
},
"axisMode": "multi",
"tooltip": {
"showBinLabel": true,
"measures": "",
"showPercentage": false,
"showDimensions": true,
"showMeasures": true,
"customizeTooltip": false,
"dimensions": ""
},
"visualizationType": "hbar",
"title": {
8
"fontSize": 14,
"subtitleFontSize": 11,
"label": "",
"align": "center",
"subtitleLabel": ""
},
"binValues": false,
"trellis": {
"flipLabels": false,
"showGridLines": true,
"size": [
100,
100
],
"enable": false,
"type": "x",
"chartsPerLine": 4
},
"measureAxis2": {
"sqrtScale": false,
"showTitle": true,
"showAxis": true,
"title": "",
"customDomain": {
"showDomain": false
}
},
"measureAxis1": {
"sqrtScale": false,
"showTitle": true,
"showAxis": true,
"title": "",
"customDomain": {
"showDomain": false
}
},
"theme": "wave",
"dimensionAxis": {
"showTitle": true,
"showAxis": true,
"title": "",
"icons": {
"useIcons": false,
"iconProps": {
"fit": "cover",
"column": "",
"type": "round"
}
}
}
},
"type": "chart",
"visualizationType": "hbar"
9
}
},
"Account_Owner_Name_1": {
"datasets": [
{
"id": "0FbB000000017QxKAI",
}
],
"isGlobal": false,
"query": {
"measures": [
[
"count",
"*"
],
[
"avg",
"Amount"
]
],
"groups": [
],
"order": [
[
"count",
{
"ascending": false
}
]
]
},
"receiveFacet": true,
"selectMode": "single",
"useGlobal": true,
"parameters": {
"showPoints": false,
"legend": {
"showHeader": true,
"show": true,
"inside": false
},
"tooltip": {
10
"measures": "",
"dimensions": ""
},
"visualizationType": "line",
"dashLine": {
"measures": "",
"showDashLine": false
},
"title": {
"fontSize": 14,
"label": "",
"align": "center",
"subtitleLabel": ""
},
"trellis": {
"size": [
100,
100
],
"enable": false,
"type": "x",
"chartsPerLine": 4
},
"fillArea": true,
"showZero": true,
"measureAxis2": {
"sqrtScale": false,
"showTitle": true,
"showAxis": true,
"title": "",
"customDomain": {
"showDomain": false
}
},
"measureAxis1": {
"sqrtScale": false,
"showTitle": true,
"showAxis": true,
"title": "",
"customDomain": {
"showDomain": false
}
},
"theme": "wave",
"dimensionAxis": {
"showTitle": true,
11
"showAxis": true,
"title": "",
"icons": {
"useIcons": false,
"iconProps": {
"fit": "cover",
"column": "",
"type": "round"
}
}
},
"drawArea": {
"measure": "",
"showDrawArea": false,
"bounding1": "",
"bounding2": ""
}
},
"type": "chart",
"options": {}
}
},
"lens_1": {
"datasets": [
{
"id": "0FbB000000017QxKAI",
}
],
"isFacet": true,
"isGlobal": false,
"label": "lens_1",
"query": {
"values": [
"Name",
"Owner.Name",
"StageName",
"Amount",
"CloseDate",
"ForecastCategoryName",
]
},
"selectMode": "none",
"type": "grain",
"useGlobal": true,
"options": {},
"parameters": {
"borderColor": "#e0e5ee",
12
"borderWidth": 1,
"cell": {
"backgroundColor": "#ffffff",
"fontColor": "#16325c",
"fontSize": 12
},
"columns": [],
"customBulkActions": [],
"header": {
"backgroundColor": "#f4f6f9",
"fontSize": 12
},
"innerMajorBorderColor": "#a8b7c7",
"innerMinorBorderColor": "#e0e5ee",
"maxColumnWidth": 300,
"minColumnWidth": 40,
"mode": "variable",
"numberOfLines": 1,
"totals": true,
"verticalPadding": 8
},
"type": "table",
"visualizationType": "valuestable"
}
}
},
"widgetStyle": {
"backgroundColor": "#FFFFFF",
"borderColor": "#E6ECF2",
"borderEdges": [],
"borderRadius": 0,
"borderWidth": 1
},
"widgets": {
"table_1": {
"parameters": {
"columnProperties": {
"Amount": {
"type": "bar",
"parameters": {}
}
}
"borderWidth": 1,
"cell": {
"fontSize": 12
},
"columns": [],
"exploreLink": true,
"header": {
13
"fontSize": 12
},
"maxColumnWidth": 300,
"minColumnWidth": 40,
"mode": "variable",
"numberOfLines": 1,
"showRowIndexColumn": true,
"step": "lens_1",
"totals": true,
"verticalPadding": 8,
"evenRowColor": null,
"oddRowColor": null
},
"type": "table"
},
"filterpanel_1": {
"parameters": {
"filterItemOptions": {
"borderRadius": 4,
"propertyColor": "#54698D",
"valueColor": "#16325C",
"borderWidth": 1
},
"itemsPerRow": 2,
"title": {
"separatorColor": "#E6ECF2",
"text": {
"align": "left",
"color": "#091A3E",
"fontSize": 16,
"label": "Filters"
},
"visible": true
}
},
"type": "filterpanel"
},
"link_1": {
"parameters": {
"destinationLink": {
"name": "ac750443-1729-47fb-8d60-a35703076bf7"
},
"destinationType": "page",
"fontSize": 12,
"includeState": false,
"text": "Opp Details",
"textAlignment": "center",
"textColor": "#44A2F5"
14
},
"type": "link"
},
"chart_1": {
"parameters": {
"showValues": true,
"bins": {
"breakpoints": {
"high": 100,
"low": 0
},
"bands": {
"high": {
"color": "#008000",
"label": ""
},
"low": {
"color": "#B22222",
"label": ""
},
"medium": {
"color": "#ffa500",
"label": ""
}
}
},
"legend": {
"showHeader": true,
"show": true,
"inside": false
},
"tooltip": {
"measures": "",
"dimensions": ""
},
"title": {
"fontSize": 14,
"label": "",
"align": "center",
"subtitleLabel": ""
},
"binValues": false,
15
"trellis": {
"size": [
100,
100
],
"enable": false,
"type": "x",
"chartsPerLine": 4
},
"measureAxis2": {
"sqrtScale": false,
"showTitle": true,
"showAxis": true,
"title": "",
"customDomain": {
"showDomain": false
}
},
"measureAxis1": {
"sqrtScale": false,
"showTitle": true,
"showAxis": true,
"title": "",
"customDomain": {
"showDomain": false
}
},
"theme": "wave",
"step": "Amount_by_Acct_Owner_1",
"dimensionAxis": {
"showTitle": true,
"showAxis": true,
"title": "",
"icons": {
"useIcons": false,
"iconProps": {
"fit": "cover",
"column": "",
"type": "round"
}
}
}
},
"type": "chart"
}
}
},
"datasets": [
{
"id": "0FbB000000017QxKAI",
16
}
]
}
17
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
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
Yes
Description
Description of the dashboard.
state Type
Array
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
18
Dashboard JSON Properties dataSourceLinks JSON

No
Description
Specifies all datasets used by steps in the dashboard.
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 an 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.
dataSourceLinks JSON
The dataSourceLinks section defines all data sources configured for the dashboard.
For more information about connected data sources, see Configure Cross-Dataset Faceting with Connected Data Sources.
Example:
"dataSourceLinks": [
{
"fields": [
{
"dataSourceName": "ServiceOpportunity3",
"dataSourceType": "saql",
"fieldName": "AccountId"
},
{
"dataSourceName": "account",
"fieldName": "Id"
}
19
Dashboard JSON Properties dataSourceLinks Properties
],
"label": "ServiceOpportunities Dataset to Account Dataset: Account ID",
"name": "Link_970"
},
{
"fields": [
{
"dataSourceName": "ServiceOpportunity3",
"fieldName": "StageName"
},
{
"dataSourceName": "Static_Opp_Stage_1",
"dataSourceType": "static",
"fieldName": "value"
}
],
"label": "Static Opp Stage to ServiceOpportunities Dataset",
"name": "Link_953"
}
]
dataSourceLinks Properties
The dataSourceLinks key defines all data source connections for the dashboard. It contains a separate node for each connection.
Each connection has properties about each data source.
dataSourceLinks Properties
The dataSourceLinks key defines all data source connections for the dashboard. It contains a separate node for each connection.
Each connection has properties about each data source.

fields Type
Array
Yes.
Description
List of data sources included in the connection. Each data source contains the following properties.
dataSourceName
API name of the dataset or ID of the static step.
dataSourceType
The type of data source: "saql" for a dataset or "static" for a static step.
fieldName
Name of the field used to match records between the data sources.
20
Dashboard JSON Properties gridLayouts JSON

label Type
String
Yes.
Description
Display label for the data source connection.
name Type
String
No.
Description
API name of the data source connection.
gridLayouts JSON
The gridLayouts section defines all layouts built for the dashboard.
For more information about layouts for Analytics dashboards, see Generate Unique Dashboard Layouts for Different Devices. .
Example:
"gridLayouts": [
{
"name": "Default",
"numColumns": 9,
"pages": [
{
"label": "Page 1",
"widgets": [
{
"colspan": 9,
"column": 0,
"row": 0,
"rowspan": 3,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 9,
"column": 0,
"name": "chart_1",
"row": 3,
"rowspan": 5,
21
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 2,
"column": 0,
"name": "link_1",
"row": 8,
"rowspan": 1,
"widgetStyle": {
"borderEdges": []
}
}
]
},
{
"label": "Page 2",
"name": "ac750443-1729-47fb-8d60-a35703076bf7",
"widgets": [
{
"colspan": 9,
"column": 0,
"row": 0,
"rowspan": 3,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 9,
"column": 0,
"name": "table_1",
"row": 3,
"rowspan": 7,
"widgetStyle": {
"borderEdges": []
}
}
]
}
],
"selectors": [],
"style": {
"backgroundColor": "#44A2F5",
"cellSpacingX": 4,
"cellSpacingY": 4,
"fit": "original",
"gutterColor": "#A3B8CC"
},
22
"version": 1
},
{
"name": "Mobile",
"numColumns": 2,
"pages": [
{
"label": "Page 1",
"widgets": [
{
"colspan": 2,
"column": 0,
"row": 0,
"rowspan": 2,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 2,
"column": 0,
"name": "chart_1",
"row": 2,
"rowspan": 10,
"widgetStyle": {
"borderEdges": []
}
}
]
}
],
"selectors": [
"maxWidth(599)"
],
"style": {
"backgroundColor": "#2EC2BA",
"cellSpacingX": 4,
"cellSpacingY": 4,
"fit": "original",
"gutterColor": "#091A3E"
},
"version": 1
}
]
23
Dashboard JSON Properties gridLayouts Properties
gridLayouts Properties
The gridLayouts key defines all layouts for the dashboard. It contains a separate node for each layout. Each layout has properties
that provide information about the devices that can use the layout and the placement of each widget in the layout. It also contains
dashboard properties, like cell spacing in the grid and the dashboard’s background color or image.
gridLayouts Properties
The gridLayouts key defines all layouts for the dashboard. It contains a separate node for each layout. Each layout has properties
that provide information about the devices that can use the layout and the placement of each widget in the layout. It also contains
dashboard properties, like cell spacing in the grid and the dashboard’s background color or image.

name Type
String
Yes.
Description
Name of the layout.
maxWidth Maximum width (in pixels) that the dashboard can use. If needed, Analytics rearranges the existing dashboard
widgets based on this setting in the layout.
numColumns Type
Integer
Yes.
Description
The number of columns in the designer grid for this layout.
pages Type
Array
No
Description
Contains properties that specify the name and ID of the page, and determine the placement of each
widget in the dashboard layout.
rowHeight Type
String
Yes.
Description
The height of each row in the designer grid for this layout. Valid values are fine and normal (default).
24

selectors Type
Array
Yes.
Description
Device requirements that help Analytics choose the optimal layout for the device accessing the dashboard.
style Type
Array
Yes.
Description
Properties about the designer grid, including columns, rows, cell spacing, and background.
pages Properties
The pages key contains properties that determine the placement of each widget in the dashboard layout. Currently, dashboard
designer supports only one page for each layout.
selectors Properties
The selectors key contains layout properties that specify the layout name, designer grid settings, background settings, and
requirements for devices that can use this layout.
style Properties
The style key contains the dashboard properties, like cell spacing in the grid, as well as the dashboard’s background color or
image.
pages Properties
The pages key contains properties that determine the placement of each widget in the dashboard layout. Currently, dashboard
designer supports only one page for each layout.

label Type
String
Yes
Description
Label of the page in the dashboard layout.
name Type
String
25

No
Description
ID of the page in the dashboard layout.
widgets Type
Array
No
Description
Contains properties that determine the height and width of each widget, and where it’s placed on the
dashboard layout.
widgets Properties
The widgets key contains properties that determine the height and width of each widget, and where it’s placed on the dashboard
layout. Because the dashboard designer uses a grid, you specify the properties in terms of rows and columns. For example, you
specify the number of columns to determine the width of a widget.
widgets Properties
The widgets key contains properties that determine the height and width of each widget, and where it’s placed on the dashboard
layout. Because the dashboard designer uses a grid, you specify the properties in terms of rows and columns. For example, you specify
the number of columns to determine the width of a widget.

name Type
String
No
Description
Internal name of the widget. This name is used to reference the widget in the dashboard JSON.
column Type
Integer
Yes. Value is determined based on the widget's placement.
Description
The column number where the widget starts. Column and row specify the top left corner of the
widget.
26
Note: If this widget is included in a container, these properties are relative to the container widget.
row Type
Integer
Description
The row number where the widget starts. Column and row specify the top left corner of the widget.
colspan Type
Integer
Description
The number of columns that a widget spans—the width of the widget. If the dashboard doesn’t have
enough columns to accommodate the specified width, then columns are added to the dashboard.
rowspan Type
Integer
Description
The number of rows that a widget spans—the height of the widget. If the dashboard doesn’t have
enough rows to accomodate the specified height, then rows are added.
widgetStyle Type
Array
Available for These Widgets
• All widgets
No
Description
Contains properties that set the border type, border color, and background color.
widgetStyle Properties
The widgetStyle key contains properties that set the border type, border color, and background color of the widget. You can
specify these attributes at two levels. To set the default for all dashboard widgets, use the widgetStyle field under
gridLayouts. To set a specific widget, use the widgetStyle field under widgets. This setting overrides the default
settings for all widgets.
27
widgetStyle Properties
The widgetStyle key contains properties that set the border type, border color, and background color of the widget. You can specify
these attributes at two levels. To set the default for all dashboard widgets, use the widgetStyle field under gridLayouts. To
set a specific widget, use the widgetStyle field under widgets. This setting overrides the default settings for all widgets.

backgroundColor Type
String
All widgets
Yes
Description
Background color of the widget. The default is #FFFFFF.
borderColor Type
String
All widgets
Yes
Description
Color of the widget’s border. The default is #FFFFFF.
borderEdges Type
List
All widgets
Yes
Description
A list of values that specify which edges of the widget have a border. Valid values are left, right,
top, bottom, and all. Default is no border.
borderRadius Type
Integer
Available for This Widget
All widgets
Yes
Description
The roundness of the border corners.
28

Valid values are: 0 (not rounded, default), 4, 8, and 16. The higher the value, the more rounded the
corner.
borderWidth Type
Integer
All widgets
Yes
Description
Width of the widget’s border. Valid values are 1, 2 (default), 4, and 8.
selectors Properties
The selectors key contains layout properties that specify the layout name, designer grid settings, background settings, and
requirements for devices that can use this layout.

minWidth(<width>) Type
Integer
Yes
Description
Minimum width (in pixels) of the devices supported by this layout.
maxWidth(<width>) Type
Integer
Yes
Description
Maximum width (in pixels) of the devices supported by this layout.
orientation( Type
<orientation>) String
Yes
Description
Orientation of the devices supported by this layout. Valid values are: portrait or landscape. If
this property is not specified, then the layout supports both orientations.
29

platform(<platform>) Type
String
Yes
Description
Platform of the devices supported by this layout. Valid values are: iOS or Android. If this property is
not specified, the layout supports both platforms.
style Properties
The style key contains the dashboard properties, like cell spacing in the grid, as well as the dashboard’s background color or image.

alignmentX Type
String
Yes
Description
The horizontal alignment of the background image applied to the dashboard.
Valid values are: left (default), center, and right.
alignmentY Type
String
Yes
Description
The vertical alignment of the background image applied to the dashboard.
Valid values are: top (default), center, and bottom.
String
Yes
Description
Background color of the dashboard, specified in hex color code. The default is #FFFFFF.
cellSpacingX Type
Integer
30

Yes
Description
Horizontal spacing (in pixels) between cells in the dashboard grid.
Valid values are 0, 4, 8 (default), and 16.
cellSpacingY Type
Integer
Yes
Description
Vertical spacing (in pixels) between cells in the dashboard grid.
Valid values are 0, 4, 8 (default), and 16.
documentId Type
String
Yes
Description
The 15-character document ID of the image to apply as the dashboard’s background. To ensure security,
upload the image file to Salesforce as a document, and select the Externally Available Image option.
The image doesn’t show up if this option is not selected or the referenced document is not an image.
fit Type
String
Yes
Description
Indicates how to scale the image.
Valid values are: original (default), stretch, tile, fitwidth, and fitheight.
image Type
Array
Yes
Description
Identifies the image using the following properties.
name
Name of the image.
31
Dashboard JSON Properties widgetStyle JSON and Properties
namespace
Optional. Namespace of the image. Default is null.
Example
"image": {
"name": "My_Corporate_Logo",
"namespace": ""
}
widgetStyle JSON and Properties

The widgetStyle key contains the default widget properties that can be applied to each widget.
Note: You can specify these attributes at two levels. To set the default for all dashboard widgets, use the widgetStyle field
under gridLayouts. To set a specific widget, use the widgetStyle field under widgets. Settings at the widget level
override the default settings for all widgets.

String
All widgets
Yes
Description
Color of the widget’s background, specified in hex color code. The default is #FFFFFF.
borderColor Type
String
All widgets
Yes
Description
Color of the widget’s border, specified in hex color code. The default is #FFFFFF. If no border is specified,
the widget has no border.
borderEdges Type
List
All widgets
32
Dashboard JSON Properties steps JSON

Yes
Description
A list of values that specify which edges of the widget have a border. Valid values are left, right,
top, bottom, and all. Default is no border.
borderRadius Type
Integer
All widgets
Yes
Description
Roundness of the border corners.
Valid values are: 0(not rounded, default), 4, 8, and 16. The higher the value, the more rounded the
corner.
borderWidth Type
Integer
All widgets
Yes
Description
Thickness of the border.
Valid values are: 1, 2 (default), 4, and 8. The higher the value, the thicker the border.
steps JSON
The steps key defines all steps available in an 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 an 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.
33
Dashboard JSON Properties aggregateflex Step Type Properties
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 Einstein Analytics—all in a
way that is familiar.
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 an 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.
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.
aggregateflex Step Type Properties

Use the aggregateflex step type to perform aggregate queries on an 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.
Field Name Description

datasets An array of datasets used by this step. Specify the alias of each dataset. If the pigql attribute references
a dataset that’s not specified here, the dashboard doesn’t render.
broadcastFacet Controls whether the step’s selections are broadcasted as facets. Faceting is when a selection in a
widget filters other steps in the dashboard. Default is true.
receiveFacetSource Controls whether the step in the receiving query listens for broadcasted facets and applies them as
filters. The mode can be “all”, “none”, “include”, or “exclude”. Use steps to list which steps
to include or exclude. Default is all.
34

isGlobal This applies to global filters created before Winter ’18 only. Newer global filters, those created in the
global filter panel widget, don’t require a step. Default is false. You can apply this property only on steps
that are connected to a global filter widget—all other steps ignore this property. A global filter filters
other steps in the dashboard that have useGlobal set to true and reference the same dataset.
label Step label, which is primarily used for display in the dashboard designer user interface.
query The query used to retrieve results from a dataset. It must contain at least one grouping and can be in
SAQL or compact form. Use a query in SAQL form to customize the query in a way that can’t be done
using the compact form.
For compact form, the query can contain the following properties.
filters
The filters to apply to the data. For more information, see filters Properties on page 67.
groups
The dimension to group by.
limit
The maximum number of results that the step can return. When you create an aggregateflex
step, by default, Analytics sets limit to 2,000. To return more results, set the limit attribute
accordingly. The higher you increase the limit, the longer the query takes. When a limit isn’t set,
Analytics returns up to 10,000 results.
Note: Limit only impacts the number of records returned for display. The limit doesn’t
impact calculations across all records in the dataset. For instance, a query groups by Account
Name and there are one million Account Names in a dataset. When the limit is 20, Analytics
returns 20 records for display. But the summary row provides a total for the one million
records.
measures
The measures returned by the query.
Note: If you provide an aggregate function for a measure, then the measure value must
be a string, not an array.
order
Sort order (ascending or descending) of the first specified measure. To order the results in ascending
order, set ascending to true. To order the results in descending order, set ascending to
false. If you don’t want to impose a specific order, remove the entire "order" parameter.
Compact-form Query Example
"query": {
"filters": [
[
"Account.Industry",
[
"Agriculture",
"Apparel",
"Banking",
"Biotechnology",
"Consulting",
35
"Education",
"Electronics",
"Energy",
"Engineering",
"Finance",
"Healthcare",
"Insurance",
"Manufacturing",
"Media",
"Retail",
"Technology",
"Telecommunications",
"Transportation",
"Utilities"
],
"in"
]
],
"groups": [ "Account.Industry" ],
"measures": [
[
"avg",
"Amount"
]
],
"order": [
[
-1,
{ "ascending": false }
]
]
}
For SAQL form, the query can contain the following properties
pigql
Specify the SAQL query to retrieve data from a dataset. When you specify a SAQL query, you must
specify the filters, limits, and ordering inside the pigql attribute. Analytics ignores the following
attributes if they are set under the query attribute: filters, limit, and order.
measures
Defines the fields included as measures. When using a SAQL-form query, you must include each
measure in this parameter and in the pigql parameter. You can change the UI label of a measure
by setting the display option.
"count", "*", null, {
"display": "% of total flights"
}
groups
Defines the dimension fields to group by. When using a SAQL-form query, you must specify the
group-by dimension in this parameter and in the group property in the pigql parameter.
36
SAQL-form Query Example

"query": {
"pigql": "q = load \"ServiceOpportunity3\";\n
q = filter q by 'Account.Industry' in
[\"Agriculture\", \"Apparel\", \"Banking\",
\"Biotechnology\",
\"Consulting\", \"Education\", \"Electronics\",
\"Energy\",
\"Engineering\", \"Finance\", \"Healthcare\",
\"Insurance\",
\"Manufacturing\", \"Media\", \"Retail\",
\"Technology\",
\"Telecommunications\", \"Transportation\",
\"Utilities\"];\n
q = group q by 'Account.Industry';\n
q = foreach q generate 'Account.Industry' as
'Account.Industry',
count() as 'count';\n
q = order q by 'count' desc;\n
q = limit q 1000;",
"measures": [
[
"count",
"*",
"count"
]
],
"groups": [ "Account.Industry" ],
"measuresMap": {}
}
For more information about SAQL queries, see the Analytics SAQL Reference
selectMode Determines the selection interaction. The options for charts are: none, single, and
singlerequired. The options for list, range, and toggle selectors are: single,
singlerequired, multi, and multirequired.
Note: selectMode doesn’t apply to number, values table, compare table, date, and global
filter widgets.
start The initial selections that are applied to the step when the dashboard first opens.
type Step type. Set to aggregateflex.
Note: If you bind a step property for an aggregateflex step, you must use the correct
bindings syntax. For more information about bindings, see the Analytics Interactions Developer
Guide.
useGlobal Indicates whether to apply global filters to this step (true) or not (false). If the step is in SAQL form,
you must also set autoFilter to true to apply the global filters. By default, the global filter widget
filters compact-form steps only.
37

visualizationParameters Visualization details about the step. For more information, see visualizationParameters Properties.
Example: aggregateflex Step

"steps": {
"Account_Owner_1": {
"query": {
"measures": [
[
"avg",
"Amount"
]
],
"groups": [
"Account_Owner"
],
"order": [
[
"avg_Amount",
{
"ascending": false
}
]
]
},
"options": {},
"type": "chart",
"parameters": {
"autoFitMode": "keepLabels",
"theme": "wave",
"title": {
"label": "",
"fontSize": 14,
"subtitleLabel": "",
"align": "center"
},
"showValues": true,
"binValues": false,
"bins": {
"breakpoints": {
"low": 0,
"high": 100
},
"bands": {
"low": {
38
"label": "",
"color": "#B22222"
},
"medium": {
"label": "",
"color": "#ffa500"
},
"high": {
"label": "",
"color": "#008000"
}
}
},
"dimensionAxis": {
"showAxis": true,
"showTitle": true,
"title": "",
"icons": {
"useIcons": false,
"iconProps": {
"column": "",
"fit": "cover",
"type": "round"
}
}
},
"measureAxis1": {
"sqrtScale": false,
"showAxis": true,
"customDomain": {
"showDomain": false
},
"showTitle": true,
"title": ""
},
"measureAxis2": {
"sqrtScale": false,
"showAxis": true,
"customDomain": {
"showDomain": false
},
"showTitle": true,
"title": ""
},
"legend": {
"show": true,
"showHeader": true,
"inside": false,
"descOrder": false,
"customSize": "auto"
},
"tooltip": {
39
"dimensions": "",
"measures": "",
"showPercentage": true,
"showNullValues": true,
"showBinLabel": true
},
"trellis": {
"enable": false,
"type": "x",
"chartsPerLine": 4,
"size": [
100,
100
]
},
"applyConditionalFormatting": true,
"showActionMenu": true,
"columnMap": {
"trellis": [],
"plots": [
"avg_Amount"
],
"dimensionAxis": [
"Account_Owner"
]
}
}
},
"datasets": [
{
"id": "0FbB00000000xHDKAY",
"name": "DTC_Opportunity_SAMPLE",
"label": "DTC Opportunity",
"url": "/services/data/v48.0/wave/datasets/0FbB00000000xHDKAY"
}
],
"useGlobal": true,
"isGlobal": false,
"label": "Account_Owner_1",
"receiveFacetSource": {
"mode": "all",
"steps": []
},
"selectMode": "single"
}
}
40
steps Properties for Compact Form and SAQL Form

The properties and JSON syntax in the query node of an aggregateflex step type vary based on whether the step is in
compact form or SAQL form.
steps Properties for Compact Form and SAQL Form

The properties and JSON syntax in the query node of an aggregateflex step type vary based on whether the step is in compact
form or SAQL form.
Example: Compact-Form aggregateflex Step

"steps": {
"all_Amount_1": {
"query": {
"measures": [
[
"avg",
"Amount"
]
],
"groups": [
"Account_Name"
],
"order": [
[
"avg_Amount",
{
"ascending": false
}
]
]
},
"options": {},
"type": "chart",
"parameters": {
"theme": "wave",
"title": {
"label": "",
"fontSize": 14,
"align": "center"
},
"showValues": true,
"binValues": false,
"bins": {
"breakpoints": {
"low": 0,
"high": 100
41
},
"bands": {
"low": {
"label": "",
"color": "#B22222"
},
"medium": {
"label": "",
"color": "#ffa500"
},
"high": {
"label": "",
"color": "#008000"
}
}
},
"dimensionAxis": {
"showAxis": true,
"showTitle": true,
"title": "",
"icons": {
"useIcons": false,
"iconProps": {
"column": "",
"fit": "cover",
"type": "round"
}
}
},
"measureAxis1": {
"sqrtScale": false,
"showAxis": true,
"customDomain": {
"showDomain": false
},
"showTitle": true,
"title": ""
},
"measureAxis2": {
"sqrtScale": false,
"showAxis": true,
"customDomain": {
"showDomain": false
},
"showTitle": true,
"title": ""
},
"legend": {
"show": true,
"showHeader": true,
"inside": false,
"descOrder": false,
42
},
"tooltip": {
"dimensions": "",
"measures": "",
},
"trellis": {
"enable": false,
"type": "x",
"chartsPerLine": 4,
"size": [
100,
100
]
},
"showActionMenu": true,
"columnMap": {
"trellis": [],
"plots": [
"avg_Amount"
],
"dimensionAxis": [
"Account_Name"
]
}
}
},
"datasets": [
{
"id": "0Fb6g000000HTE1CAO",
"name": "DTC_Opportunity_SAMPLE",
"label": "DTC Opportunity",
"url": "/services/data/v48.0/wave/datasets/0Fb6g000000HTE1CAO"
}
],
"useGlobal": true,
"isGlobal": false,
"label": "all_Amount_1",
"mode": "all",
"steps": []
},
43
},
Example: SAQL-Form aggregateflex Step

When the step is in SAQL form, notice how each group and measure are defined in the groups and measures properties,
respectively, and also in the pigql property. Other parts of the query—like filters, limits, and order—only need to be defined
once in the pigql property. You specify the compact form elements of "groups" and "measures" so that the associated
chart widget can render the correct projections.
In the following sample step, notice that the 'sum_Amount' and 'sum_quantity' projections in the pigql property
are referenced in "measures" as [[ "count", "*", "sum_Amount" ], [ "count", "*",
"sum_quantity" ]]. Measure projections in the pigql property always include the aggregation, underscore (_), and the
name of the measure ('sum_Amount') so that they can be referenced in the compact form.
"steps": {
"Product_StageName_2": {
"options": {}
},
"query": {
"pigql": "q = load \"Flexy_Sales\";\n
q = group q by ('Product', 'StageName');\n
q = foreach q generate 'Product' as 'Product',
'StageName' as 'StageName',
sum('Amount') as 'sum_Amount',
sum('quantity') as 'sum_quantity';\n
q = filter q by 'sum_Amount' >= 14550720 && 'sum_Amount' <=
58807698;\n
q = order q by 'sum_Amount' desc;\nq = limit q 10000;",
"measures": [
[
"count",
"*",
"sum_Amount"
],
[
"count",
"*",
"sum_quantity"
]
],
"groups": [
"Product",
"StageName"
]
},
"mode": "all",
"steps": []
},
"useGlobal": true,
44
Dashboard JSON Properties apex Step Type Properties
"isGlobal": false,
"datasets": [{
"name": "Flexy_Sales",
"url": "/services/data/v38.0/wave/datasets/0FbB00000000q5gKAA",
"id": "0FbB00000000q5gKAA"
}]
}
}
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 Einstein Analytics—all in a way that is
familiar.
To set up an apex step, create an Apex class that returns data in a shape that Analytics can consume. And then define the step with
the apex step type in the dashboard JSON. The step calls the Apex REST endpoint to return the data from the Apex controller class.
Like a soql step, the Apex controller can return tabular data. Unlike saql and soql step types, the apex step type doesn’t define
the "strings", "numbers", and "groups" arrays. The Apex class response must declare these column types.
When you define an apex step, you can use a selection or results binding on the body parameter in the step JSON. You can also
reference this step type in a results binding. This step type doesn’t support faceting. If you run an Analytics REST API query using an
apex step, the query runs as the logged-in user. Each REST API query counts against the org’s API limits.
Note the following limitations with apex steps:
• If you include dashboards in a package, apex steps aren’t included. You must migrate the Apex classes separately.
• The Android mobile app doesn’t support this type of step.

type Step type. Set to apex.
query Query that returns the results. Can consist of the following parameters:
body
Optional. Blob containing the input parameters needed by the Apex controller class.
path
Required. Specifies the class path and name of the Apex controller class.
Example: apex Step

"GetStockData": {
"query": {
"body": {
"symbol": "CRM"
},
"path": "stocks"
45
},
"type": "apex"
}
Example: You want to display real-time stock data from a website in your dashboard. You want to fetch the data from an external
API and add logic to determine the time of day for each stock price. Here’s the goal for this dashboard.
To create this dashboard, complete the following steps:

1. Create the Apex controller class that gets the data from the stock website.
2. Whitelist the stock website in Salesforce.
3. Create the apex step in addition to the other dashboard widgets.
Create the Apex Class

Define the Apex controller class and methods that return the stock price for different companies over time.
1. From setup, enter Apex Classes in the Quick Find box, and select Apex Classes.
2. Click New.
46
3. Add the following code.

@RestResource(urlMapping='/stocks')
global with sharing class StocksRestController {
@HttpPost
global static String stocks(String symbol) {
// default to CRM stock
if (symbol == null) {
symbol = 'CRM';
}
// fetch some stock data

HttpRequest request = new HttpRequest();
Http http = new Http();
// make sure this domain is whitelisted in the proxy
request.setEndpoint('http://dev.markitondemand.com/MODApis/Api/v2/InteractiveChart/json?
parameters=%7B%22Normalized%22%3Afalse%2C%22NumberOfDays%22%3A365%2C%22
DataPeriod%22%3A%22Day%22%2C%22Elements%22%3A%5B%7B%22Symbol%22%3A%22' + symbol +
'%22%2C%22Type%22%3A%22price%22%2C%22Params%22%3A%5B%22c%22%5D%7D%5D%7D');
request.setMethod('GET');
try {
HTTPResponse response = http.send(request);
JSONParser parser = JSON.createParser(response.getBody());
while (parser.nextToken() != null) {
47
// find the stock part of the response

if (parser.getCurrentToken() == JSONToken.START_OBJECT) {
// parse the stock response and form the response for this controller
StockResponse responseObject =
(StockResponse)parser.readValueAs(StockResponse.class);
List<ReturnItem> returnItems = new List<ReturnItem>();

Integer i = 0;
for (String curDate : responseObject.dates) {
returnItems.add(new ReturnItem(curDate,
responseObject.elements.get(0).dataSeries.close.values.get(i++)));
}
// return the serialized response

return JSON.serialize(new PackagedReturnItem(returnItems));
}
}
} catch(Exception exp) {
System.debug('exception '+exp);
}
return '';
}
// Parse the stock response

public class StockResponse {
public List<String> dates;

public List<StockResponseElement> elements;
public StockResponse(List<String> dates, List<StockResponseElement> elements)

{
this.dates = dates;
this.elements = elements;
}
}
public class StockResponseElement {
public String type;

public StockResponseDataSeries dataSeries;
public StockResponseElement(String type, StockResponseDataSeries dataSeries) {

this.type = type;
this.dataSeries = dataSeries;
}
}
public class StockResponseDataSeries {
public StockResponseDataSeriesValues close;
public StockResponseDataSeries(StockResponseDataSeriesValues close) {
48
this.close = close;
}
}
public class StockResponseDataSeriesValues {
public List<Double> values;
public StockResponseDataSeriesValues(List<Double> values) {

this.values = values;
}
}
public class ReturnItem {
public String dateString;

public Double value;
public ReturnItem(String dateString, Double value) {

this.dateString = dateString;
this.value = value;
}
}
public class ReturnMetadata {
public List<String> strings;

public List<String> numbers;
public List<String> groups;
public ReturnMetadata(List<String> strings, List<String> numbers, List<String>

groups) {
this.strings = strings;
this.numbers = numbers;
this.groups = groups;
}
}
public class PackagedReturnItem {
public List<ReturnItem> data;

public ReturnMetadata metadata;
public PackagedReturnItem(List<ReturnItem> data) {

this.data = data;
this.metadata = new ReturnMetadata(new List<String>{'dateString'}, new
List<String>{'value'}, new List<String>());
}
}
}
4. Click Save.
49
Whitelist the External Website

To enable Apex to query external REST endpoints, whitelist the website in Salesforce.
1. From setup, enter Remote in the Quick Find box, and select Remote Site Settings.
2. Click New Remote Site.
3. Enter the remote site name and URL.
50
4. Click Save.
Create the Apex Step

Manually define the apex step in the dashboard JSON to get the stock results from the Apex class that you previously created.
In the dashboard JSON, add the following apex step.
"StockData": {
"query": {
"body": {
"symbol": "{{cell(CompaniesList_1.selection, 0, \"value\").asString()}}"
},
"path": "stocks"
},
"type": "apex"
}
The apex step query contains the following parameters.

body
The binding retrieves the stock symbol when a company is selected in the toggle widget.
51
path
Specifies the REST API resource path to the Apex controller, as specified in the urlMapping of the RestResource annotation
on the Apex controller.
The dashboard shows four widgets. The toggle widget is based on a static step that maps predefined company names to stock symbols.
The table widget and line chart use the apex step to retrieve the results. The text widget uses a binding to concatenate “Selected
symbol:” and the stock symbol of the selected company in the toggle widget.
Here’s the final dashboard JSON.
{
"label": "Stock Quotes",
"mobileDisabled": false,
"state": {
"dataSourceLinks": [],
"filters": [],
"gridLayouts": [
{
"name": "Default",
"numColumns": 12,
"pages": [
{
"label": "Untitled",
"name": "b177a6e6-8ab6-4914-af36-09c7fa23e0c8",
"widgets": [
{
"colspan": 6,
"column": 0,
"name": "pillbox_1",
"row": 0,
"rowspan": 1,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 5,
"column": 7,
"name": "text_1",
"row": 0,
"rowspan": 1,
"widgetStyle": {
"borderEdges": []
}
},
{
"colspan": 6,
"column": 0,
"name": "table_1",
"row": 1,
"rowspan": 7,
"widgetStyle": {
"borderEdges": []
}
},
52
{
"colspan": 6,
"column": 6,
"name": "chart_1",
"row": 1,
"rowspan": 7,
"widgetStyle": {
"borderEdges": []
}
}
]
}
],
"selectors": [],
"style": {
"backgroundColor": "#F2F6FA",
"cellSpacingX": 8,
"cellSpacingY": 8,
"fit": "original",
"gutterColor": "#C5D3E0"
},
"version": 1
}
],
"layouts": [],
"steps": {
"CompaniesList_1": {
"datasets": [],
"dimensions": [],
"groups": [],
"label": "CompaniesList",
"numbers": [],
"selectMode": "singlerequired",
"strings": [],
"type": "staticflex",
"values": [
{
"display": "Salesforce",
"value": "CRM"
},
{
"display": "Apple",
"value": "AAPL"
},
{
"display": "Oracle",
"value": "ORCL"
},
{
"display": "Twitter",
"value": "TWTR"
53
},
{
"display": "Facebook",
"value": "FB"
}
],
"broadcastFacet": true
},
"StockData": {
"query": {
"body": {
"symbol": "{{cell(CompaniesList_1.selection, 0,
\"value\").asString()}}"
},
"path": "stocks"
},
"type": "apex"
}
},
"widgetStyle": {
"borderEdges": [],
"borderRadius": 0,
"borderWidth": 1
},
"widgets": {
"table_1": {
"parameters": {
"borderWidth": 1,
"cell": {
"fontSize": 12
},
"columns": [],
"exploreLink": false,
"header": {
"fontSize": 12
},
"mode": "fittocontainer",
"numberOfLines": 1,
"step": "StockData",
"verticalPadding": 8,
"evenRowColor": null,
"oddRowColor": null
},
"type": "table"
54
},
"pillbox_1": {
"parameters": {
"compact": false,
"step": "CompaniesList_1"
},
"type": "pillbox"
},
"text_1": {
"parameters": {
"fontSize": 20,
"text": "Selected symbol: {{ cell(CompaniesList_1.selection, 0,
\"value\").asString() }}",
"textColor": "#091A3E"
},
"type": "text"
},
"chart_1": {
"parameters": {
"showPoints": false,
"legend": {
"showHeader": true,
"show": true,
"inside": false
},
"tooltip": {
"measures": "",
"dimensions": ""
},
"visualizationType": "line",
"dashLine": {
"measures": "",
"showDashLine": false
},
"title": {
"fontSize": 14,
"label": "",
"align": "center",
"subtitleLabel": ""
},
"trellis": {
55
"size": [
100,
100
],
"enable": false,
"type": "x",
"chartsPerLine": 4
},
"fillArea": true,
"showZero": true,
"measureAxis2": {
"sqrtScale": false,
"showTitle": true,
"showAxis": true,
"title": "",
"customDomain": {
"showDomain": false
}
},
"measureAxis1": {
"sqrtScale": false,
"showTitle": true,
"showAxis": true,
"title": "",
"customDomain": {
"showDomain": false
}
},
"theme": "wave",
"step": "StockData",
"dimensionAxis": {
"showTitle": true,
"showAxis": true,
"title": "",
"icons": {
"useIcons": false,
"iconProps": {
"fit": "cover",
"column": "",
"type": "round"
}
}
},
"drawArea": {
"measure": "",
"showDrawArea": false,
"bounding1": "",
"bounding2": ""
}
},
"type": "chart"
56
Dashboard JSON Properties grain Step Type Properties
}
}
},
"datasets": []
}
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.

datasets An array of datasets used by this step. Specify the alias of each dataset. If the pigql attribute references
a dataset that’s not specified here, the dashboard doesn’t render.
Note: A grain step can only have one dataset.
isFacet Enables this step to facet and be faceted by other steps. Faceting is when a selection in a widget filters
other steps in the dashboard.
isGlobal This applies to global filters created before Winter ’18 only. Newer global filters, those created in the
global filter panel widget, don’t require a step. Default is false. You can apply this property only on steps
that are connected to a global filter widget—all other steps ignore this property. A global filter filters
other steps in the dashboard that have useGlobal set to true and reference the same dataset.
query The query used to retrieve results from a dataset. The query can be in compact form only and can
contain the following properties:
filters
The filter conditions to apply to the data.
values
List of dataset fields to show as table columns.
limit
The maximum number of results that the step can return. When you create a grain step, by
default, Analytics sets limit to 100. To return more results, set the limit attribute accordingly.
The higher you increase the limit, the longer the query takes. When a limit isn’t set, Analytics returns
up to 10,000 results.
Note: Limit only impacts the number of records returned for display. The limit doesn’t
impact calculations across all records in the dataset. For instance, a query groups by Account
Name and there are one million Account Names in a dataset. When the limit is 20, Analytics
returns 20 records for display. But the summary row provides a total for the one million
records.
"steps": {
"lens_1": {
"type": "grain",
57
Dashboard JSON Properties grain Step Type Properties
"visualizationType": "valuestable",
"options": {}
},
"query": {
"values": [
"Case.IsEscalated",
"AccountId",
"StageName",
"ForecastCategory",
"IsClosed",
"Amount"
],
"limit": 500
},
"isFacet": true,
"useGlobal": true,
"isGlobal": false,
"label": "",
"datasets": [
{
"name": "ServiceOpportunity16",
"url":
"/services/data/v39.0/wave/datasets/0FbB00000000kOSKAY",
"id": "0FbB00000000kOSKAY"
}
]
}
},
For more information SAQL queries, see the Analytics SAQL Reference.
type Step type. Set to grain.
useGlobal Indicates whether to apply global filters to this step (true) or not (false).
visualizationParameters Visualization details about the step. For more information, see visualizationParameters Properties.
Example: grain Step

"lens_1": {
"type": "grain",
"visualizationType": "valuestable",
"options": {
"totals": true
}
},
"query": {
"filters": [
[
58
Dashboard JSON Properties saql Step Type Properties
"Amount",
[[
1000000,
7780844
]],
">=<="
]
],
"values": [
"AccountId",
"ForecastCategory",
"CloseDate",
"Amount",
"Account.Name",
"StageName"
]
},
"isFacet": true,
"useGlobal": true,
"isGlobal": false,
"label": "",
"datasets": [
{
"name": "ServiceOpportunity3",
"url": "/services/data/v39.0/wave/datasets/0FbR0000000012uKAA",
"id": "0FbR0000000012uKAA"
}
]
}
saql Step Type Properties

Use the saql step type for special cases when querying an 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.

type Step type. Set to saql.
query The SAQL query used to retrieve results. For more information about SAQL queries, see Analytics SAQL
Reference.
When you create a saql-type step, by default, no limit is set in the query. When a limit isn’t set,
a step can return up to 10,000 results. To return more results, set the limit attribute accordingly.
The higher you increase the limit, the longer the query takes.
Note: Limit only impacts the number of records returned for display. The limit doesn’t impact
calculations across all records in the dataset. For instance, a query groups by Account Name and
there are one million Account Names in a dataset. When the limit is 20, Analytics returns 20
records for display. But the summary row provides a total for the one million records.
59

You can bind a saql step type to dynamically set the dataset used in the query or change the entire
query based on a selection in another step. For example, you can create a toggle based on a static step
that allows the dashboard viewer to select a query. Each toggle option contains a valid SAQL query.
Each query can be based on different datasets. (See the JSON example at the end of this section.)
receiveFacetSource Controls whether the step in the receiving query listens for broadcasted facets and applies them as
filters. The mode can be “all”, “none”, “include”, or “exclude”. Use steps to list which steps
to include or exclude. Default is all.
useGlobal Indicates whether to apply global filters to this step (true) or not (false). If the step is in SAQL form,
you must also set autoFilter to true to apply the global filters. By default, the global filter widget
filters compact-form steps only.
filter widgets.
Note: A widget with a saql-type step can return up to 10,000 results, by default. If Analytics
doesn’t find the initial value in those results, it ignores this setting.
Single-selection example:
"start": [ "06 - Proposal/Price Quote" ]
Multi-selection example:
"start": [
"06 - Proposal/Price Quote",
"01 - Prospecting"
]
strings Flags the specified fields as non-grouping dimensions. For example, you can flag a field as a dimension
for a values table in which no groupings are allowed. If you use a binding to determine the field, specify
the binding here as well.
numbers Flags the specified fields as measures. If you use a binding to determine the field, specify the binding
here as well.
groups Flags the specified fields as groupings. For example, you can flag a field as a grouping for a pivot table
or chart. If you use a binding to determine the field, specify the binding here as well.
60
Example: saql Step

"steps": {
"Amount_1": {
"type": "saql",
"query": "q = load \"DTC_Opportunity_SAMPLE\";\nq = group q by
'Account_Name';\nq = foreach q generate 'Account_Name' as 'Account_Name', count() as
'count';\nq = order q by 'Account_Name' desc;\nq = limit q 1000;",
"useGlobal": true,
"numbers": [],
"groups": [],
"strings": [],
"type": "chart",
"parameters": {
"theme": "wave",
"title": {
"label": "",
"fontSize": 14,
"align": "center"
},
"showValues": true,
"binValues": false,
"bins": {
"breakpoints": {
"low": 0,
"high": 100
},
"bands": {
"low": {
"label": "",
"color": "#B22222"
},
"medium": {
"label": "",
"color": "#ffa500"
},
"high": {
"label": "",
"color": "#008000"
}
}
},
"dimensionAxis": {
"showAxis": true,
"showTitle": true,
"title": "",
"icons": {
"useIcons": false,
61
"iconProps": {
"column": "",
"fit": "cover",
"type": "round"
}
}
},
"measureAxis1": {
"sqrtScale": false,
"showAxis": true,
"customDomain": {
"showDomain": false
},
"showTitle": true,
"title": ""
},
"measureAxis2": {
"sqrtScale": false,
"showAxis": true,
"customDomain": {
"showDomain": false
},
"showTitle": true,
"title": ""
},
"legend": {
"show": true,
"showHeader": true,
"inside": false,
"descOrder": false,
},
"tooltip": {
"dimensions": "",
"measures": "",
},
"trellis": {
"enable": false,
"type": "x",
"chartsPerLine": 4,
"size": [
100,
100
]
},
62
Dashboard JSON Properties soql Step Type Properties
"showActionMenu": true
}
},
"label": "Amount_1",
"mode": "all",
"steps": []
}
}
},
Example: saql Step with a Bound Query

"query": "{{cell(static_1.selection, 0, \"query\").asString()"
The static_1 step looks like this:

values: [
{query: "q = load \"opp\"; ..."}
{query: "q = load \"account\"; ..."}
]
Tip: Every dataset referenced in a binding of a saql step must be referenced by another step in the dashboard. If not,
Analytics removes the dataset from the datasets attribute in the dashboard JSON. As a result, widgets based on the
saql step display an error because it can’t find the dataset.
For more information about bindings, see the Analytics Interactions Developer Guide.
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.
For more information about using Salesforce Connect to access external data, see the Salesforce Connect Salesforce Help.

type Step type. Set to soql.
query The SOQL query used to retrieve results from a Salesforce object. Because Salesforce—not
Analytics—executes the query, the maximum number of returned results depends on the SOQL query
limit. For more information about SOQL queries, see SOQL and SOSL Reference.
Note: Every field listed in your SOQL query must be listed in one of the metadata properties:
strings, numbers, or groups.
63
Dashboard JSON Properties soql Step Type Properties

strings Flags the specified fields as non-grouping dimensions. For example, you can flag a field as a dimension
for a values table in which no groupings are allowed. If you use a binding to determine the field, specify
the binding here as well.
numbers Flags the specified fields as measures. If you use a binding to determine the field, specify the binding
here as well.
groups Flags the specified fields as groupings. For example, you can flag a field as a grouping for a pivot table
or chart. If you use a binding to determine the field, specify the binding here as well.
Note: This step type doesn’t support faceting. If needed, you can use a binding to filter other steps based on a selection in a
soql step.
Example: soql Step

"soql": {
"type": "soql",
"query": "SELECT Name from ACCOUNT",
"strings": ["Name"],
"numbers": [],
"groups": [],
}
Example: Total Number of Active Salesforce Users

The following query gets the total number of active users from the Salesforce User object. In this example, we name the count
expression as “foo” and then reference it by name in the numbers parameter.
"soql": {
"type": "soql",
"query": "SELECT count(id) foo FROM User u WHERE u.IsActive = true",
"strings": [],
"numbers": ["foo"],
"groups": [],
}
If you don’t name the count expression, the query produces an "expr0" field that you can use in the numbers parameter.
"soql": {
"type": "soql",
"query": "SELECT count(id) FROM User u WHERE u.IsActive = true",
"strings": [],
"numbers": [ "expr0" ],
"groups": [],
}
64
Dashboard JSON Properties staticflex Step Type Properties
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.

type Step type. Set to staticflex.
values Values for the static step. You can have multiple fields for each static value, where each field provides
different information about the value, like a label, measurement, or range. When the static step is
associated with a widget, the widget uses the first specified field as the display label. You can use other
fields to specify values or ranges that you can use to facet or bind steps. For more information about
binding a static step to another step, see the Analytics Interactions Developer Guide. For more
information about faceting a static step with another data source, see Configure Cross-Dataset Faceting
with Connected Data Sources.
If you use the static step wizard to create the step, the step contains the following default fields:
display and value, as shown in the JSON example. You can change these arbitrary field names
and add more fields.
The values in each field must have the same datatype, like numbers, strings, or arrays. For instance, if
a row has "value": "123", another row can’t have "value": [123].
To enable this step to broadcast facets, set this property to true and connect this step with another
data source. This step type can’t receive facets.
isGlobal Not applicable. You can only apply this property on steps that are connected to a global filter widget—all
other steps ignore this property.
useGlobal Indicates whether to apply global filters to this step (true) or not (false).
filter widgets.
Example: staticflex Step

"my_opps_1": {
"numbers": [],
"strings": [],
"groups": [],
65
Dashboard JSON Properties visualizationParameters Properties
"datasets": [],
"dimensions": [],
"type": "staticflex",
"label": "my opps",
"values": [
{
"display": "All opps",
"value": "false"
},
{
"display": "My opps",
"value": "true"
}
]
}
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.

options Specifies chart properties for steps added or clipped to the designer. Analytics overrides these options
when they are defined in the widget parameters. For more information about chart properties, see
Visualizing Data With Charts.
visualizationType Specifies the chart type. You can override the chart type at the widget level.
Valid values for visualizationType are:
• calheatmap— calendar heat map
• choropleth — choropleth (map)
• combo — lines and bars to show multiple metrics
• flatgauge — flat gauge
• funnel — funnel
• hbar — horizontal bar
• hdot — horizontal dot plot
• heatmap— heat map
• matrix— matrix
• parallelcoords — parallel coordinates
• pie — donut
• pivottable — pivot table
• polargauge — polar gauge
• pyramid — pyramid
• rating — rating
66
Dashboard JSON Properties filters Properties

• scatter — scatter plot
• stackhbar — stacked horizontal bar
• stackpyramid — stacked pyramid
• stackvbar — stacked vertical bar
• stackwaterfall — stacked waterfall
• time — timeline
• time-bar — time bar
• time-combo — time bar
• vbar — vertical bar
• vdot — vertical dot plot
• waterfall — waterfall
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.
The syntax for a filter in the step definition varies based on whether the step is in compact or SAQL form. This section describes the filter
syntax for compact-form steps, including a description and example of every operator. For information about the filters for SAQL-form
steps, see the Analytics SAQL Reference.
Filter Syntax
Filters defined in compact-form steps have the following syntax.
"filters": [[
"field",
[value],
"operator"
]]
For example, the following filter shows only records with a “Customer” account type.
"filters": [[
"Account_Type",
["Customer"],
"in"
]]
To compare against multiple values, include the values in an array, like this.
"filters": [[
"field",
[[value1, value2, value3]],
"operator"
]]
67
To specify an absolute date value for a date filter, specify the value in epoch format, where the value is the number of milliseconds since
January 1, 1970 midnight UTC (1970-01-01 00:00:00). The following example shows dataset rows with a close date on or before January
1, 2016.
"filters": [[
"Close Date",
[[
1451606400000,
null
]],
">="
]]
Operators
You can use different operators in a filter. The supported operators depend on the field type. If you don’t specify the operator, Analytics
applies the == operator.
Operator Description Compact-Form Example

in Value of dataset field equals one of the ["Dimension",["Value1","Value2"],"in"]
specified values. Applies to dimensions only.
not in Value of dataset field is not in the specified ["Dimension",["Value1","Value2"],"not

list of values. Applies to dimensions only. in"]
matches Value of dataset field contains the specified ["Dimension",["Val"],"matches"]

value. This operator is not case-sensitive.
Applies to dimensions only.
is null Value of dataset field is null. Applies to ["Amount",[[]],"isnull"]

measures only.
is not null Value of dataset field is not null. Applies to ["Amount",[[]],"isnotnull"]

measures only.
== Value of dataset field equals the specified ["Measure",[[1]],"=="]

value. Applies to measures only.
!= Value of dataset field does not equal the ["Measure",[[1]],"!="]

specified value. Applies to measures only.
< Value of dataset field is less than the ["Measure",[[10]],"<"]

> Value of dataset field is greater than the ["Measure",[[1]],">"]

<= Value of dataset field is less than or equal to • ["Measure",[[10]],"<="]

the specified value. Applies to measures and
• ["Date",[[1229040000000]],"<="]
absolute dates only.
>= Value of dataset field is greater than or equal • ["Measure",[[1]],">="]

to the specified value. Applies to measures
• ["Date",[[-374457600000]],">="]
and absolute dates only.
68
Dashboard JSON Properties widgets JSON
Operator Description Compact-Form Example

>=<= (between) Value of dataset field is between the • ["Measure",[[1,10]],">=<="]
specified values, inclusive. For relative dates,
• ["Date",[[-374457600000,1229040000000]],">=<="]
you can specify the following time periods:
"year", "quarter", "month", "week", and "day". • ["Date",[[["month",-1],["month",1]]],">=<="]
Applies to measures and dates only. • ["Close Date",
[[null,1451606400000]],"<="]]
Note: You can also use:
>=<
Greater than or equal to one
value, but less than another.
><=
Greater than one value, but less
than or equal to another.
><
Between two values, exclusive.
widgets JSON
The widgets section defines the widgets that appear in the dashboard. Each widget has a name.
Example:
"widgets": {
"text_1": {
"parameters": {
"fontSize": 20,
"text": "Grouping",
"textColor": "#091A3E"
},
"type": "text"
},
"pillbox_1": {
"parameters": {
"compact": false,
"step": "StaticSAQLMinRanges"
},
"type": "pillbox"
},
"chart_1": {
"parameters": {
"autoFitMode": "fit",
"showValues": true,
"legend": {
"showHeader": true,
"show": true,
69
Dashboard JSON Properties widget Properties
"inside": false
},
"title": {
"label": "",
"align": "center",
"subtitleLabel": ""
},
"trellis": {
"enable": false,
"type": "x",
"chartsPerLine": 4
},
"measureAxis2": {
"showTitle": true,
"showAxis": true,
"title": ""
},
"measureAxis1": {
"showTitle": true,
"showAxis": true,
"title": ""
},
"theme": "wave",
"step": "Account_BillingCount_1",
"dimensionAxis": {
"showTitle": true,
"showAxis": true,
"title": ""
}
},
"type": "chart"
}
}
widget Properties
The widgets key defines all widgets that are available in the dashboard. It contains a separate node for each widget. Each widget
appears in all layouts to which it’s added. The properties available for each widget depend on the widget type. For example, a chart
widget has the legend property, but a text widget doesn’t.
widget Properties
The widgets key defines all widgets that are available in the dashboard. It contains a separate node for each widget. Each widget
appears in all layouts to which it’s added. The properties available for each widget depend on the widget type. For example, a chart
widget has the legend property, but a text widget doesn’t.
70
Property Name Description

parameters Widget parameters vary depending on the type of widget and, if applicable, type of chart. The step element
defines the step attached to a widget. For detailed information about different widget parameters, see
parameters Properties.
type The widget type specifies one of the other supported widget types. The value of this field must be a string.
• chart
• comparetable
• container
• dateselector
• globalfilters
• filterpanel
• image
• link
• listselector
• number
• pillbox
• rangeselector
• table
• text
• valuestable
parameters Properties
The parameters key contains a list of properties that control the appearance of the widget. Each widget type, including each
chart type, contains a unique set of properties.
parameters Properties
The parameters key contains a list of properties that control the appearance of the widget. Each widget type, including each chart
type, contains a unique set of properties.
Note: You can dynamically set properties for number and chart widgets in Analytics dashboards based on the selection or results
of another step. For example, you can change the map type in a chart based on a selection in a toggle widget. For more information,
see the Analytics Interactions Developer Guide.
Chart widgets have many properties that vary based on the chart type. For chart-specific properties for Analytics dashboards, see
Visualizing Data with Charts.
The widget properties set in the parameters property are:

absoluteModeEnabled Type
Boolean
71

• dateselector
Yes
Description
Show absolute dates in the date widget when users view the dashboard. true, by
default.
Default is true.
alignmentX Type
String
• image
Yes
Description
Indicates the horizontal alignment of the image in the widget.
alignmentX Type
String
• image
Yes
Description
Indicates the horizontal alignment of the image in the widget.
alignmentY Type
String
• image
Yes
Description
Indicates the vertical alignment of the image in the widget.
Valid values are: top (default), center, and bottom.
72

calendarTypeSwitchingAllowed Type
Boolean
• dateselector
Yes
Description
Indicates whether the dashboard viewer can switch between the fiscal and calendar
year in the date widget.
Default is false.
columns Type
Array
• chart
• table
Yes (for aggregateflex and saql step types only)
Description
List of API names of step fields to include in the widget. Use this property to include
specific fields in the widget or to change the field order for the widget. This property
appears when you reorder or hide a field while editing a widget that’s based an
aggregateflex (for a compare table) or a saql step type. To specify the fields
or change their order for widgets based on other step types, you have to manually
add and set this property in the JSON.
Example: A step returns data in the following fields: Id, Name, Amount, and Profit. To
hide the Id and Profit fields from the chart widget (chart_2), set the “columns” property.
"chart_2": {
"parameters": {
"columns": [ "Name", "Amount" ],
"step": "Amount_Prob_1",
...
},
"type": "chart",
....
}
compact Type
Boolean
73

• listselector
• number
• pillbox
Yes
Description
Indicates whether displayed numbers are abbreviated (true) or not (false).
For example, if true, the number 48,081 appears as 48k. Although the number
appears to be rounded, it is not. The value 48,081 is preserved in charts and when
performing calculations. If false, then 48,081 appears as 48,081. For number
widgets, shortened numbers are rounded to the nearest tenth.
Default is false.
computeTotal Type
Boolean
• chart (only when visualizationType is stackwaterfall and
waterfall)
Yes
Description
Indicates whether to include the total measure column (true) or not (false).
Default is true.
containedWidgets Type
List
• container
Yes
Description
A list of all widgets inside the container widget.
Example
This example shows 2 widgets (meafilter_1 and chart_1) included in the
container widget (container_1).
"container_1": {
"type": "container",
"position":{
"x": 0,
74
"y": 0
},
"parameters":{
"containedWidgets": [
"meafilter_1",
"chart_1"
]
}
}
customBulkActions Type
Boolean
• table
Yes
Description
Specifies the following details about custom bulk action.
label
Display label for the button in the table widget’s action menu. The dashboard
viewer clicks the button to execute the action.
visualforce
The name and namespace prefix of the Visualforce page that defines the bulk
action. Namespace prefix is optional.
Example
"customBulkActions":
[
{
"label": "Generate Opportunities",
"visualforce":
{
"name": "VF_Create_Opportunities",
"namespace": "Prefix"
}
}
]
defaultFiscalMode Type
Boolean
• dateselector
Yes
75
Description
Indicates whether the date widget displays dates using the fiscal year, by default. If
not, then it uses the calendar year.
Default is false.
destination Type
String
• link
Yes
Description
The ID of the dashboard, lens, step, or page.
Default is null.
destinationLink Type
String
• link
Yes
Description
The object to which you are linking. One of the following properties identifies the
linked object.
name
The ID of the dashboard, lens, step, or page. Default is null.
url
The URL that the link points to.
tooltip
The tooltip that displays when you hover over a link to a URL.
destinationType Type
String
• link
Yes
Description
The destination type of a link. Possible values are:
76
• dashboard — a dashboard
• explore — a step
• lens — a lens
• page — a page
• url — a website
Default is lens.
displayTemplate Type
String
• listselector
• pillbox
Yes
Description
Specifies the string of grouping and measure fields to display in the widget. Fields
must be enclosed in square brackets. By default, all groupings are included.
Example
This example displays the value for the Account.Type dimension,
Account.BillingCountry dimension, and Amount measure.
"displayTemplate": "[Account.Type] -
[Account.BillingCountry] ([avg_Amount])"
documentId Type
String
• image
Yes
Description
The 15-character document Id of the image file that you want to apply as the
background. To ensure security, the image file must be uploaded to Salesforce as a
document and the Externally Available Image option must be selected. If this
option is not selected or the referenced document is not an image, the image doesn’t
show up in the widget. Default is null.
Example
This example image widget (image_1) displays an image with ID
015R0000000DClP.
"image_1": {
"type": "image",
77
"parameters": {
"documentId": "015R0000000DClP",
"fit": "stretch",
"alignmentX": "center",
"alignmentY": "center"
}
}
dualAxis Type
Boolean
• chart (only when visualizationType is combo)
Yes
Description
Indicates whether to include an axis for each of the two measures (true) or not
(false).
Default is true.
exploreLink Type
Boolean
• chart
• comparetable
• listselector
• number
• pillbox
• valuestable
Yes
Description
Indicates whether the widget shows the explore icon that dashboard viewers can
click to explore the widget as a lens (true) or not (false). This option only applies
to widgets based on steps in compact form. You can’t explore widgets that are built
on SAQL form steps.
Default is true.
Note: Mobile devices display the icon, regardless of this setting.
filterItemOptions Type
List
78

• filterpanel
Yes
Description
Details about each global filter shown in the global filter panel widget. You can
configure the following details, which are also available in the user interface.
propertyColor
Color of the field name
valueColor
Color of the field value
backgroundColor
Color of the filter background
borderColor
Color of the filter border
borderWidth
Width of the filter border
borderRadius
Radius of the filter border
fit (for chart widgets) Type

Boolean
• chart (only when visualizationType is scatter)
Yes
Description
Indicates whether the axis of a chart is in the center of the data (true) or at (0, 0)
(false).
Default is false.
fit (for image widgets) Type

String
• image
Yes
Description
Indicates how to scale the image. Valid values are: original (default), stretch,
tile, fitwidth, and fitheight.
79

fontSize Type
Integer
• link
• number
• text
Yes
Description
The font size of a number or of text.
Defaults are:
• number: 36
• text: 26
hideHeaderColumn Type
Boolean
• chart
• valuestable
No. Only editable via JSON.
Description
Indicates whether the first column in a raw data table—which is simply a count of
rows—is hidden (true) or not (false).
Default is false.
Note: This setting doesn’t apply when viewing the widget on mobile devices.
image Type
Array
• container
• image
Yes
Description
Identifies the image using the following properties.
name
Name of the image.
80
namespace
Optional. Namespace of the image. Default is null.
Example
"image": {
"name": "My_Corporate_Logo",
"namespace": ""
}
includeState Type
Boolean
• link
Yes
Description
If set to true:
• Analytics passes selections in chart, list, toggle, range, and date widgets as
selections in the linked asset if they apply. For example, you select North America
in a list widget based on the Region dataset field. Analytics applies that same
selection to faceted queries in the linked dashboard that have a grouping based
on the Region field in the same dataset.
• Analytics passes global filters as filters to a linked asset as long as the filters apply.
Analytics ignores a global filter if the linked asset doesn’t use the dataset on which
the global filter is defined. If the global filter is locked and the incoming filter is
defined on the same field, Analytics ignores the incoming filter. If it’s unlocked,
the incoming filter overrides the global filter defined in the dashboard.
Default is false.
instant Type
Boolean
• dateselector
• listselector
• rangeselector
Yes
Description
Indicates whether other faceted widgets immediately update (true) or not (false)
when a dashboard viewer makes a selection in this widget.
81

When false, dashboard viewers must click Update for their changes to cascade
to faceted widgets. When true, the Update button is hidden.
Defaults are:
• dateselector: false
• listselector: true
• rangeselector: false
Note: For list, range, or date widgets that are expanded in the dashboard
designer, this widget property is always enabled. Selections in these widgets
instantly update other widgets. While these widgets are expanded, you can’t
change this setting.
itemsPerRow Type
Integer
• filterpanel
Yes
Description
Number of global filters to show per row in the global filter panel. Default is 6.
legend Type
Boolean
82

• chart (only when visualizationType is hbar, vbar, stackhbar,
stackvbar, pie, scatter, time, time-bar, time-combo, hdot,
vdot, matrix, calheatmap, heatmap, parallelcoords,
stackwaterfall, funnel, or choropleth)
Yes
Description
Indicates whether to display a legend (true), or not (false).
Default is false for all chart types, except pivottable.
Note: Mobile devices can only display legends for pie widgets.
legendHideHeader Type
Boolean
vdot, matrix, calheatmap, heatmap, stackwaterfall, combo,
combo, or parallelcoords)
Description
Indicates whether the legend has a title (true) or not (false). The title is always
the name of the dimension that the legend describes.
Default is false for all chart types except pivottable.
legendWidth Type
Integer
vdot, matrix, calheatmap, heatmap, stackwaterfall, combo,
or parallelcoords)
Description
The width of the legend area in pixels.
Default is 145 for all chart types except pivottable.
83
measureField Type
String
• listselector
• number
• pillbox
Yes
Description
The mathematical function performed on data.
Specify the measureField in this format: <formula>_<field>.
<formula> must match one of the formulas specified in the measures step
property. Possible values for <formula> are:
• avg — calculate the mathematical average (mean)
• max — the maximum value
• min — the minimum value
• sum — add all the values
• unique — count the number of unique values. For example, use to count the
number of unique dimensions.
The <field> paired with the <formula> must match the field name that is
specified in measures.
For example, if the measures step property is:
"measures”: [
[
"sum",
"Profit"
],
[
"avg",
"Discount"
],
[
"count",
"ModelNumber"
]
]
Then measureField must be sum_Profit, avg_Discount, or

unique_ModelNumber. The measureField can’t be avg_Profit because
avg and Profit aren’t paired together in the measures step property.
84
Note: Unlike for measures, a count on a dimension in the user interface

calculates the number of unique dimension values. As a result,
measureField in the underlying JSON shows the unique formula, like
unique_<dimension_field_name>.
Default is null.
multiMetrics Type
Boolean
• chart (only when visualizationType is hbar or vbar)
Yes
Description
Indicates whether two or more measures are displayed as adjacent bars under each
grouping (true) or as individual, adjacent graphs (false).
Default is false (available only for bar charts and column charts).
negativeColor Type
String
• chart (only when visualizationType is waterfall)
Yes
Description
The color of the measure columns that have decreased in value in the chart.
Specify the color in this format: rgb(a, b, c, d).
Using a number between zero and 255, a indicates how much red is in the color, b
how much green, and c how much blue. A value of 0 indicates the absence of a
color, and a value of 255 indicates the full expression of a color.
Using a number between zero and one, d indicates the level of transparency. A value
of 0 is invisible and 1 is opaque.
For example, rgb(0, 0, 0, 0.93) sets the color to a nearly opaque black.
rgb(255, 0, 0, 0.14) sets the color to a nearly invisible red.
Alternatively, the color can be set using hexadecimal notation. When using
hexadecimal notation, transparency can’t be set. All hexadecimal colors default to
opaque. #000000 indicates black in hexadecimal. #ff0000 indicates red.
normalize Type
Boolean
85

• chart (only when visualizationType is stackhbar or
stackvbar)
Yes
Description
Indicates whether charts are displayed using a logarithmic scale (true) or a linear
scale (false).
Default is false (available only for stackhbar and stackvbar).
numberColor Type
String
• number
Yes
Description
The font color of the number.
Default is #000.
numberSize Type
Integer
• number
Yes
Description
The font size of the number. Default is 26.
86

pivoted Type
Boolean
• table
Yes
Description
Indicates whether the table is pivoted. A pivot table requires the underlying step to
have at least one grouping. Analytics pivots the table on the last defined grouping.
Default is false.
positiveColor Type
String
Yes
Description
The color of the measure columns that have increased in value or remained the same
in the chart.
presetsEnabled Type
Boolean
• dateselector
Yes
87
Description
Show preset dates in the date widget when users view the dashboard. true, by
default.
Default is true.
relativeModeEnabled Type
Boolean
• dateselector
Yes
Description
Show relative dates in the date widget when users view the dashboard. true, by
default.
Default is true.
showValues Type
Boolean
• chart (only when visualizationType is stackwaterfall or
waterfall)
Yes
Description
Indicates whether to display the values of each measure column (true) or not
(false).
Default is true.
splitAxis Type
Boolean
• chart
Yes
Description
Indicates whether each dimension in a chart is measured on its own axis (true) or
a shared axis (false).
Only applicable when multiMetrics is true.
Default is false (available only for bar charts and column charts).
88
sqrt Type
Boolean
• chart (only when visualizationType is parallelcoords, hdot,
vdot, time, time-bar, time-combo, scatter, stackhbar,
stackvbar, hbar, stackwaterfall, or vbar)
Yes
Description
Indicates whether charts are displayed using a logarithmic scale (true) or a linear
scale (false).
Default is false (available only for bar charts, column charts, line charts, and time
series).
startColor Type
String
Yes
Description
The color of the first measure column in the chart.
step Type
String
89

• chart
• comparetable
• dateselector
• globalfilters
• listselector
• number
• pillbox
• rangeselector
• valuestable
Yes
Description
The name of the step that supplies data for the widget.
Default is null.
stretch Type
Boolean
• box
Yes
Description
Indicates whether an image’s width and height are set to the same values of the
widget’s width and height (true) or not (false).
Default is false.
stretchImage Type
Boolean
• container
Yes
Description
Indicates whether an image’s width and height are set to the same values of the
widget’s width and height (true) or not (false).
Default is false.
90

text Type
String
• link
• text
Yes
Description
The message rendered in a text widget. For example, if text is assigned the value
“Hello, World!”, then “Hello, World!” appears in the text widget.
Default is null.
textAlignment Type
String
• link
• number
• text
Yes
Description
The alignment of text. Possible values include left, center, and right. If no
value is specified, text alignment defaults to center.
Defaults are:
• number: right
• text: center
textColor Type
String
• link
• text
Yes
Description
The font color of text.
91

Default is #000.
title (For widgets except global filter Type

panel) String
• dateselector
• listselector
• number
• pillbox
• rangeselector
Yes
Description
The title of a widget.
Default is null.
title (for global filter panel widgets only) Type

List
• filterpanel
Yes
Description
Details about the title of the global filter panel widget. You can configure the following
details, which are also available in the user interface.
visible
Indicates whether the title is visible when viewing the dashboard
text
Details about the title: title (label), color of title (color), font size of title
(fontSize), and horizontal alignment (align)
92
separatorColor
Color of the line that separates the widget title from the global filters
titleColor Type
String
• number
Yes
Description
The font color of the title.
Default is #000.
titleSize Type
Integer
• number
Yes
Description
The font size of the title. Default is 26.
tooltip Type
String
• image
• text
93

Yes
Description
Text that appears when you hover over the widget while viewing the dashboard. Use
a tooltip to add context to the text or image.
totalColor Type
String
Yes
Description
The color of the total measure column in the chart.
totals Type
Boolean
• chart (only when visualizationType is pivottable)
Yes
Description
Indicates whether to include a row that displays the sum of all the values in each
measure column (true) or not (false).
Default for chart is false (available only for pivottable).
trellis Type
Boolean
94

• chart
Yes
Description
Indicates whether the last grouping displays on its own axis (true) if a step has
multiple groupings and one measure. If false, it displays all groupings on the same
axis.
Default for chart is false (available only for bar charts and column charts).
videoSize Type
String
• url
Yes
Description
The dimensions of a YouTube video. Possible values are:
• (4/3) 240 x 180
• (4/3) 420 x 315
• (4/3) 480 x 360
• (4/3) 640 x 480
• (4/3) 960 x 720
• (16/9) 320 x 180
• (16/9) 560 x 315
• (16/9) 640 x 360
• (16/9) 853 x 480
• (16/9) 1280 x 720
Default is (4/3) 240 x 180.
Note: Mobile devices don’t display url widgets.
visualizationType Type
String
• chart
Yes
95
Description
The type of chart used to show data. Possible values are:
• calheatmap— calendar heat map
• choropleth — choropleth (map)
• combo — lines and bars to show multiple metrics
• flatgauge — flat gauge
• funnel — funnel
• hbar — horizontal bar
• hdot — horizontal dot plot
• heatmap— heat map
• matrix— matrix
• parallelcoords — parallel coordinates
• pie — donut
• pivottable — pivot table
• polargauge — polar gauge
• pyramid — pyramid
• rating — rating
• scatter — scatter plot
• stackhbar — stacked horizontal bar
• stackpyramid — stacked pyramid
• stackvbar — stacked vertical bar
• stackwaterfall — stacked waterfall
• time — timeline
• time-bar — time bar
• time-combo — time bar
• vbar — vertical bar
• vdot — vertical dot plot
• waterfall — waterfall
url Type
ConnectUri
• url
Yes
Description
The URL of a YouTube video.
Default is null.
96
Dashboard JSON Properties filters JSON
Note: Mobile devices don’t display url widgets.
filters JSON
The filters section defines the global filters added to a global filter panel widget, which is available in the dashboard designer.
Example: Global Filters

"filters": [
{
"label": "Account.Type",
"fields": [
"Account.Type"
],
"operator": "in",
"locked": false,
"dataset": {
"name": "opportunity"
},
"value": [
"Customer"
]
},
{
"label": "ForecastCategory",
"fields": [
"ForecastCategory"
],
"operator": "in",
"locked": true,
"dataset": {
},
"value": [
"BestCase"
]
}
],
filters Properties
The filters key defines all global filters included in the dashboard. It contains a separate node for each global filter. Global filters
apply to all layouts, but you can specify whether each widget applies the global filters.
filters Properties
The filters key defines all global filters included in the dashboard. It contains a separate node for each global filter. Global filters
apply to all layouts, but you can specify whether each widget applies the global filters.
97
Property Name Description

label Field label displayed in the global filter
fields API name of the field by which to filter the records; a global filter can’t be based on multiple fields
operator Filter operator; supported operators are in (equals), not in (doesn’t equal), and matches (contains)
locked Prevents dashboard viewers from being able to change the global filter and for an incoming filter passed
from a linked dashboard to overwrite the global filter
dataset Contains the name field, which specifies the API name of the dataset that contains the filter field
Example:
"dataset": {
},
value Array of field values used to filter the records
98

Bi Dev Guide Json

Uploaded by

Copyright:

Available Formats

You might also like

Bi Dev Guide Json

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Bi Dev Guide Json

Uploaded by

Copyright:

Available Formats

Analytics Dashboard JSON

Analytics Dashboard JSON Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

View or Modify a Dashboard JSON File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Analytics Dashboard JSON Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Dashboard JSON Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

CRTL+C (Windows); CMD+C (Mac) Copy

CRTL+V (Windows); CMD+V (Mac) Paste

CRTL+Z (Windows); CMD+Z (Mac) Undo

SHIFT+CRTL+Z (Windows); SHIFT+CMD+Z Redo

CRTL+F (Windows); CMD+F (Mac) Search (RegExp, case-sensitive, or whole word

CRTL+E (Windows); CMD+E (Mac) View dashboard with changes to JSON

Example: The sample JSON defines this dashboard.

The Account Analysis dashboard consists of the following objects.

Property Name Details

Property Name Details

Exposed in the Dashboard Designer’s User Interface

Property Name Details

Property Name Details

Property Name Details

Property Name Details

Property Name Details

Property Name Details

Exposed in the Dashboard Designer’s User Interface

Property Name Details

Property Name Details

Property Name Details

Property Name Details

Property Name Details

Property Name Details

Property Name Details

Property Name Details

Exposed in the Dashboard Designer’s User Interface

Property Name Details

widgetStyle JSON and Properties

Property Name Details

Property Name Details

Exposed in the Dashboard Designer’s User Interface

aggregateflex Step Type Properties

apex Step Type Properties

aggregateflex Step Type Properties

Field Name Description

Field Name Description

Field Name Description

Field Name Description

SAQL-form Query Example

type Step type. Set to aggregateflex.

Field Name Description

Example: aggregateflex Step

steps Properties for Compact Form and SAQL Form

steps Properties for Compact Form and SAQL Form

Example: Compact-Form aggregateflex Step

Example: SAQL-Form aggregateflex Step

apex Step Type Properties

Field Name Description

Example: apex Step

To create this dashboard, complete the following steps:

Create the Apex Class

3. Add the following code.

// fetch some stock data