Newer Version Available

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

Dashboard Resource

Returns or updates the dashboard with the specified ID or API name.
Resource URL
1/wave/dashboards/<dashboard ID or API name>
Formats
JSON
Available Version
36.0
HTTP Methods
GET DELETE PATCH

The POST method is supported through /wave/dashboards.

Refer to the PATCH and POST input representations below.

GET and PATCH Response Body (DashboardRepresentation)
Property Name Type Description Filter Group and Version Available Version
allowPreview Boolean Indicates whether this dashboard is available for preview. Small, 36.0 36.0
assetSharingUrl String The URL for opening this asset in the Analytics builder. This is a form of deep linking. The server examines the link parameters, which might include urlType, assetId, orgId, and loginHost, as well as other optional parameters, and translates as necessary to produce the correct result on the target client. For example, it will open the Analytics dashboard on desktop clients, or mobile if you are on a mobile OS. For example, the shared URL:
1http://{host}/​analytics/​application/​005xx000001SvSwAAK?​urlType=sharing&​orgId=00DT0000000Dpvc&​loginHost=​https%3A%2F%2F​test.my.salesforce.com
Might produce the following web Url:
1http://{host}/​insights/​web/​explore.apexp#​application/​005xx000001SvSwAAK
Or it might produce the following Url on iOS:
1com.salesforce.kona://​application/​005xx000001SvSwAAK&​orgId=00DT0000000Dpvc&​loginHost=​https%3A%2F%2F​test.my.salesforce.com
Small, 36.0 36.0
createdBy Wave​User​Representation The user who created the dashboard. Small, 36.0 36.0
createdDate Date The time the dashboard was created. Small, 36.0 36.0
datasets Asset​Reference​Representation[] The list of datasets used to create this dashboard. Small, 36.0 36.0
description String The description of the dashboard. Small, 36.0 36.0
files Lens File[] The list of files used to create this dashboard. Medium, 36.0 36.0
filesUrl String The URL for the files associated with the dashboard. Small, 36.0 36.0
folder Asset​Reference​Representation[] The folder that contains this dashboard. Small, 36.0 36.0
id String The 18-character dashboard ID. Small, 36.0 36.0
label String The label of the dashboard. Small, 36.0 36.0
lastAccessedDate Date The last time the dashboard was accessed, in ISO8601 date format. Small, 36.0 36.0
lastModifiedBy Wave​User​Representation The user who last updated the dashboard. Small, 36.0 36.0
lastModifiedDate Date The last time the dashboard was modified, in ISO8601 date format. Small, 36.0 36.0
mobileDisabled Bool If the dashboard is disabled for mobile. Small, 41.0 41.0
name String The name of the dashboard. Small, 36.0 36.0
namespace String The namespace of the dashboard. Small, 36.0 36.0
permissions Permissions​Representation The permissions for the current user. Small, 36.0 36.0
refreshDate Date The date of the most recent current dataset that is used by the dashboard, in ISO8601 date format. Small, 36.0 36.0
state Dashboard State The state of the dashboard Big, 36.0 36.0
type String The asset type. For dashboards, the value is dashboard. Small, 36.0 36.0
url String The URL to the resource for the dashboard. Small, 36.0 36.0
Dashboard State
Property Name Type Description Filter Group and Version Available Version
dataSourceLinks Dashboard​Data​Source​Link​Representation[] List of all datasource links in a dashboard. Small, 39.0 39.0
filters Filter​Item​Representation[] List of datasource filter applied in this dashboard. Small, 41.0 41.0
gridLayoutStyle Grid​Layout​Style​Representation Styling for the grid layout. Is paired with the gridLayouts property and is meant to replace the 'layouts' property. Small, 36.0 36.0 (Max 37.0)
gridLayouts Grid​Layout​Representation[] List of all grid layouts for this dashboard. This property replaces the 'layouts' property and the two are mutually exclusive. Small, 36.0 36.0
layouts Layout[] The list of layouts for this dashboard. This list is being replaced by gridLayouts. Small, 36.0 36.0
steps Map<String, Step> The list of steps used to create this dashboard. The key string is the step name. Small, 36.0 36.0
widgetStyle Grid​Layout​Widget​Style​Representation Default styling for widgets in this dashboard. Small, 37.0 37.0
widgets Map<String, Dashboard Widget> The list of widgets used to create this dashboard. The key string is the widget name. Small, 36.0 36.0
DashboardDataSourceLinkRepresentation
Property Name Type Description Filter Group and Version Available Version
fields Dashboard​Data​Source​Field​Representation[] The list of fields in a datasource link Small, 39.0 39.0
label String The label of the datasource link Small, 39.0 39.0
name String The name of datasource link Small, 39.0 39.0
DashboardDataSourceFieldRepresentation
Property Name Type Description Filter Group and Version Available Version
dataSourceName String The datasource developer name. Small, 39.0 39.0
data​Source​Namespace String The namespace that qualifies the dataset name Small, 39.0 39.0
dataSourceType Connect​Wave​Data​Source​Type​Enum The type of datasource (Saql or Static). Small, 39.0 39.0
fieldName String The name of field in the datasource Small, 39.0 39.0
FilterItemRepresentation
Property Name Type Description Filter Group and Version Available Version
dataset Asset​Reference​Representation Datasource on which filter will be applied. Small, 41.0 41.0
fields String[] List of fields in filter. Small, 41.0 41.0
hidden Boolean Field to denote if filter is hidden in view mode or not. Small, 41.0 41.0
label String Label of the filter. Small, 41.0 41.0
locked Boolean Field to denote if filter is locked or not. Small, 41.0 41.0
operator String Operator for the filter. Small, 41.0 41.0
value String Value for the filter. Small, 41.0 41.0
GridLayoutStyleRepresentation
Property Name Type Description Filter Group and Version Available Version
background​Color String Background color for the layout. Small, 37.0 37.0
cellSpacingX Integer Horizontal spacing between grid cells. Small, 37.0 37.0
cellSpacingY Integer Vertical spacing between grid cells. Small, 37.0 37.0
gutterColor String Gutter color of the layout. Small, 39.0 39.0
image Asset​Reference​Representation Image representation containing the name and namespace. Small, 39.0 39.0
widgetStyle Grid​Layout​Widget​Style​Representation Default styling for widgets across all layouts. Small, 36.0 36.0—36.0
GridLayoutWidgetStyleRepresentation
Property Name Type Description Filter Group and Version Available Version
background​Color String Background color for the widget. Will be a 6 character hex string. For example: #012345. Small, 36.0 36.0
borderColor String Color of the widget's border. Will be a 6 character hex string. For example: #012345. Small, 36.0 36.0
borderEdges Connect​Wave​Border​Edge​Type​Enum[] Edges of the border to be drawn (All, Bottom, Left, Right, or Top). Small, 36.0 36.0
borderRadius Object Border radius of the widget. Small, 36.0 36.0
borderWidth Object Width of the widget's border. Small, 36.0 36.0
bottomPadding Integer Amount of padding on the bottom of the widget when rendered on mobile clients. Small, 36.0 36.0
leftPadding Integer Amount of padding on the left of the widget when rendered on mobile clients. Small, 36.0 36.0
rightPadding Integer Amount of padding on the right of the widget when rendered on mobile clients. Small, 36.0 36.0
topPadding Integer Amount of padding on the top of the widget when rendered on mobile clients. Small, 36.0 36.0
GridLayoutRepresentation
Property Name Type Description Filter Group and Version Available Version
maxWidth Integer Add the ability for users to specify the maximum width that their dashboard will flex to. Small, 38.0 38.0
name String Name of this layout. Small, 36.0 36.0
numColumns Integer Add the number of columns for a dashboard grid layout that is customizable. Small, 38.0 38.0
pages Grid​Layout​Page​Representation[] List of pages of widgets within the layout. Small, 36.0 36.0
rowHeight Connect​Wave​Row​Height​Enum Specifies the grid cell row height (Fine or Normal). Small, 39.0 39.0
selectors String[] List of selectors this layout applies to. Small, 36.0 36.0
style Grid​Layout​Style​Representation Styling for the layout. Small, 37.0 37.0
version Double Version of this layout. Small, 36.0 36.0
widgetStyle Grid​Layout​Widget​Style​Representation Default styling for widgets within the layout. Small, 36.0 36.0—37.0
GridLayoutPageRepresentation
Property Name Type Description Filter Group and Version Available Version
widgets Grid​Layout​Widget​Representation[] Widgets within the page. Small, 36.0 36.0
GridLayoutWidgetRepresentation
Property Name Type Description Filter Group and Version Available Version
background​Image String Background image for the widget. Small, 36.0 36.0
colspan Integer Number of grid layout columns this widget spans. Small, 36.0 36.0
column Integer Column where this widget is located. Small, 36.0 36.0
name String Name of the widget. Small, 36.0 36.0
row Integer Row where this widget is located. Small, 36.0 36.0
rowspan Integer Number of grid layout rows this widget spans. Small, 36.0 36.0
widgetStyle Grid​Layout​Widget​Style​Representation Style of the widget. Small, 36.0 36.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, 36.0 36.0
orientation String The layout orientation of this dashboard. Values are:
  • Landscape
  • Portrait
