Newer Version Available

This content describes an older version of this product. View Latest

Dashboard Resource

Returns the Wave Analytics dashboard with the specified ID.
Resource URL
1/wave/dashboards/<dashboard ID>
Formats
JSON
Available Version
35.0
HTTP Methods
GET
GET Response Body (Dashboard Representation)
Property Name Type Description Filter Group and Version Available Version
allowPreview Boolean Indicates whether this dashboard is available for preview. Small, 35.0 35.0
assetSharingUrl String The sharing URL for the dashboard. Small, 35.0 35.0
createdBy Wave User The user who created the dashboard. Small, 35.0 35.0
createdDate Date The time the dashboard was created. Small, 35.0 35.0
datasets Asset Reference[] The list of datasets used to create this dashboard. Small, 35.0 35.0
description String The description of the dashboard. Small, 35.0 35.0
files Lens File[] The list of files used to create this dashboard. Medium, 35.0 35.0
filesUrl String The URL for the files associated with the dashboard. Small, 35.0 35.0
folder Asset Reference[] The folder that contains this dashboard. Small, 35.0 35.0
id String The 18-character dashboard ID. Small, 35.0 35.0
label String The label of the dashboard. Small, 35.0 35.0
lastAccessedDate Date The last time the dashboard was accessed, in ISO8601 date format. Small, 35.0 35.0
lastModifiedBy Wave User The user who last updated the dashboard. Small, 35.0 35.0
lastModifiedDate Date The last time the dashboard was modified, in ISO8601 date format. Small, 35.0 35.0
name String The name of the dashboard. Small, 35.0 35.0
namespace String The namespace of the dashboard. Small, 35.0 35.0
permissions Permissions The permissions for the current user. Small, 35.0 35.0
refreshDate Date The date of the most recent current dataset that is used by the dashboard, in ISO8601 date format. Small, 35.0 35.0
state Dashboard State The state of the dashboard Big, 35.0 35.0
type String The asset type. For dashboards, the value is dashboard. Small, 35.0 35.0
url String The URL to the resource for the dashboard. Small, 35.0 35.0
Dashboard State
Property Name Type Description Filter Group and Version Available Version
layouts Layout[] The list of layouts for this dashboard. Small, 35.0 35.0
steps Map<String, Step> The list of steps used to create this dashboard. The key string is the step name. Small, 35.0 35.0
widgets Map<String, Dashboard Widget> The list of widgets used to create this dashboard. The key string is the widget name. Small, 35.0 35.0
Layout
Property Name Type Description Filter Group and Version Available Version
device String The device rendering this dashboard. Values are:
  • Applewatch
  • Default
  • External
  • Ipad
  • Iphone
Small, 35.0 35.0
orientation String The layout orientation of this dashboard. Values are:
  • Landscape
  • Portrait
Small, 35.0 35.0
pages Layout Page[] The list of layout pages available for the dashboard. Small, 35.0 35.0
version Double The version of the layout for the dashboard. Small, 35.0 35.0
Layout Page
Property Name Type Description Filter Group and Version Available Version
rows String[] The rows associated with a layout page. Small, 35.0 35.0
Step

Representations of different types of steps. The properties available depend on the type of step.

Step Type Valid Properties
Multi-query step query, columns, datasets, isFacet, isGlobal, selectMode, start, type, useGlobal, and visualizationParameters
Query step query, datasets, isFacet, isGlobal, selectMode, start, type, useGlobal, and visualizationParameters
Static step dimensions, values, datasets, isFacet, isGlobal, selectMode, start, type, useGlobal, and visualizationParameters
Step Properties
Property Name Type Description Filter Group and Version Available Version
columns Column[] The queries to run for this step. Small, 35.0 35.0
datasets Asset Reference[] The list of datasets used by this step. Small, 35.0 35.0
dimensions String[] The list of dimensions for a static step. Small, 35.0 35.0
isFacet Boolean Indicates whether this step is faceted to any other step. Small, 35.0 35.0
isGlobal Boolean Indicates whether this step is a global filter that can be faceted to other steps or widgets in the dashboard. Small, 35.0 35.0
query Query The query to run for this step. Small, 35.0 35.0
selectMode String The select mode used to create the step. Values are:
  • Multi
  • MultiRequired
  • None
  • Single
  • SingleRequired
