Wave REST API Developer Guide

Working with the Wave REST API
Wave REST API Reference
Wave REST API Resources Overview
Wave Resource
Query Resource
Datasets List Resource
Dataset Resource
Versions List Resource
Version Resource
File Resource
XMD List Resource
XMD Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Dashboards List Resource
Dashboard Resource
Dependencies Resource
Features Configuration Resource
Folders List Resource
Folder Resource
Templates List Resource
Templates Resource
Templates Configuration Resource
PDF

Newer Version Available

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

Dashboard Resource

Returns or updates the Wave Analytics dashboard with the specified ID.
Resource URL
1/wave/dashboards/<dashboard ID>
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 sharing URL for the dashboard. Small, 36.0 36.0
createdBy Wave User 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 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
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 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
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
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
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
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 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, 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
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
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
type String The type of the dashboard step. Values are:
  • Aggregate
  • Grain
  • Multi
  • Static
 Small, 36.0 36.0
useGlobal Boolean Indicates whether the step is faceted to the global step. Small, 36.0 36.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
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, 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
  • DateSelector
  • GlobalFilters
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • 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
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, 36.0 36.0
borderColor String The border color of the widget. Small, 36.0 36.0
compact Boolean Indicates whether the widget is compact. Small, 36.0 36.0
destination String The destination of the link. Small, 36.0 36.0
destinationType String The type of asset the link refers to. Values are:
  • Dashboard
  • Explore
  • Lens
  • Url
 Small, 36.0 36.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 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, 36.0 36.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
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
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
selectModeOverride 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
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 Wave 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: 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, 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 DashboardStateInputRepresentation The state of the dashboard. Optional for PATCH, required for POST 36.0
folder AssetReferenceInputRepresentation 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
name String The name of the asset. Optional 36.0
DashboardStateInputRepresentation
Property Name Type Description Required or Optional Available Version
gridLayoutStyle GridLayoutStyleInputRepresentation Overall styling for the GridLayouts used as part of this dashboard. If present, 'layouts' must not be set. Optional 36.0
gridLayouts List (GridLayoutInputRepresentation[]) List of GridLayoutInputRepresentation’s used as part of this dashboard. If present, 'layouts' must not be set. Optional 36.0
layouts List (LayoutInputRepresentation[]) List of LayoutInputRepresentation’s used as part of this dashboard. Optional 36.0
steps Map (key of type String) (MultiQueryStepInputRepresentation, GrainQueryStepInputRepresentation, AggregateQueryStepInputRepresentation, or StaticStepInputRepresentation) Map of all the steps used to create this dashboard keyed with their names. Optional 36.0
widgets Map (key of type String) (DashboardWidgetInputRepresentation) Map of all the DashboardWidgetInput​Representation’s used to create this dashboard keyed with their names. Optional 36.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
GridLayoutStyleInputRepresentation
Property Name Type Description Required or Optional Available Version
widgetStyle GridLayoutWidgetStyleInputRepresentation Default styling for widgets across all layouts. Optional 36.0
MultiQueryStepInputRepresentation
Property Name Type Description Required or Optional Available Version
columns ColumnInputRepresentation[] The list of columns of the comparison table. Optional 36.0
globalQuery QueryInputRepresentation Query override for all columns. Optional 36.0
datasets AssetReferenceInputRepresentation[] The List of all the dataset alias 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
selectMode ConnectWaveSelectModeEnum 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, Grain, Multi, or Static). 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 QueryInputRepresentation SAQL Query to run for this step. Optional for PATCH, required for POST 36.0
datasets AssetReferenceInputRepresentation[] 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
selectMode ConnectWaveSelectModeEnum 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, Grain, Multi, or Static). 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 QueryInputRepresentation SAQL used to create this Step Optional for PATCH, required for POST 36.0
datasets AssetReferenceInputRepresentation[] The List of all the dataset alias 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
selectMode ConnectWaveSelectModeEnum 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, Grain, Multi, or Static). 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
StaticStepInputRepresentation
Property Name Type Description Required or Optional Available Version
dimensions String[] List of dimensions of the static step. Optional 36.0
values String[] List of values of this step. Optional 36.0
datasets AssetReferenceInputRepresentation[] The List of all the dataset alias 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
selectMode ConnectWaveSelectModeEnum 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, Grain, Multi, or Static). 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
ColumnInputRepresentation
Property Name Type Description Required or Optional Available Version
format ConnectWaveColumnFormatEnum 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 QueryInputRepresentation 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 ConnectWaveColumnSortEnum 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
visualization​Type Connect​Wave​Visualization​Type​Enum The type of the visualization for the step (CalendarHeatMap, Combo, ComparisonTable, HeatMap, HorizontalBar, HorizontalDot, Matrix, ParallelCoordinates, Pie, PivotTable, Scatter, StackWaterfall, StackedHorizontalBar, StackedHorizontalBar, Time, ValuesTable, VerticalBar, VerticalDot, 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
name String Name of this layout. Required 36.0
pages GridLayoutPageInputRepresentation[] List of pages of widgets within the layout. Optional 36.0
selectors String[] List of selectors this layout applies to. Optional 36.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
GridLayoutPageInputRepresentation
Property Name Type Description Required or Optional Available Version
widgets GridLayoutWidgetInputRepresentation[] 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 GridLayoutWidgetStyleInputRepresentation 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
borderColor String Color of the widget's border. Is a 6 character hex string. For example: #012345. Required 36.0
borderEdges ConnectWaveBorderEdgeTypeEnum[] List of edges of the border to be drawn (All, Bottom, Left, Right, or Top). Required 36.0
borderRadius Integer Border radius of the widget. Optional 36.0
borderWidth Integer Width of the widget's border. Required 36.0
bottomPadding Integer Amount of padding on the bottom of the widget when rendered on mobile clients. Optional 36.0
leftPadding Integer Amount of padding on the left of the widget when rendered on mobile clients. Optional 36.0
rightPadding Integer Amount of padding on the right of the widget when rendered on mobile clients. Optional 36.0
topPadding 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 ConnectWaveLayoutDeviceTypeEnum The device rendering this dashboard (Applewatch, Default, External, Ipad, Iphone). Optional 36.0
orientation ConnectWaveLayoutOrientationTypeEnum The layout orientation of this dashboard (Landscape or Portrait). Optional 36.0
pages LayoutPageInputRepresentation[] List of LayoutPageInputRepresentation’s 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
Property Name Type Description Required or Optional Available Version
parameters BoxWidgetParametersInputRepresentation, ChartWidgetParametersInputRepresentation, CompareTableWidgetParametersInputRepresentation, ContainerWidgetParametersInputRepresentation, DateSelectorWidgetParametersInputRepresentation, GlobalFiltersWidgetParametersInputRepresentation, LinkWidgetParametersInputRepresentation, ListSelectorWidgetParametersInputRepresentation, NumberWidgetParametersInputRepresentation, PillBoxWidgetParametersInputRepresentation, RangeSelectorWidgetParametersInputRepresentation, TextWidgetParametersInputRepresentation, UrlWidgetParametersInputRepresentation, or ValuesTableWidgetParametersInputRepresentation Valid widget parameters based on its type. Optional for PATCH, required for POST 36.0
position WidgetPositionInputRepresentation Position information of the widget on a dashboard. Optional for PATCH, required for POST 36.0
type ConnectWaveWidgetTypeEnum The type of the widget (Box, Chart, CompareTable, Container, DateSelector, GlobalFilters, Link, ListSelector, Number, PillBox, RangeSelector, Text, Url, or ValuesTable). Optional for PATCH, required for POST 36.0
BoxWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
backgroundColor String The background color to be used for the box widget. Optional 36.0
borderColor String The border color to be used for the box widget. Optional 36.0
imageUrl String The URI 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
selectModeOverride ConnectWaveSelectModeEnum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
ChartWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
computeTotal Boolean If true, then last column is a computed value, which is sum of all the previous values Optional 36.0
dualAxis Boolean If true, then show dual Axis Optional 36.0
exploreLink Boolean Value indicating whether exploreLink is on or not. Optional 36.0
fit Boolean If true, fits domain of axis according to data domain; if not fit, zero is always included in the axis domain. Optional 36.0
hideHeaderColumn Boolean Value indicating whether to hide legend. Optional 36.0
legend Boolean Value indicates whether to show legend or not. Optional 36.0
legendHideHeader Boolean Value indicating whether to hide legend header. 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 If true, bar width is dynamic and barText and header label will not be displayed. 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
negativeColor String Color of negative valued columns Optional 36.0
normalize Boolean Scales the position and size of data shape so that it's proportional to its percentage of its category. Optional 36.0
positiveColor String Color of positive valued columns Optional 36.0
showValues Boolean If true, then columns will show the data value 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 or vertical axis to be sqrt scale. Optional 36.0
startColor String Color of the first column Optional 36.0
step String The step name tied to this widget. Optional 36.0
totalColor String Color of total column Optional 36.0
totals Boolean Value indicating whether to use totals. 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
visualization​Type Connect​Wave​Visualization​Type​Enum Chart type of this widget (CalendarHeatMap, Combo, ComparisonTable, HeatMap, HorizontalBar, HorizontalDot, Matrix, ParallelCoordinates, Pie, PivotTable, Scatter, StackWaterfall, StackedHorizontalBar, StackedVerticalBar, Time, ValuesTable, VerticalBar, VerticalDot, or Waterfall) Optional 36.0
selectMode​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
exploreLink Boolean Value indicating whether to display exploreLink or not. Optional 36.0
maxColumnWidth Integer Maximum width of the header column. Optional 36.0
minColumnWidth 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
containedWidgets String[] List of widgets (by name) contained within this widget. Optional 36.0
imageUrl String The URI of the image to be used for the container widget. Optional 36.0
stretchImage Boolean Value indicating whether to stretch the container widget background image. Optional 36.0
selectModeOverride ConnectWaveSelectModeEnum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
DateSelectorWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
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
step String The step name tied to this widget. Optional 36.0
title String The title of the list selector widget. Optional 36.0
selectModeOverride ConnectWaveSelectModeEnum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
GlobalFiltersWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
step String Step name tied to this widget. Optional 36.0
selectModeOverride ConnectWaveSelectModeEnum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
LinkWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
destination String The destination of this link. Optional 36.0
destinationType Connect​Wave​Link​Widget​Dest​Type​Enum Type of the asset this link refers to (Dashboard, Explore, Lens, or Url). Required 36.0
fontSize Integer The font size to be used for this link widget. Optional 36.0
includeState Boolean Whether or not include state. Optional 36.0
text String Value of the text. Optional 36.0
textColor String The color to be used for the text of this link widget. Optional 36.0
visualizationType Connect​Wave​Visualization���Type​Enum Chart type this link refers to (CalendarHeatMap, Combo, ComparisonTable, HeatMap, HorizontalBar, HorizontalDot, Matrix, ParallelCoordinates, Pie, PivotTable, Scatter, StackWaterfall, StackedHorizontalBar, StackedVerticalBar, Time, ValuesTable, VerticalBar, VerticalDot, or Waterfall) Optional 36.0
selectModeOverride ConnectWaveSelectModeEnum 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
expanded Boolean Value indicating whether the list selector is expanded or not. Optional 36.0
exploreLink 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
measureField 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
selectModeOverride 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
exploreLink Boolean Whether or not widget has ‘explore’ link. Optional 36.0
fontSize Integer Font size of the text. Optional 36.0
measureField String The measure field this number is calculated upon. Optional 36.0
step String The step name tied to this widget. Optional 36.0
textAlignment Connect​Wave​Alignment​Enum Alignment of the text (Center, Left, or Right). Optional 36.0
textColor String Color of the text inside this widget. Optional 36.0
title String The title of the widget. Optional 36.0
selectModeOverride 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
exploreLink Boolean The explore link used to create this widget. Optional 36.0
measureField 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
selectModeOverride 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
selectModeOverride Connect​Wave​Select​Mode​Enum Select Mode Override (Multi, MultiRequired, None, Single, or SingleRequired). Optional 36.0
TextWidgetParametersInputRepresentation
Property Name Type Description Required or Optional Available Version
fontSize Integer The font size of the text. Optional 36.0
text String Value of the text inside this widget. Optional 36.0
textAlignment ConnectWaveAlignmentEnum Alignment of the text (Left, Center, or Right). Optional 36.0
textColor String The color of the text. Optional 36.0
selectModeOverride 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
videoSize String Size of the video at which this url points. Optional 36.0
selectModeOverride 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
exploreLink Boolean Value indicating whether the explore link is shown or not. Optional 36.0
hideHeaderColumn Boolean Boolean value indicating whether to hide or show the header column for this widget. Optional 36.0
maxColumnWidth Integer Maximum width of the header column. Optional 36.0
minColumnWidth 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
selectModeOverride 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