Small, 36.0 36.0
pages Layout Page[] The list of layout pages available for the dashboard. Small, 36.0 36.0
version Double The version of the layout for the dashboard. Small, 36.0 36.0
Layout Page
Property Name Type Description Filter Group and Version Available Version
rows String[] The rows associated with a layout page. Small, 36.0 36.0
Step

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

Step Type Valid Properties
Multi-query step columns, datasets, globalQuery, isFacet, isGlobal, label, selectMode, start, type, useGlobal, and visualizationParameters
Query step datasets, isFacet, isGlobal, label, query, selectMode, start, type, useGlobal, and visualizationParameters
Saql step datasets, groups, isFacet, isGlobal, label, numbers, query, selectMode, start, strings, type, useGlobal, and visualizationParameters
Soql step groups, isFacet, label, numbers, query, selectMode, start, strings, type, useGlobal
Static Flex step datasets, dimensions, groups, isFacet, isGlobal, label, selectMode, start, strings, type, useGlobal, values
Static step datasets, dimensions, isFacet, isGlobal, label, selectMode, start, type, useGlobal, values, and visualizationParameters
Step Properties
Property Name Type Description Filter Group and Version Available Version
columns Column[] The queries to run for this step. Small, 36.0 36.0
datasets Asset​Reference​Representation[] The list of datasets used by this step. Small, 36.0 36.0
dimensions String[] The list of dimensions for a static step. Small, 36.0 36.0
globalQuery >Query Query override for all columns. Small, 36.0 36.0
isFacet Boolean Indicates whether this step is faceted to any other step. Small, 36.0 36.0
isGlobal Boolean Indicates whether this step is a global filter that can be faceted to other steps or widgets in the dashboard. Small, 36.0 36.0
groups String[] List of names for the projected columns which the results are grouped by for a Step. Small, 39.0 39.0
label String Display label for the step. Small, 39.0 39.0
numbers String[] List of projected column names of the step. Small, 39.0 39.0
query Query The query to run for this step. Small, 36.0 36.0
selectMode String The select mode used to create the step (multi, multirequired, none, single, or singlerequired). Small, 36.0 36.0
start String The start value for the step. Small, 36.0 36.0
strings String[] List of projected column names of the step. Small, 39.0 39.0
type String The type of the dashboard step. Values are:
  • Aggregate
  • AggregateFlex
  • Grain
  • Multi
  • Saql
  • Soql
  • Static
  • StaticFlex