Small, 35.0 35.0
start String The start value for the step. Small, 35.0 35.0
type String The type of the dashboard step. Values are:
  • AggregateStep
  • GrainStep
  • MultiStep
  • StaticStep
Small, 35.0 35.0
useGlobal Boolean Indicates whether the step is faceted to the global step. Small, 35.0 35.0
values String[] The list of values for a static step. Small, 35.0 35.0
visualizationParameters Step Visualization Parameters The parameters for the step visualization. Small, 35.0 35.0
Step Visualization Parameters
Property Name Type Description Filter Group and Version Available Version
options Lens Visualization Options The configuration options for different step visualizations. Small, 35.0 35.0
visualizationType String The type of visualization. Values are:
  • calheatmap: Calendar heat map
  • comparisontable: Comparison table
  • heatmap: Heat map
  • hbar: Horizontal bar
  • hbarhdot: Horizontal dot plot
  • matrix: Matrix
  • parallelcoords: Parallel coordinates
  • pie: Donut
  • pivottable: Pivot table
  • scatter: Scatter plot
  • stackhbar: Stacked horizontal bar
  • stackvbar: Stacked vertical bar
  • time: Time line
  • valuestable: Values table
  • vbar: Vertical bar
  • vdot: Vertical dot plot
Small, 35.0 35.0
Dashboard Widget
Property Name Type Description Filter Group and Version Available Version
parameters Widget Parameters The valid widget parameters (based on the type of widget). Small, 35.0 35.0
position Widget Position The position information for the widget. Small, 35.0 35.0
type String The type of the widget. Values are:
  • Box
  • Chart
  • CompareTable
  • DateSelector
  • GlobalFilters
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • Text
  • Url
  • ValuesTable
Small, 35.0 35.0
Widget Parameters

The valid parameters for a widget. The properties available depend on the type of widget.

Widget Type Valid Properties
Box backgroundColor, borderColor, imageUrl, selectModeOverride, and stretch
Chart exploreLink, fit, hideHeaderColumn, legend, legendHideHeader, legendWidth, maxColumnWidth, minColumnWidth, miniBars, multiMetrics, normalize, selectModeOverride, splitAxis, sqrt, step, totals, trellis, and visualizationType
Compare Table exploreLink, maxColumnWidth, minColumnWidth, selectModeOverride, step, and totals
Date Selector expanded, instant, selectModeOverride, step, and title
Global Filters step and selectModeOverride
Link destination, destinationType, fontSize, includeState, selectModeOverride, text, textColor, and visualizationType
List Selector compact, expanded, exploreLink, instant, measureField, selectModeOverride, step, and title
Number compact, exploreLink, fontSize, measureField, selectModeOverride, step, textAlignment, textColor, and title
Pill Box compact, exploreLink, measureField, selectModeOverride, step, and title
Range Selector instant, selectModeOverride, step, and title
Text fontSize, selectModeOverride, text, textAlignment, and textColor
Url selectModeOverride, type, url, and videoSize
Values Table exploreLink, hideHeaderColumn, maxColumnWidth, minColumnWidth, selectModeOverride, step, and totals
Widget Properties

The properties available depend on the type of widget.

Property Name Type Description Filter Group and Version Available Version
backgroundColor String The background color of the widget. Small, 35.0 35.0
borderColor String The border color of the widget. Small, 35.0 35.0
compact Boolean Indicates whether the widget is compact. Small, 35.0 35.0
destination String The destination of the link. Small, 35.0 35.0
destinationType String The type of asset the link refers to. Values are:
  • Dashboard
  • Explore
  • Lens
  • Url