Small, 36.0 36.0
useGlobal Boolean If true, the step gets tied to the global step. Small, 39.0 39.0
values String[] The list of values for a static step. Small, 36.0 36.0
visualization​Parameters Step Visualization Parameters The parameters for the step visualization. Small, 36.0 36.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, 36.0 36.0
parameters Object Valid widget parameters based on its type. Small, 40.0 40.0
type Connect​Wave​Widget​Type​Enum The type of the widget. Values are:
  • Box
  • Chart
  • CompareTable
  • Container
  • DateSelector
  • GlobalFilters
  • Image
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • Table
  • Text
  • Url
  • ValuesTable
Small, 40.0 40.0
visualizationType String The type of visualization. Values are:
  • calheatmap: Calendar heat map
  • comparisontable: Compare table
  • heatmap: Heat map
  • hbar: Bar
  • hbarhdot: Horizontal dot plot
  • matrix: Matrix
  • parallelcoords: Parallel coordinates
  • pie: Donut
  • pivottable: Pivot table
  • scatter: Scatter plot
  • stackhbar: Stacked bar
  • stackvbar: Stacked column
  • time: Timeline
  • valuestable: Values table
  • vbar: Column
  • vdot: Vertical dot plot
Small, 36.0 36.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, 36.0 36.0
position Widget Position The position information for the widget. Small, 36.0 36.0
type String The type of the widget. Values are:
  • Box
  • Chart
  • CompareTable
  • Container
  • DateSelector
  • GlobalFilters
  • Image
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • Table
  • Text
  • Url
  • ValuesTable
Small, 36.0 36.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
Compare Table exploreLink, maxColumnWidth, minColumnWidth, selectModeOverride, step, and totals
Container alignmentX, alignmentY, documentId, fit, image, exploreLink, maxColumnWidth, minColumnWidth, selectModeOverride, step, and totals
Date Selector calendarTypeSwitchingAllowed, defaultAbsoluteMode, defaultFiscalMode, expanded, instant, modeSwitchingAllowed, selectModeOverride, step, and title
Global Filters step and selectModeOverride
Image alignmentX, alignmentY, documentId, fit, image, step and selectModeOverride
Link destination, destinationLink, destinationType, fontSize, includeState, selectModeOverride, text, textAlignment, textColor, and visualizationType
List Selector compact, displayTemplate, expanded, exploreLink, instant, measureField, selectModeOverride, step, and title
Number compact, exploreLink, fontSize, measureField, numberColor, numberSize, selectModeOverride, step, textAlignment, textColor, title, titleColor, titleSize
Pill Box compact, displayTemplate, exploreLink, measureField, selectModeOverride, step, and title
Range Selector instant, selectModeOverride, step, and title
Text fontSize, selectModeOverride, text, textAlignment, and textColor
Table customBulkActions, exploreLink, fixedColumnWidth, maxColumnWidth, minColumnWidth, mode, pivoted, selectModeOverride, step, totals
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
alignmentX Connect​Wave​Horizontal​Alignment​Enum Horizontal Alignment of the image. Valid values: Left, Center, Right. Small, 37.0 37.0
alignmentY Connect​Wave​Vertical​Alignment​Enum Vertical Alignment of the image. Valid values: Top, Center, Bottom. Small, 37.0 37.0
backgroundColor String The background color of the widget. Small, 36.0 36.0
borderColor String The border color of the widget. Small, 36.0 36.0
calendar​Type​Switching​Allowed Boolean Indicates whether widget can switch calendar types. Small, 39.0 39.0
compact Boolean Indicates whether the widget is compact. Small, 36.0 36.0
customBulkActions Custom​Bulk​Action​Representation Custom bulk actions for this widget. Small, 39.0 39.0
default​Absolute​Mode Boolean Indicates default date mode. Small, 39.0 39.0
default​Fiscal​Mode Boolean Indicates default calendar type. Small, 39.0 39.0
destination String The destination of the link. Small, 36.0 36.0
destinationLink Asset​Reference​Representation The destination (Dashboard, Lens, step) reference of this link. Small, 39.0 39.0
destinationType String The type of asset the link refers to. Values are:
  • Dashboard
  • Explore
  • Lens
  • Url