Small, 35.0 35.0
expanded Boolean Indicates whether the widget is expanded. Small, 35.0 35.0
exploreLink Boolean Indicates whether exploreLink is on. Small, 35.0 35.0
fit Boolean If true, fits the domain of the axis according to the data domain; If false, zero is always included in the axis domain. Small, 35.0 35.0
fontSize Integer The font size for the widget. Small, 35.0 35.0
hideHeaderColumn Boolean Indicates whether to hide the legend. Small, 35.0 35.0
imageUrl String A 15 or 18-character Salesforce document ID. Small, 35.0 35.0
includeState Boolean Indicates whether to include the state. Small, 35.0 35.0
instant Boolean Indicates whether the list selector is instant. Small, 35.0 35.0
legend Boolean Indicates whether to show the legend. Small, 35.0 35.0
legendHideHeader Boolean Indicates whether to hide the legend header. Small, 35.0 35.0
legendWidth Integer The width of the legend. Small, 35.0 35.0
maxColumnWidth Integer The maximum width of the header column. Small, 35.0 35.0
measureField String The measure field associated with this widget. Small, 35.0 35.0
minColumnWidth Integer The minimum width of the header column. Small, 35.0 35.0
miniBars Integer If true, the bar width is dynamic and the bar text and header label are not displayed. Small, 35.0 35.0
multiMetrics Boolean If true, multiple measures are projected on the same chart, side-by-side. If false (small multiple), every measure is a separate chart. The default is false. Small, 35.0 35.0
normalize Boolean Indicates whether to scales the position and size of the data shape so that it's proportional to its percentage of its category. Small, 35.0 35.0
selectModeOverride String The select mode used to create the step. Values are:
  • Multi
  • MultiRequired
  • None
  • Single
  • SingleRequired
Small, 35.0 35.0
splitAxis Boolean If true, each measure is projected on one axis. If false, all measures share an axis. Small, 35.0 35.0
sqrt Boolean Indicates whether the horizontal and vertical axes use a square root scale. Small, 35.0 35.0
step String The step name tied to this widget. Small, 35.0 35.0
stretch Boolean Indicates whether to stretch the widget. Small, 35.0 35.0
text String The value of the text. Small, 35.0 35.0
textAlignment String The alignment of the text. Values are:
  • Center
  • Left
  • Right
Small, 35.0 35.0
textColor String The text color for the widget. Small, 35.0 35.0
title String The title of the widget. Small, 35.0 35.0
totals Boolean Indicates whether to use totals. Small, 35.0 35.0
trellis Boolean If true, the last group is treated as a trellis dimension. Every distinct value of the dimension is a chart. Small, 35.0 35.0
type String The type of Wave URL for the widget. Values are:
  • Youtube
Small, 35.0 35.0
url String The Connect URI for the widget. Small, 35.0 35.0
videoSize String Size of the video this URL points to. Small, 35.0 35.0
visualizationType String The visualization type used for this widget. Values are:
  • calheatmap: Calendar heat map
  • comparisontable: Comparison table
  • heatmap: Heat map
  • hbar: Horizontal bar
  • hbarhdot: Horizontal dot plot
  • matrix: Matrix
  • parallelcoords: Parallel coordinates
  • pie: Donut
  • pivottable: Pivot table
  • scatter: Scatter plot
  • stackhbar: Stacked horizontal bar
  • stackvbar: Stacked vertical bar
  • time: Time line
  • valuestable: Values table
  • vbar: Vertical bar
  • vdot: Vertical dot plot
Small, 35.0 35.0
Widget Position
Property Name Type Description Filter Group and Version Available Version
h String The height of the widget. Small, 35.0 35.0
w String The width of the widget. Small, 35.0 35.0
x Integer The x-index of the widget. Small, 35.0 35.0
y Integer The y-index of the widget. Small, 35.0 35.0
zIndex Integer The z-index of the widget. Small, 35.0 35.0
Example Response Body
1{
2  "allowPreview" : true,
3  "assetSharingUrl" : "https://na1.salesforce.com/analytics/wave/
4	dashboard?assetId=0FKD00000004CVUOA2&orgId=00DD00000007dBq&loginHost=
5	na1-blitz02.soma.salesforce.com&urlType=sharing",
6  "createdBy" : {
7    "id" : "005D00000018LSoIAM",
8    "name" : "Wave User",
9    "profilePhotoUrl" : "https://na1.salesforce.com/profilephoto/005/T"
10  },
11  "createdDate" : "2015-02-06T00:59:00.000Z",
12  "datasets" : [ {
13    "id" : "0FbD000000000FlKAI",
14    "url" : "/services/data/v35.0/wave/datasets/0FbD000000000FlKAI"
15  }, {
16    "id" : "0FbD000000000FgKAI",
17    "url" : "/services/data/v35.0/wave/datasets/0FbD000000000FgKAI"
18  } ],
19  "files" : [ {
20    "contentType" : "image/png",
21    "fileLength" : 9039,
22    "fileName" : "assetPreviewThumb",
23    "id" : "0FJD00000004CEOOA2",
24    "lastModifiedDate" : "2015-02-06T00:59:01.000Z",
25    "url" : "/services/data/v35.0/wave/lenses/0FKD00000004CVUOA2/files/0FJD00000004CEOOA2"
26  } ],
27  "folder" : {
28    "id" : "00lD0000000wCgXIAU",
29    "url" : "/services/data/v35.0/wave/folders/00lD0000000wCgXIAU"
30  },
31  "id" : "0FKD00000004CVUOA2",
32  "label" : "Simple Dashboard",
33  "lastAccessedDate" : "2015-07-27T20:42:53.000Z",
34  "lastModifiedBy" : {
35    "id" : "005D00000018LSoIAM",
36    "name" : "Wave User",
37    "profilePhotoUrl" : "https://na1.salesforce.com/profilephoto/005/T"
38  },
39  "lastModifiedDate" : "2015-02-06T00:59:00.000Z",
40  "name" : "Simple_Dashboard",
41  "permissions" : {
42    "modify" : true,
43    "view" : true
44  },
45  "refreshDate" : "2015-02-05T23:54:40.000Z",
46  "state" : {
47    "layouts" : [ ],
48    "steps" : {
49      "T_Shirt_Size_Team_Team_Name_2" : {
50        "datasets" : [ {
51          "alias" : "Epics_With_Projects",
52          "id" : "0FbD000000000FgKAI",
53          "url" : "/services/data/v35.0/wave/datasets/0FbD000000000FgKAI"
54        } ],
55        "isFacet" : true,
56        "query" : {
57          "query" : "{&quot;measures&quot;:[[&quot;count&quot;,&quot;*&quot;]],
58            &quot;groups&quot;:[&quot;T_Shirt_Size&quot;,&quot;Team_Team_Name&quot;],
59            &quot;filters&quot;:[[&quot;T_Shirt_Size&quot;,[&quot;Extra Large&quot;,
60            &quot;Large&quot;,&quot;Medium&quot;,&quot;Small&quot;]]]}",
61          "saqlVersion" : -1.0
62        },
63        "selectMode" : "single",
64        "type" : "aggregate",
65        "visualizationParameters" : {
66          "visualizationType" : "hbar"
67        }
68      },
69      "Project_Name_T_Shirt_Size_1" : {
70        "datasets" : [ {
71          "alias" : "Epics_Without_Stories_By_Team",
72          "id" : "0FbD000000000FlKAI",
73          "url" : "/services/data/v35.0/wave/datasets/0FbD000000000FlKAI"
74        } ],
75        "isFacet" : true,
76        "query" : {
77          "query" : "{&quot;measures&quot;:[[&quot;count&quot;,&quot;*&quot;]],
78            &quot;groups&quot;:[&quot;Project_Name&quot;,&quot;T_Shirt_Size&quot;],
79            &quot;filters&quot;:[[&quot;T_Shirt_Size&quot;,[&quot;Extra Large&quot;,
80            &quot;Large&quot;,&quot;Medium&quot;]]]}",
81          "saqlVersion" : -1.0
82        },
83        "selectMode" : "single",
84        "type" : "aggregate",
85        "visualizationParameters" : {
86          "visualizationType" : "matrix"
87        }
88      }
89    },
90    "widgets" : {
91      "chart_2" : {
92        "parameters" : {
93          "step" : "T_Shirt_Size_Team_Team_Name_2",
94          "visualizationType" : "hbar"
95        },
96        "position" : {
97          "h" : "500",
98          "w" : "560",
99          "x" : 10,
100          "y" : 10,
101          "zIndex" : 1
102        },
103        "type" : "Chart"
104      },
105      "chart_1" : {
106        "parameters" : {
107          "step" : "Project_Name_T_Shirt_Size_1",
108          "visualizationType" : "matrix"
109        },
110        "position" : {
111          "h" : "240",
112          "w" : "280",
113          "x" : 580,
114          "y" : 20,
115          "zIndex" : 0
116        },
117        "type" : "Chart"
118      }
119    }
120  },
121  "type" : "dashboard",
122  "url" : "/services/data/v35.0/wave/dashboards/0FKD00000004CVUOA2"
123}