Small, 36.0 36.0
displayTemplate String Display template for widget level projection. Small, 39.0 39.0
documentId String Document Id of an image (Images uploaded using salesforce's document API). Small, 37.0 37.0
expanded Boolean Indicates whether the widget is expanded. Small, 36.0 36.0
exploreLink Boolean Indicates whether exploreLink is on. Small, 36.0 36.0
fit Connect​Wave​Image​Fit​Type​Enum Image fit inside this widget. Valid values: Original, Tile, Cover, Strech. Small, 37.0 37.0
fixedColumnWidth Integer Fixed column width for this table widget. Small, 40.0 40.0
fontSize Integer The font size for the widget. Small, 36.0 36.0
hideHeaderColumn Boolean Indicates whether to hide the legend. Small, 36.0 36.0
image Asset​Reference​Representation Image representation containing the name and namespace. Small, 39.0 39.0
imageUrl String A 15-character or 18-character Salesforce document ID. Small, 36.0 36.0
includeState Boolean Indicates whether to include the state. Small, 36.0 36.0
instant Boolean Indicates whether the list selector is instant. Small, 36.0 36.0
legend Boolean Indicates whether to show the legend. Small, 36.0 36.0
legendHideHeader Boolean Indicates whether to hide the legend header. Small, 36.0 36.0
legendWidth Integer The width of the legend. Small, 36.0 36.0
maxColumnWidth Integer The maximum width of the header column. Small, 36.0 36.0
measureField String The measure field associated with this widget. Small, 36.0 36.0
minColumnWidth Integer The minimum width of the header column. Small, 36.0 36.0
miniBars Integer If true, the bar width is dynamic and the bar text and header label are not displayed. Small, 36.0 36.0
mode Connect​Wave​Table​Mode​Enum Table mode for this widget (FitToContainer, Fixed, or Variable). Small, 40.0 40.0
mode​Switching​Allowed Boolean Indicates whether widget can switch between two date modes. Small, 39.0 39.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, 36.0 36.0
normalize Boolean Indicates whether to scale the position and size of the data shape so that it's proportional to its percentage of its category. Small, 36.0 36.0
numberColor String Color of the number inside this widget. Small, 36.0 36.0
numberSize Object Size of the number. Small, 36.0 36.0
pivoted Boolean Value indicating whether to display table as pivot. Small, 39.0 39.0
select​Mode​Override String The select mode used to create the step (multi, multirequired, none, single, singlerequired). Small, 36.0 36.0
splitAxis Boolean If true, each measure is projected on one axis. If false, all measures share an axis. Small, 36.0 36.0
sqrt Boolean Indicates whether the horizontal and vertical axes use a square root scale. Small, 36.0 36.0
step String The step name tied to this widget. Small, 36.0 36.0
stretch Boolean Indicates whether to stretch the widget. Small, 36.0 36.0
text String The value of the text. Small, 36.0 36.0
textAlignment String The alignment of the text. Values are:
  • Center
  • Left
  • Right
Small, 36.0 36.0
textColor String The text color for the widget. Small, 36.0 36.0
title String The title of the widget. Small, 36.0 36.0
titleColor String Color of the title inside this widget. Small, 36.0 36.0
titleSize Object Size of the title text. Small, 36.0 36.0
totals Boolean Indicates whether to use totals. Small, 36.0 36.0
trellis Boolean If true, the last group is treated as a trellis dimension. Every distinct value of the dimension is a chart. Small, 36.0 36.0
type String The type of Analytics URL for the widget. Values are:
  • Youtube
Small, 36.0 36.0
url String The Connect URI for the widget. Small, 36.0 36.0
videoSize String Size of the video this URL points to. Small, 36.0 36.0
visualizationType String The visualization type used for this widget. Values are:
  • calheatmap: Calendar heat map
  • comparisontable: Compare table
  • heatmap: Heat map
  • hbar: Bar
  • hbarhdot: Horizontal dot plot
  • matrix: Matrix
  • parallelcoords: Parallel coordinates
  • pie: Donut
  • pivottable: Pivot table
  • scatter: Scatter plot
  • stackhbar: Stacked bar
  • stackvbar: Stacked column
  • time: Timeline
  • valuestable: Values table
  • vbar: Column
  • vdot: Vertical dot plot
Small, 36.0 36.0
Widget Position
Property Name Type Description Filter Group and Version Available Version
h String The height of the widget. Small, 36.0 36.0
w String The width of the widget. Small, 36.0 36.0
x Integer The x-index of the widget. Small, 36.0 36.0
y Integer The y-index of the widget. Small, 36.0 36.0
zIndex Integer The z-index of the widget. Small, 36.0 36.0
PATCH and POST Request Body (DashboardInputRepresentation). The POST method is supported through /wave/dashboards.
DashboardInputRepresentation
Property Name Type Description Required or Optional Available Version
state Dashboard​State​Input​Representation The state of the dashboard. Optional for PATCH, required for POST 36.0
folder Asset​Reference​Input​Representation Folder in which this dashboard is stored. Optional for PATCH, required for POST 36.0
description String Short description of the asset. Optional 36.0
label String The label of the asset. Optional for PATCH, required for POST 36.0
mobileDisabled Boolean Whether the dashboard is disabled on mobile. 41.0
name String The name of the asset. Optional 36.0
DashboardStateInputRepresentation
Property Name Type Description Required or Optional Available Version
data​Source​Links Dashboard​Data​Source​Link​Input​Representation[] List of datasource links used as part of this dashboard. 39.0
filters Filter​Item​Input​Representation[] List of datasource filter applied in this dashboard. 41.0
grid​Layout​Style Grid​Layout​Style​Input​Representation Overall styling for the GridLayouts used as part of this dashboard. Optional 36.0 - 37.0
gridLayouts List (Grid​Layout​Input​Representation[]) List of Grid​Layout​Inpu​tRepresentation objects used as part of this dashboard. If present, 'layouts' must not be set. Optional 36.0
layouts List (Layout​Input​Representation[]) List of Layout​Input​Representation objects used as part of this dashboard. Optional 36.0
steps Map (key of type String) ( Aggregate​Flex​Query​Step​Input​Representation, Aggregate​Query​Step​Input​Representation, Grain​Query​Step​Input​Representation, Multi​Query​Step​Input​Representation, Saql​Step​Input​Representation, Soql​Step​Input​Representation) Static​Flex​Step​Input​Representation, Static​Step​Input​Representation, Map of all the steps used to create this dashboard keyed with their names. Optional 36.0
widget​Style Grid​Layout​Widget​Style​Input​Representation Default styling for widgets in this dashboard. Optional 37.0
widgets Map (key of type String) (Dashboard​Widget​Input​Representation) Map of all the Dashboard​Widget​Input​Representation objects used to create this dashboard keyed with their names. Optional 36.0
DashboardDataSourceLinkInputRepresentation
Property Name Type Description Required or Optional Available Version
fields Dashboard​Data​Source​Field​Input​Representation[] List of fields connected in the datasource link 39.0
label String Label of the datasource link 39.0
name String Name of the datasource link 39.0
DashboardDataSourceFieldInputRepresentation
Property Name Type Description Required or Optional Available Version
data​Source​Name String Developer Name of the datasource. 39.0
data​Source​Namespace String The namespace that qualifies the dataset asset name 39.0
data​Source​Type Connect​Wave​Data​Source​Type​Enum Type of datasource (Saql or Static). 39.0
fieldName String Name of the field in datasource 39.0
FilterItemInputRepresentation
Property Name Type Description Required or Optional Available Version
dataset Asset​Reference​Input​Representation Datasource on which filter will be applied 41.0
fields String[] List of fields in filter 41.0
hidden Boolean Field to denote if filter is hidden in view mode or not 41.0
label String Label of the filter 41.0
locked Boolean Field to denote if filter is locked or not 41.0
operator String Operator for the filter 41.0
value String Value for the filter 41.0
AssetReferenceInputRepresentation
Property Name Type Description Required or Optional Available Version
id String ID of the asset. Optional * 36.0
name String Developer name of the asset. Optional * 36.0
namespace String The namespace that qualifies the asset name. The default is the current organization's namespace. This is "empty namespace" for all organizations except those developer edition orgs that have set a namespace. So only set namespace when referencing a dataset that is from an installed managed package. Context dependant 37.0

* When used in dashboard steps datasets, you must give a name. If the asset has a namespace, you must also give that. You should not give an id in this case, it will be ignored. In all other cases, you must give an id and neither a name or a namespace.

GridLayoutStyleInputRepresentation
Property Name Type Description Required or Optional Available Version
background​Color String Background color for the layout. 37.0
cell​SpacingX Integer Horizontal spacing between grid cells. 37.0
cell​SpacingY Integer Vertical spacing between grid cells. 37.0
gutterColor String Gutter color of the layout. 39.0
image Asset​Reference​Representation Image representation containing the name and namespace. Small, 39.0 39.0
widgetStyle Grid​Layout​Widget​Style​Input​Representation Default styling for widgets across all layouts. Optional 36.0
AggregateFlexQueryStepInputRepresentation
Property Name Type Description Required or Optional Available Version
query Query​Input​Representation SAQL used to create this step Optional for PATCH, required for POST 36.0
datasets Asset​Reference​Input​Representation[] List of all dataset aliases used in this step. Optional 36.0
isFacet Boolean Determines if this step is tied/facetted to any other step Optional 36.0
isGlobal Boolean If true, this step is a global filter which can be faceted to other steps/widgets in dashboard. Optional 36.0
label String Display label for the step. 39.0
selectMode Connect​Wave​Select​Mode​Enum The selectmode used (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
start String Start value for the step. Optional 36.0
type Connect​Wave​Dashboard​Step​Type​Enum The type of the dashboard step (Aggregate, AggregateFlex, Grain, Multi, Saql, Soql, Static, or StaticFlex). Optional for PATCH, required for POST 36.0
useGlobal Boolean If true, step gets tied to the global step Optional 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation The visualization parameters for the dashboard step. Optional 36.0
AggregateQueryStepInputRepresentation
Property Name Type Description Required or Optional Available Version
query Query​Input​Representation SAQL used to create this Step Optional for PATCH, required for POST 36.0
datasets Asset​Reference​Input​Representation[] List of all dataset aliases used in this step. Optional 36.0
isFacet Boolean Determines if this step is tied/facetted to any other step Optional 36.0
isGlobal Boolean If true, this step is a global filter which can be faceted to other steps/widgets in dashboard. Optional 36.0
label String Display label for the step. 39.0
selectMode Connect​Wave​Select​Mode​Enum The selectmode used (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
start String Start value for the step. Optional 36.0
type Connect​Wave​Dashboard​Step​Type​Enum The type of the dashboard step (Aggregate, AggregateFlex, Grain, Multi, Saql, Soql, Static, or StaticFlex). Optional for PATCH, required for POST 36.0
useGlobal Boolean If true, step gets tied to the global step Optional 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation The visualization parameters for the dashboard step. Optional 36.0
GrainQueryStepInputRepresentation
Property Name Type Description Required or Optional Available Version
query Query​Input​Representation SAQL Query to run for this step. Optional for PATCH, required for POST 36.0
datasets Asset​Reference​Input​Representation[] A list of all the datasets used in this step. Optional 36.0
isFacet Boolean Determines if this step is tied/facetted to any other step Optional 36.0
isGlobal Boolean If true, this step is a global filter which can be faceted to other steps/widgets in dashboard. Optional 36.0
label String Display label for the step. 39.0
selectMode Connect​Wave​Select​Mode​Enum The selectmode used (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
start String Start value for the step. Optional 36.0
type Connect​Wave​Dashboard​Step​Type​Enum The type of the dashboard step (Aggregate, AggregateFlex, Grain, Multi, Saql, Soql, Static, or StaticFlex). Optional for PATCH, required for POST 36.0
useGlobal Boolean If true, step gets tied to the global step Optional 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation The visualization parameters for the dashboard step. Optional 36.0
MultiQueryStepInputRepresentation
Property Name Type Description Required or Optional Available Version
columns Column​Input​Representation[] The list of columns of the comparison table. Optional 36.0
globalQuery Query​Input​Representation Query override for all columns. Optional 36.0
datasets Asset​Reference​Input​Representation[] List of all the dataset aliases used in this step. Optional 36.0
isFacet Boolean Detemines if this step is tied/facetted to any other step Optional 36.0
isGlobal Boolean If true, this step is a global filter which can be faceted to other steps/widgets in dashboard. Optional 36.0
label String Display label for the step. 39.0
selectMode Connect​Wave​Select​Mode​Enum The selectmode used (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
start String Start value for the step. Optional 36.0
type Connect​Wave​Dashboard​Step​Type​Enum The type of the dashboard step (Aggregate, AggregateFlex, Grain, Multi, Saql, Soql, Static, or StaticFlex). Optional for PATCH, required for POST 36.0
useGlobal Boolean If true, step gets tied to the global step. Optional 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation The visualization parameters for the dashboard step. Optional 36.0
SaqlStepInputRepresentation
Property Name Type Description Required or Optional Available Version
broadcast​Facet Boolean Whether the step should broadcast faceting. 41.0
isFacet Boolean Detemines if this step is tied/facetted to any other step. 36.0 to 40.0
receive​Facet Boolean Whether the step should receive faceting. 41.0
SoqlStepInputRepresentation
Property Name Type Description Required or Optional Available Version
groups String[] Names for the projected columns which the results are grouped by for a Step 39.0
label String Display label for the step. 39.0
numbers String[] projected column names of the step 39.0
query String SOQL used to create this Step 39.0
selectMode Connect​Wave​Select​Mode​Enum The selectmode used (Multi, MultiRequired, None, Single, or SingleRequired). 39.0
start String Start value for the step. 39.0
strings String[] projected column names of the step 39.0
type Connect​Wave​Dashboard​Step​Type​Enum The type of the dashboard step (Aggregate, AggregateFlex, Grain, Multi, Saql, Soql, Static, or StaticFlex). 36.0
useGlobal Boolean If true, step gets tied to the global step 39.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation The visualization parameters for the dashboard step. 36.0
StaticFlexStepInputRepresentation
Property Name Type Description Required or Optional Available Version
datasets Asset​Reference​Input​Representation[] List of all dataset aliases used in this step. Optional 36.0
dimensions String[] List of dimensions of the static step. Optional 36.0
groups String[] Names for the projected columns which the results are grouped by for a Step 39.0
isFacet Boolean Determines if this step is tied/facetted to any other step Optional 38.0
isGlobal Boolean If true, this step is a global filter which can be faceted to other steps/widgets in dashboard. Optional 38.0
label String Display label for the step. 39.0
numbers String[] projected column names of the step 39.0
selectMode Connect​Wave​Select​Mode​Enum The selectmode used (Multi, MultiRequired, None, Single, or SingleRequired). Optional 38.0
start String Start value for the step. Optional 38.0
strings String[] projected column names of the step 39.0
type Connect​Wave​Dashboard​Step​Type​Enum The type of the dashboard step (Aggregate, AggregateFlex, Grain, Multi, Saql, Soql, Static, or StaticFlex). Optional for PATCH, required for POST 36.0
useGlobal Boolean If true, step gets tied to the global step Optional 38.0
values String[] List of values of this step. Optional 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation The Visualization Parameters for the dashboard step. Optional 38.0
StaticStepInputRepresentation
Property Name Type Description Required or Optional Available Version
datasets Asset​Reference​Input​Representation[] List of all dataset aliases used in this step. Optional 36.0
dimensions String[] List of dimensions of the static step. Optional 36.0
isFacet Boolean Determines if this step is tied/facetted to any other step Optional 36.0
isGlobal Boolean If true, this step is a global filter which can be faceted to other steps/widgets in dashboard. Optional 36.0
label String Display label for the step. 39.0
selectMode Connect​Wave​Select​Mode​Enum The selectmode used (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
start String Start value for the step. Optional 36.0
type Connect​Wave​Dashboard​Step​Type​Enum The type of the dashboard step (Aggregate, AggregateFlex, Grain, Multi, Saql, Soql, Static, or StaticFlex). Optional for PATCH, required for POST 36.0
useGlobal Boolean If true, step gets tied to the global step Optional 36.0
values String[] List of values of this step. Optional 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation The visualization parameters for the dashboard step. Optional 36.0
ColumnInputRepresentation
Property Name Type Description Required or Optional Available Version
format Connect​Wave​Column​Format​Enum Format for this column (CurrencyCents, CurrencyDollars, or Percentage). Optional 36.0
header String Header text of this column. Optional 36.0
hidden Boolean Whether or not this column is hidden. Optional 36.0
query Query​Input​Representation SAQL used to create this comparison table. Optional 36.0
showBars Boolean Whether or not to show bars for this column. Optional 36.0
sort Connect​Wave​Column​Sort​Enum Sort order for this column (Ascending, Descending, InnerAscending, InnerDescending, or None). Optional 36.0
QueryInputRepresentation
Property Name Type Description Required or Optional Available Version
query String The SAQL query. Optional for PATCH, required for POST 36.0
version Double Version to which this query language construct belongs. Optional for PATCH, required for POST 36.0
StepVisualizationParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
options Lens​Visualization​Options​Input​Representation The visualization option associated with this step. Optional 36.0
parameters Object Valid widget parameters based on its type. 40.0
type Connect​Wave​Widget​Type​Enum The type of the widget. Values are:
  • Box
  • Chart
  • CompareTable
  • Container
  • DateSelector
  • GlobalFilters
  • Image
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • Table
  • Text
  • Url
  • ValuesTable
40.0
visualization​Type String The type of the visualization (Calendar​Heat​Map, Combo, Comparison​Table, Heat​Map, Horizontal​Bar, Horizontal​Dot, Matrix, Parallel​Coordinates, Pie, Pivot​Table, Scatter, Stack​Waterfall, Stacked​Horizontal​Bar, Stacked​Horizontal​Bar, Time, Values​Table, Vertical​Bar, Vertical​Dot, or Waterfall). Optional 36.0
LensVisualizationOptionsInputRepresentation
Property Name Type Description Required or Optional Available Version
fit Boolean Scale the position and size of data shape so that it’s proportional to its percentage of its category. Optional 36.0
hideHeaderColumn Boolean Value indicating whether to display header column or not. Optional 36.0
legend Boolean Value indicates whether to show legend or not. Optional 36.0
legendHideHeader Boolean Value indicating whether to hide legend. Optional 36.0
legendWidth Integer The Width of the legend. Optional 36.0
maxColumnWidth Integer The Maximum width of the header column. Optional 36.0
minColumnWidth Integer The Minimum width of the header column. Optional 36.0
miniBars Integer The width of the MiniBars, if used. Optional 36.0
multiMetrics Boolean As opposed to small multiple(default), when true, multiple measures will be projected on the same chart, side-by-side. when small multiple, every measure will be its own chart. Optional 36.0
normalize Boolean Scale the position and size of data shape so that it’s proportional to its percentage of its category. Optional 36.0
splitAxis Boolean When true, each measure is projected on one axis; otherwise, all measures share the same axis. Optional 36.0
sqrt Boolean Value indicating horizontal/vertical axis to be sqrt scale. Optional 36.0
totals Boolean Value indicating whether to display totals in the table or not. Optional 36.0
trellis Boolean When true, the last group will be treated as a trellis dimension. Every distinct value of the dimension will be a chart. Optional 36.0
GridLayoutInputRepresentation
Property Name Type Description Required or Optional Available Version
maxWidth Integer The maximum width that the dashboard will flex to. Optional 38.0
name String Name of this layout. Required 36.0
numColumns Integer The number of columns for a customizable dashboard grid layout. Optional 38.0
pages Grid​Layout​Page​Input​Representation[] List of pages of widgets within the layout. Optional 36.0
rowHeight Connect​Wave​Row​Height​Enum Row Height of a grid layout cell (Fine or Normal). 39.0
selectors String[] List of selectors this layout applies to. Optional 36.0
style Grid​Layout​Style​Input​Representation Styling for the layout. Optional 37.0
version Double Version of this layout. Required 36.0
widgetStyle Grid​Layout​Widget​Style​Input​Representation Default styling for widgets within the layout. Optional 36.0 - 37.0
GridLayoutPageInputRepresentation
Property Name Type Description Required or Optional Available Version
widgets Grid​Layout​Widget​Input​Representation[] List of widgets within the page. Required 36.0
GridLayoutWidgetInputRepresentation
Property Name Type Description Required or Optional Available Version
background​Image String Background image for the widget. Optional 36.0
colspan Integer Number of grid layout columns this widget spans. Required 36.0
column Integer Column where this widget is located. Required 36.0
name String Name of the widget. Required 36.0
row Integer Row where this widget is located. Required 36.0
rowspan Integer Number of grid layout rows this widget spans. Required 36.0
widgetStyle Grid​Layout​Widget​Style​Input​Representation Style of the widget. Required 36.0
GridLayoutWidgetStyleInputRepresentation
Property Name Type Description Required or Optional Available Version
background​Color String Background color for the widget. Is a 6 character hex string. For example: #012345. Required 36.0
border​Color String Color of the widget's border. Is a 6 character hex string. For example: #012345. Required 36.0
border​Edges Connect​Wave​Border​Edge​Type​Enum[] List of edges of the border to be drawn (All, Bottom, Left, Right, or Top). Required 36.0
border​Radius Integer Border radius of the widget. Optional 36.0
border​Width Integer Width of the widget's border. Required 36.0
bottom​Padding Integer Amount of padding on the bottom of the widget when rendered on mobile clients. Optional 36.0
left​Padding Integer Amount of padding on the left of the widget when rendered on mobile clients. Optional 36.0
right​Padding Integer Amount of padding on the right of the widget when rendered on mobile clients. Optional 36.0
top​Padding Integer Amount of padding on the top of the widget when rendered on mobile clients. Optional 36.0
LayoutInputRepresentation
Property Name Type Description Required or Optional Available Version
device Connect​Wave​Layout​Device​Type​Enum The device rendering this dashboard (Applewatch, Default, External, Ipad, Iphone). Optional 36.0
orientation Connect​Wave​Layout​Orientation​Type​Enum The layout orientation of this dashboard (Landscape or Portrait). Optional 36.0
pages Layout​Page​Input​Representation[] List of Layout​Page​Input​Representation objects available for the dashboard. Optional 36.0
version Double The version of the layout representation for the dashboard. Optional 36.0
LayoutPageInputRepresentation
Property Name Type Description Required or Optional Available Version
rows String[] Get the rows associated with a layout page. Optional 36.0
DashboardWidgetInputRepresentation
BoxWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
background​Color String The background color to be used for the box widget. Optional 36.0
border​Color String The border color to be used for the box widget. Optional 36.0
image​Url String The DocumentId of the image to be used for the box widget. Optional 36.0
stretch Boolean Value indicating whether to stretch the box widget or not. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
CompareTableWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
explore​Link Boolean Value indicating whether to display exploreLink or not. Optional 36.0
max​Column​Width Integer Maximum width of the header column. Optional 36.0
min​Column​Width Integer Minimum width of the header column. Optional 36.0
step String Step name tied to this widget. Optional 36.0
totals Boolean Value indicating whether the totals column is displayed or not. Optional 36.0
selectMode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
ContainerWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
alignmentX Connect​Wave​Horizontal​Alignment​Enum Horizontal alignment of the image (Left, Center, Right). 37.0
alignmentY Connect​Wave​Vertical​Alignment​Enum Vertical alignment (Bottom, Center, Top). 37.0
contained​Widgets String[] List of widgets (by name) contained within this widget. Optional 36.0-37.0
documentId String Document ID of the image. 37.0
fit Connect​Wave​Image​Fit​Type​Enum The image fit (FitHeight, FitWidth, Original, Stretch, Tile). 37.0
image Asset​Reference​Input​Representation Image representation containing the name and namespace. Small, 39.0 39.0
image​Url String The URI of the image to be used for the container widget. Optional 36.0-36.0
stretch​Image Boolean Value indicating whether to stretch the container widget background image. Optional 36.0-36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
DateSelectorWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
calendar​Type​Switching​Allowed Boolean Indicates whether widget can switch calendar types. 39.0
default​Absolute​Mode Boolean Indicates default date mode. 39.0
default​Fiscal​Mode Boolean Indicates default calendar type. 39.0
expanded Boolean Value indicating whether the date selector is expanded or not. Optional 36.0
instant Boolean Value indicating whether the list selector is instant or not. Optional 36.0
mode​Switching​Allowed Boolean Indicates whether widget can switch between two date modes. 39.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
step String The step name tied to this widget. Optional 36.0
title String The title of the list selector widget. Optional 36.0
GlobalFiltersWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
step String Step name tied to this widget. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
ImageWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
alignmentX Connect​Wave​Horizontal​Alignment​Enum Horizontal alignment of the image (Left, Center, Right). 37.0
alignmentY Connect​Wave​Vertical​Alignment​Enum Vertical alignment (Bottom, Center, Top). 37.0
documentId String Document ID of the image 37.0
fit Connect​Wave​Image​Fit​Type​Enum The image fit (FitHeight, FitWidth, Original, Stretch, Tile). 37.0
image Asset​Reference​Input​Representation Image representation containing the name and namespace 39.0
LinkWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
destination String The destination of this link. Optional 36.0
destinationLink Asset​Reference​Input​Representation The destination of this link, reference to Dashboard, Lens or Step.
destination​Type Connect​Wave​Link​Widget​Dest​Type​Enum Type of the asset this link refers to (Dashboard, Explore, Lens, or Url). Required 36.0
font​Size Integer The font size to be used for this link widget. Optional 36.0
include​State Boolean Whether or not include state. Optional 36.0
text String Value of the text. Optional 36.0
text​Alignment Connect​Wave​Horizontal​Alignment​Enum The text alignment for this widget (Center, Left, or Right). 39.0
text​Color String The color to be used for the text of this link widget. Optional 36.0
visualization​Type String The type of the visualization (Calendar​Heat​Map, Combo, Comparison​Table, Heat​Map, Horizontal​Bar, Horizontal​Dot, Matrix, Parallel​Coordinates, Pie, Pivot​Table, Scatter, Stack​Waterfall, Stacked​Horizontal​Bar, Stacked​Horizontal​Bar, Time, Values​Table, Vertical​Bar, Vertical​Dot, or Waterfall). Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
ListSelectorWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
compact Boolean Value indicating whether the list selector is compact or not. Optional 36.0
displayTemplate String Display template for widget level projection. 39.0
expanded Boolean Value indicating whether the list selector is expanded or not. Optional 36.0
explore​Link Boolean Value indicating whether the list selector has ‘explore’ link or not. Optional 36.0
instant Boolean Value indicating whether the list selector is instant or not. Optional 36.0
measure​Field String The measure field this widget is applied on. Optional 36.0
step String The step name tied to this widget. Optional 36.0
title String The title of the list selector widget. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
NumberWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
compact Boolean Whether or not widget is compact. Optional 36.0
explore​Link Boolean Whether or not widget has ‘explore’ link. Optional 36.0
font​Size Object Font size of the text. Optional 36.0
measure​Field String The measure field this number is calculated upon. Optional 36.0
number​Color String Color of the number inside this widget. Optional 36.0
numberSize Object Size of the number. Optional 36.0
step String The step name tied to this widget. Optional 36.0
text​Alignment Connect​Wave​Horizontal​Alignment​Enum Alignment of the text (Center, Left, or Right). Optional 36.0
text​Color String Color of the text inside this widget. Optional 36.0
title String The title of the widget. Optional 36.0
title​Color String Color of the title inside this widget. Optional 36.0
title​Size Object Size of the title text. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
PillBoxWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
compact Boolean Value indicating whether the list selector is compact or not. Optional 36.0
displayTemplate String Display template for widget level projection. 39.0
explore​Link Boolean The explore link used to create this widget. Optional 36.0
measure​Field String Measure field this widget is constructed upon. Optional 36.0
step String The step name tied to this widget. Optional 36.0
title String The title of this widget. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
RangeSelectorWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
instant Boolean Value indicating whether the list selector is instant or not. Optional 36.0
step String The step name tied to this widget. Optional 36.0
title String The title of the list selector widget. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
TableWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
custom​Bulk​Actions Custom​Bulk​Action​Input​Representation Custom bulk actions for this widget. 39.0
exploreLink Boolean Value indicating whether to display exploreLink or not. 38.0
fixed​Column​Width Integer Fixed column width for this table widget 40.0
max​Column​Width Integer Maximum column width for this table widget 40.0
min​Column​Width Integer Minimum column width for this table widget 40.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). 36.0
pivoted Boolean Value indicating whether to display table as pivot or not 39.0
step String Step name tied to this widget. 38.0
totals Boolean Value indicating whether to display totals row or not 40.0
TextWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
font​Size Object The font size of the text. Optional 36.0
text String Value of the text inside this widget. Optional 36.0
text​Alignment Connect​Wave​Horizontal​AlignmentEnum Alignment of the text (Left, Center, or Right). Optional 36.0
text​Color String The color of the text. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
UrlWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
type Connect​Wave​Url​Widget​Type Url widget type enum (YouTube). Optional 36.0
url String Connect URI for the widget. Optional 36.0
video​Size String Size of the video at which this url points. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
ValuesTableWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
explore​Link Boolean Value indicating whether the explore link is shown or not. Optional 36.0
hide​Header​Column Boolean Boolean value indicating whether to hide or show the header column for this widget. Optional 36.0
max​Column​Width Integer Maximum width of the header column. Optional 36.0
min​Column​Width Integer Minimum width of the header column. Optional 36.0
step String The step name tied to this widget. Optional 36.0
totals Boolean Value indicating whether the totals column is displayed or not. Optional 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
WidgetPositionInputRepresentation
Property Name Type Description Required or Optional Available Version
h String Height of the widget. Optional 36.0
w String Width of the widget. Optional 36.0
x Integer X index of widget. Optional for PATCH, required for POST 36.0
y Integer Y index of widget. Optional for PATCH, required for POST 36.0
zIndex Integer Z index of widget. Optional 36.0
CustomBulkActionInputRepresentation
Property Name Type Description Required or Optional Available Version
label String Label for the custom action 39.0
visualforce Asset​Reference​Input​Representation Visualforce page to invoke for the custom action 39.0
CustomBulkActionRepresentation
Property Name Type Description Filter Group and Version Available Version
label String Label for the custom action Small, 39.0 39.0
visualforce Asset​Reference​Representation Visualforce page to invoke for the custom action. Small, 39.0 39.0