Tableau CRM REST API Developer Guide

Working with the Tableau CRM REST API
Tableau CRM REST API Reference
Additional Tableau CRM REST API Resources
Tableau CRM REST API Appendix
Dashboard State Representation
Dashboard State Input Representation
Recipe Node Representation
Recipe Node Input Representation
PDF

Newer Version Available

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

Dashboard State Representation

This page contains the reference for the DashboardStateRepresentation resource and all the representations that make up the dashboard state for API responses. The following representation details are not REST API endpoints on their own, but describe object representations used in REST API response bodies.
Dashboard​State​Representation
Property Name Type Description Filter Group and Version Available Version
data​Source​Links Dashboard​Data​Source​Link​Representation[] The list of all datasource links in a dashboard. Small, 39.0 39.0
filters Filter​Item​Representation[] The list of datasource filters applied in this dashboard. Small, 41.0 41.0
gridLayouts Grid​Layout​Representation[] The 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 LayoutRepresentation[] DEPRECATED The list of layouts for this dashboard. The gridLayouts parameter replaces this list. Small, 36.0 36.0
steps Map<String, Step​Representation> The map of steps used to create this dashboard. The key string is the step name. Valid step types are: 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​Representation The map of widgets used to create this dashboard. The key string is the widget name. Small, 36.0 36.0
Dashboard​Data​Source​Field​Representation
Property Name Type Description Filter Group and Version Available Version
data​Source​Name 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
data​Source​Type Connect​Wave​Data​Source​Type​Enum The type of datasource. Valid values are:
  • Apex
  • Dataset
  • Report​Type
  • Saql
  • Sobject
  • Static
 Small, 39.0 39.0
fieldName String The name of field in the datasource Small, 39.0 39.0
Filter​Item​Representation
Property Name Type Description Filter Group and Version Available Version
dataset Asset​Reference​Representation The datasource to apply the filter to. Small, 41.0 41.0
fields String[] The list of fields in filter. Small, 41.0 41.0
hidden Boolean Indicates whether the filter is hidden in view mode (true) (true) or not (false) (false). Small, 41.0 41.0
label String The label of the filter. Small, 41.0 41.0
locked Boolean Indicates whether the filter is locked (true) (true) or not (false) (false). Small, 41.0 41.0
operator String The operator for the filter. Small, 41.0 41.0
value String The value for the filter. Small, 41.0 41.0
Grid​Layout​Widget​Style​Representation
Property Name Type Description Filter Group and Version Available Version
background​Color String The background color for the widget. This is a 6 character hex string. For example: #012345. Small, 36.0 36.0
border​Color String The color of the widget's border. This is a 6 character hex string. For example: #012345. Small, 36.0 36.0
border​Edges Connect​Wave​Border​Edge​Type​Enum[] The edges of the border to be drawn. Valid values are:
  • All
  • Bottom
  • Left
  • Right
  • Top
 Small, 36.0 36.0
border​Radius Object The border radius of the widget. Small, 36.0 36.0
border​Width Object The width of the widget's border. Small, 36.0 36.0
bottom​Padding Integer The amount of padding on the bottom of the widget when rendered on mobile clients. Small, 36.0 36.0
left​Padding Integer The amount of padding on the left of the widget when rendered on mobile clients. Small, 36.0 36.0
right​Padding Integer The amount of padding on the right of the widget when rendered on mobile clients. Small, 36.0 36.0
top​Padding Integer The amount of padding on the top of the widget when rendered on mobile clients. Small, 36.0 36.0
Grid​Layout​Representation
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 can flex to. Small, 38.0 38.0
name String The 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[] The 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. Valid values are:
  • Fine
  • Normal
 Small, 39.0 39.0
selectors String[] The list of selectors this layout applies to. Small, 36.0 36.0
style Grid​Layout​Style​Representation The 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 DEPRECATED The default styling for widgets within the layout. Small, 36.0 36.0—37.0
Grid​Layout​Page​Representation
Property Name Type Description Filter Group and Version Available Version
label String The display label for the page. Small, 41.0 41.0
name String The unique id for a page within a layout. Small, 41.0 41.0
navigation​Hidden Boolean Indicates whether the page is hidden in the navigation widget (true) or not (false). Small, 44.0 44.0
widgets Grid​Layout​Widget​Representation[] Widgets within the page. Small, 36.0 36.0
Grid​Layout​Widget​Representation
Property Name Type Description Filter Group and Version Available Version
background​Image String The background image for the widget. Small, 36.0 36.0
colspan Integer The number of grid layout columns this widget spans. Small, 36.0 36.0
column Integer The column where this widget is located. Small, 36.0 36.0
name String The name of the widget. Small, 36.0 36.0
row Integer The row where this widget is located. Small, 36.0 36.0
rowspan Integer The number of grid layout rows this widget spans. Small, 36.0 36.0
widgetStyle Grid​Layout​Widget​Style​Representation The style of the widget. Small, 36.0 36.0
Grid​Layout​Style​Representation

GridLayoutStyleRepresentation inherits properties from the abstract ImageParametersRepresentation. These base properties appear in GridLayoutStyleRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
background​Color String The background color for the layout. Small, 36.0 36.0
cell​Spacing​X Integer The horizontal spacing between grid cells. Small, 36.0 36.0
cell​Spacing​Y Integer The vertical spacing between grid cells. Small, 36.0 36.0
gutter​Color String The gutter color for the layout. Small, 36.0 36.0
Image​Parameters​Representation

ImageParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in ImageParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
alignmentX Connect​Wave​Horizontal​Alignment​Enum The alignment of the text. Values are:
  • Center
  • Left
  • Right
 Small, 37.0 37.0
alignmentY Connect​Wave​Vertical​Alignment​Enum The vertical alignment types. Valid values are:
  • Bottom
  • Center
  • Top
 Small, 37.0 37.0
documentId String The document id of the image. Small, 37.0 37.0
fit Connect​Wave​Image​Fit​Type​Enum The image alignment types. Valid values are:
  • FitHeight
  • FitWidth
  • Original
  • Stretch
  • Tile
 Small, 37.0 37.0
image Asset​Reference​Representation The image representation containing the name and the namespace. Small, v39.0 39.0
Layout​Representation
Property Name Type Description Filter Group and Version Available Version
device Connect​Wave​Layout​Device​Type​Enum The device rendering this dashboard. Valid values are:
  • Applewatch
  • Default
  • External
  • Ipad
  • Iphone
 Small, 36.0 36.0
orientation Connect​Wave​Layout​Orientation​Type​Enum The layout orientation of this dashboard. Valid values are:
  • Landscape
  • Portrait
 Small, 36.0 36.0
pages Layout​Page​Representation[] 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​Representation
Property Name Type Description Filter Group and Version Available Version
rows String[] The rows associated with a layout page. Small, 36.0 36.0
Aggregate​Step​Representation

AggregateStepRepresentation inherits properties from the abstract QueryStepRepresentation. These base properties appear in AggregateStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
isFacet Boolean Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). Small, 36.0 36.0
Aggregate​Flex​Step​Representation

AggregateFlexStepRepresentation inherits properties from the abstract QueryStepRepresentation. These base properties appear in AggregateFlexStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
broadcast​Facet Boolean Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). Small, 41.0 41.0
connection​Name String The name of the connection used for steps powered by external data. Small, 48.0 48.0
receive​Facet​Source Receive​Facet​Source​Representation The receive facet configurations. Small, 41.0 41.0-47.0
sobject String The name of the sObject used for a SOQL query. Small, 47.0 47.0
Apex​Step​Representation

ApexStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in ApexStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
query Apex​Step​Query​Representation The queries to run for this step. Small, 41.0 41.0
Direct​Report​Step​Representation

DirectReportStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in DirectReportStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
query Direct​Report​Step​Query​Representation The query to run for this step. Small, 53.0 53.0
Grain​Step​Representation

GrainStepRepresentation inherits properties from the abstract QueryStepRepresentation. These base properties appear in GrainStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
isFacet Boolean Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). Small, 41.0 41.0
query Apex​Step​Query​Representation The queries to run for this step. Small, 41.0 41.0
Lens​Step​Representation

LensStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in LensStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
source Asset​Reference​Representation The lens source for this step. Small, 50.0 50.0
Multi​Query​Step​Representation

MultiQueryStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in MultiQueryStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
columns Column​Representation[] The list of 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
globalQuery Query​Representation[] The query override for all columns. Small, 41.0 41.0
isFacet Boolean Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). Small, 41.0 41.0
isGlobal Boolean Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). Small, 36.0 36.0
start String The start value for the step. Small, 36.0 36.0
useGlobal Boolean Indicates whether this step gets tied to the global step (true) or not (false). Small, 36.0 36.0
visualization​Parameters Step​Visualization​Parameters​Representation The parameters for the step visualization. Small, 36.0 36.0
Sql​Step​Representation

SqlStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in SqlStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
broadcast​Facet Boolean Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). Small, 51.0 51.0
connection​Name String The name of the connection for the step. Small, 51.0 51.0
query String The query for the step. Small, 51.0 51.0
receive​Facet​Source Receive​Facet​Source​Representation The receive facet configuration. Small, 52.0 52.0
start String The start value for the step. Small, 51.0 51.0
use​Global Boolean Indicates whether this step is tied to the global step (true) or not (false). Small, 53.0 53.0
visualization​Parameters Step​Visualization​Parameters​Representation The parameters for the step visualization. Small, 51.0 51.0
Saql​Step​Representation

SaqlStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in SaqlStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
broadcast​Facet Boolean Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). Small, 41.0 41.0
query String The SAQL query for the step. Small, 39.0 39.0
receive​Facet​Source Receive​Facet​Source​Representation The receive facet source configuration Required 48.0
start String The start value for the step. Small, 39.0 39.0
use​Global Boolean Indicates whether this step is faceted to the global step. Small, 39.0 39.0
visualization​Parameters Step​Visualization​Parameters​Representation The parameters for the step visualization. Small, 40.0 40.0
Soql​Step​Representation

SoqlStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in SoqlStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
is​Facet Boolean Indicates whether this step is faceted to other steps on the dashboard (true) or not (false). Small, 39.0 39.0
query String The query for the step. Small, 39.0 39.0
start String The start value for the step. Small, 39.0 39.0
use​Global Boolean Indicates whether this step gets tied to the global step (true) or not (false). Small, 39.0 39.0
Static​Step​Representation

StaticStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in StaticStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
datasets Asset​Reference​Representation[] The list of datasets used by this step. Small, 36.0 36.0
dimensions String[] A list of dimensions for the step. Small, 36.0 36.0
is​Facet Boolean Indicates whether this step is faceted to other steps on the dashboard (true) or not (false). Small, 36.0 36.0
is​Global Boolean Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). Small, 36.0 36.0
start String The start value for the step. Small, 36.0 36.0
useGlobal Boolean Indicates whether this step gets tied to the global step (true) or not (false). Small, 36.0 36.0
visualization​Parameters Step​Visualization​Parameters​Representation The parameters for the step visualization. Small, 36.0 36.0
Static​Flex​Step​Representation

StaticFlexStepRepresentation inherits properties from the abstract FlexMetadataStepRepresentation. These base properties appear in StaticFlexStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
broadcast​Facet Boolean Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). Small, 41.0 41.0
columns Static​Flex​Step​Column​Representation The metadata about the columns used in values. Small, 47.0 47.0
isGlobal Boolean Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). Small, 36.0 36.0
start String The start value for the step. Small, 39.0 39.0
useGlobal Boolean Indicates whether this step gets tied to the global step (true) or not (false). Small, 39.0 39.0
visualization​Parameters Step​Visualization​Parameters​Representation The parameters for the step visualization. Small, 40.0 40.0
Query​Step​Representation

QueryStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in QueryStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
datasets Asset​Reference​Representation[] The list of datasets used by this step. Small, 36.0 36.0
isGlobal Boolean Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). Small, 36.0 36.0
query Query​Representation The query to run for this step. Small, 36.0 36.0
start String The start value for the step. Small, 36.0 36.0
useGlobal Boolean Indicates whether this step gets tied to the global step (true) or not (false). Small, 36.0 36.0
visualization​Parameters Step​Visualization​Parameters​Representation The parameters for the step visualization. Small, 36.0 36.0
Flex​Metadata​Step​Representation

FlexMetadataStepRepresentation inherits properties from the abstract StepRepresentation. These base properties appear in FlexMetadataStepRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
groups Object The columns that are also groups. Small, 39.0 39.0
numbers Object The number columns. Small, 39.0 39.0
strings Object The string columns. Small, 39.0 39.0
Step​Representation
Property Name Type Description Filter Group and Version Available Version
label String The display label for the step. Small, 36.0 36.0
selectMode Connect​Wave​Select​Mode​Enum The select mode types. Valid values are:
  • Multi
  • MultiRequired
  • None
  • Single
  • SingleRequired
 Small, 36.0 36.0
type Connect​Wave​Dashboard​Step​Type​Enum The type of dashboard step. Valid values are:
  • Aggregate
  • Aggregate​Flex
  • Apex
  • Direct​Report
  • Discovery
  • Grain
  • Lens
  • Multi
  • Saql
  • Soql
  • Sql
  • Static
  • Static​Flex
  • Watchlist
 Small, 36.0 36.0
Apex​Step​Query​Representation
Property Name Type Description Filter Group and Version Available Version
body Object The body for the Apex request. Small, 41.0 41.0
path String The path to the Apex controller. Small, 41.0 41.0
Direct​Report​Step​Query​Representation
Property Name Type Description Filter Group and Version Available Version
metadata Object The metadata for the query. Small, 53.0 53.0
mode Direct​Report​Mode​Enum The query mode. Valid values are:
  • Aggregate
  • Details
  • Summary
 Small, 53.0 53.0
report​Id String The ID for the query report. Small, 53.0 53.0
Static​Flex​Step​Column​Representation
Property Name Type Description Filter Group and Version Available Version
aggregate​Function String The aggregate function for the column. Small, 47.0 47.0
dataset Asset​Reference​Representation The dataset used in the column. Small, 47.0 47.0
field String The aggregate field for the column. Small, 47.0 47.0
type Connect​Wave​Dashboard​Static​Step​Column​Type​Enum The column type. Valid values are
  • String
  • Number
  • Grouping
  • Aggregate
 Small, 47.0 47.0
Step​Visualization​Parameters​Representation
Property Name Type Description Filter Group and Version Available Version
options Lens​Visualization​Options​Representation The configuration options for different lens visualizations. Valid values are: 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. Valid values are:
  • Box
  • Chart
  • Compare​Table
  • Component
  • Container
  • Date​Selector
  • Filter​Panel
  • Global​Filters
  • Image
  • Inherit
  • Link
  • List​Selector
  • Navigation
  • Number
  • Pill​Box
  • Range​Selector
  • Repeater>
  • Table
  • Text
  • Url
  • Values​Table
 Small, 40.0 40.0
visualization​Type String The type of visualization. Valid 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
Receive​Facet​Source​Representation
Property Name Type Description Filter Group and Version Available Version
mode Connect​Wave​Dashboard​Step​Receive​Facet​Mode​Type​Enum The type of receive facet mode. Valid values are:
  • All
  • Exclude
  • Include
  • None
 Small, 48.0 48.0
steps String[] A list of steps that the current step receives or omits faceting from. Small, 48.0 48.0
Dashboard​Widget​Representation
Property Name Type Description Filter Group and Version Available Version
parameters Object The valid widget parameters based on the type of widget. Parameter types include: Small, 36.0 36.0
position Widget​Position​Representation The position information for the widget. Small, 36.0 36.0
type String The type of the widget. Valid values are:
  • Box
  • Chart
  • Compare​Table
  • Component
  • Container
  • Date​Selector
  • Filter​Panel
  • Global​Filters
  • Image
  • Inherit
  • Link
  • List​Selector
  • Navigation
  • Number
  • Pill​Box
  • Range​Selector
  • Repeater>
  • Table
  • Text
  • Url
  • Values​Table
 Small, 36.0 36.0
Box​Widget​Parameters​Representation

BoxWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in BoxWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

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
imageUrl String A 15-character or 18-character Salesforce document ID. Small, 36.0 36.0
stretch Boolean Indicates whether to stretch the widget. Small, 36.0 36.0
Compare​Table​Widget​Parameters​Representation

CompareTableWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in CompareTableWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
explore​Link Boolean Indicates whether exploreLink is on (true) or not (false). Small, 36.0 36.0
max​Column​Width Integer The maximum width of the header column. Small, 36.0 36.0
min​Column​Width Integer The minimum width of the header column. Small, 36.0 36.0
step String The step name tied to this widget. Small, 36.0 36.0
totals Boolean Indicates whether to use totals. Small, 36.0 36.0
Component​Widget​Parameters​Representation

ComponentWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in ComponentWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
attributes Object<String, Object> The map of this component's attribute values. Small, 51.0 51.0
page​Name String The default page of this widget. Small, 50.0 50.0
share​State Boolean Indicates whether this component widget shares state with the parent dashboard (true) or not (false). Small, 51.0 51.0
source Typed​Asset​Reference​Representation[] The component definition for this component widget. Small, 46.0 46.0
step String The attached step for this component widget. Small, 51.0 51.0
Container​Widget​Parameters​Representation

ContainerWidgetParametersRepresentation inherits properties from the abstract ImageParametersRepresentation.

Date​Selector​Widget​Parameters​Representation

DateSelectorWidgetParametersRepresentation inherits properties from the abstract SelectorWidgetParametersRepresentation. These base properties appear in DateSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
absolute​Mode​Enabled Boolean Indicates whether the widget has absolute mode enabled (true) or not (false). Small, 43.0 43.0
calendar​Type​Switching​Allowed Boolean Indicates whether widget can switch calendar types (true) or not (false). Small, 39.0 39.0
default​Fiscal​Mode Boolean Indicates whether there is a default calendar type (true) or not (false). Small, 39.0 39.0
displayMode Connect​Wave​Selector​Display​Mode​Enum The display mode for dashboard selector widgets. Valid values are:
  • Combo
  • Filter
 Small, 46.0 46.0
expanded Boolean Indicates whether the selector widget is expanded (true) or not (false). Small, 36.0 36.0
presets​Enabled Boolean Indicates whether the widget has presets enabled (true) or not (false). Small, 43.0 43.0
relative​Mode​Enabled Boolean Indicates whether the widget has relative mode enabled (true) or not (false). Small, 43.0 43.0
Filter​Panel​Widget​Parameters​Representation

FilterPanelWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in FilterPanelWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
filterItemOptions Filter​Item​Options​Representation The filter items options. Small, 41.0 41.0
filters Filter​Item​Reference​Representation The list of filter references mapped to the filters section. Small, 46.0 46.0
items​Per​Row Integer The number of filter items per row in a filter panel. Small, 41.0 41.0
show​All​Filters Integer Indicates whether to display all the filters or just one filter. Small, 46.0 46.0
showIn​View​Mode Boolean Indicates whether the filter panel is displayed in view mode (true) or not (false). Small, 41.0 41.0
title Filter​Panel​Title​Representation The filter panel title text. Small, 41.0 41.0
Global​Filters​Widget​Parameters​Representation

GlobalFiltersWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in GlobalFiltersWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
step String The step name tied to this widget. Small, 36.0 36.0
Image​Widget​Parameters​Representation

ImageWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in ImageWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
tooltip String The tooltip for the image widget. Small, 42.0 42.0
Inherit​Widget​Parameters​Representation

InheritWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in InheritWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
step String The step name for this widget. Small, 50.0 50.0
Link​Widget​Parameters​Representation

LinkWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in LinkWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
destination String The destination of the link. Small, 36.0 36.0
destination​Link Link​Destination​Representation The destination reference of this link. Valid values are: Small, 39.0 39.0
destination​Type Connect​Wave​Link​Widget​Dest​Type​Enum The type of asset the link refers to. Values are:
  • Dashboard
  • Explore
  • Lens
  • Page
  • Url
 Small, 36.0 36.0
fontSize Integer The font size for the widget. Small, 36.0 36.0
include​State Boolean Indicates whether to include the state. Small, 36.0 36.0
text String The text value for the link. Small, 36.0 36.0
text​Alignment Connect​Wave​Horizontal​Alignment​Enum The alignment of the text. Values are:
  • Center
  • Left
  • Right
 Small, 36.0 36.0
text​Color String The text color for the widget. Small, 36.0 36.0
visualizationType String The visualization type used for this widget. Valid 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
List​Selector​Widget​Parameters​Representation

ListSelectorWidgetParametersRepresentation inherits properties from the abstract SelectorWidgetParametersRepresentation. These base properties appear in ListSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
compact Boolean Indicates whether the list selector is compact (true) or not (false). Small, 36.0 36.0
display​Mode Connect​Wave​Selector​Display​Mode​Enum The display mode for dashboard selector widgets. Valid values are:
  • Combo
  • Filter
 Small, 46.0 46.0
display​Template String Display template for widget level projection. Small, 39.0 39.0
expanded Boolean Indicates whether the list selector is expanded (true) or not (false). Small, 36.0 36.0
explore​Link Boolean Indicates whether the list selector has an explore link (true) or not (false). Small, 36.0 36.0
measure​Field String The measure field associated with this widget. Small, 36.0 36.0

NavigationWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in NavigationWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
font​Size Integer The value indicating the default font size for all the text in the navigation. Small, 43.0 43.0
selected​Tab Tab​Style​Parameters​Representation The selected tab styles for the widget. Small, 43.0 43.0
tab​Count Integer The number of tabs to show in the widget. Small, 43.0 43.0
text​Color String The color value for the default tab text in the widget. Small, 43.0 43.0
Number​Widget​Parameters​Representation

NumberWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in NumberWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
compact Boolean Indicates whether the widget is compact (true) or not (false). Small, 36.0 36.0
destination​Link Link​Destination​Representation The destination reference of the link. Small, 47.0 47.0
explore​Link Boolean Indicates whether the widget has an explore link (true) or not (false). Small, 36.0 36.0
font​Size String The font size of the widget text. Small, 36.0 36.0
measure​Field String The measure field associated with the widget. Small, 36.0 36.0
no​Results​Label String The text to display when no results are found. Small, 45.0 45.0
number​Color String The color of the number inside the widget. Small, 36.0 36.0
number​Size Object The size of the number inside the widget. Small, 36.0 36.0
step String The step name associated to the widget. Small, 36.0 36.0
text​Alignment Connect​Wave​Horizontal​Alignment​Enum The alignment of the text. Values are:
  • Center
  • Left
  • Right
 Small, 36.0 36.0
text​Color String The color of the text inside the widget. Small, 36.0 36.0
title String The title of the widget. Small, 36.0 36.0
title​Color String The title color of the widget. Small, 36.0 36.0
title​Size String The title size of the widget. Small, 36.0 36.0
tooltip Tooltip​Representation The tooltip for the widget. Small, 51.0 51.0
Pill​Box​Widget​Parameters​Representation

PillBoxWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in PillBoxWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
compact Boolean Indicates whether the widget is compact (true) or not (false). Small, 36.0 36.0
display​Template String The display template for widget level projection. Small, 39.0 39.0
explore​Link Boolean Indicates whether the widget has an explore link (true) or not (false). Small, 36.0 36.0
font​Size String The default font size for all items in the widget. Small, 45.0 45.0
measure​Field String The measure field associated with the widget. Small, 36.0 36.0
selected​Tab Tab​Style​Parameters​Representation The selected tab styles for the widget. Small, 45.0 45.0
step String The step name associated to the widget. Small, 36.0 36.0
text​Color String The color of the default text in the widget. Small, 36.0 36.0
title String The title of the widget. Small, 36.0 36.0
Range​Selector​Widget​Parameters​Representation

RangeSelectorWidgetParametersRepresentation inherits properties from the abstract SelectorWidgetParametersRepresentation. These base properties appear in RangeSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
display​Mode Connect​Wave​Selector​Display​Mode​Enum The display mode for dashboard selector widgets. Valid values are:
  • Combo
  • Filter
 Small, 46.0 46.0
Repeater​Widget​Parameters​Representation

RepeaterWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in RepeaterWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
card​Properties Repeater​Widget​Card​Properties​Representation The properties for a card for the widget. Small, 53.0 53.0
cell​Properties Map<String, Repeater​Widget​Cell​Properties​Representation> A map of repeater cell properties for the widget. Small, 53.0 53.0
items​Per​Row Integer The number of cards per row of the widget. Small, 53.0 53.0
step String The step name associated to the widget. Small, 53.0 53.0
Table​Widget​Parameters​Representation

TableWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in TableWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
border​Color String The outer border color for the widget. Small, 41.0 41.0
border​Width Integer The outer border width for the widget. Small, 41.0 41.0
cell Table​Widget​Cell​Parameters​Representation The cell properties for the widget. Small, 41.0 41.0
collapsible Boolean Indicates whether the table is collapsible (true) or not (false). Small, 50.0 50.0
column​Properties Column​Properties​Representation The column properties for the widget. Small, 42.0 42.0
columns String[] The columns for the widget. Small, 41.0 41.0
custom​Bulk​Actions Custom​Bulk​Action​Representation The custom bulk actions for the widget. Small, 42.0 42.0
even​Row​Color String The even row color for the widget. Small, 41.0 41.0
explore​Link Boolean Indicates whether the widget has an explore link (true) or not (false). Small, 38.0 38.0
fixed​Column​Width Integer The fixed column width for the widget. Small, 40.0 40.0
header Table​Widget​Cell​Parameters​Representation The header properties for the widget. Small, 41.0 41.0
inner​Major​Border​Color String The inner major border color for the widget. Small, 41.0 41.0
inner​Minor​Border​Color String The inner minor border color for the widget. Small, 41.0 41.0
max​Column​Width Integer The maximum column width for the widget. Small, 40.0 40.0
min​Column​Width Integer The minimum column width for the widget. Small, 40.0 40.0
mode Connect​Wave​Table​Mode​Enum The table mode for the widget. Valid values are:
  • Fit​To​Container
  • Fixed
  • Variable
 Small, 40.0 40.0
number​Of​Frozen​Columns Integer The number of frozen columns for the widget. Small, 50.0 50.0
number​Of​Lines Integer The number of lines of text per row for the widget. Small, 41.0 41.0
odd​Row​Color String The odd row color for the widget. Small, 41.0 41.0
pivoted Boolean Indicates whether to display the widget as pivot (true) or not (false). Small, 39.0 39.0
show​Row​Index​Column Boolean Indicates whether to show the row index column for the widget (true) or not (false). Small, 41.0 41.0
step String The step name associated to the widget. Small, 38.0 38.0
subtotals Boolean Indicates whether to show the subtotals row for the widget (true) or not (false). Small, 47.0 47.0
totals Boolean Indicates whether to show the totals row for the widget (true) or not (false). Small, 40.0 40.0
vertical​Padding Integer The cell vertical padding value for the widget. Small, 41.0 41.0
Test​Widget​Parameters​Representation

TextWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in TextWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
content Dynamic​Data​Representation The dynamic value of the text in the widget. Small, 49.0 49.0
font​Size Object The font size of the text in the widget. Small, 36.0 36.0
text String DEPRECATED The value of the text in the widget. Small, 36.0 36.0-48.0
text​Alignment Connect​Wave​Horizontal​Alignment​Enum The alignment of the text. Values are:
  • Center
  • Left
  • Right
 Small, 36.0 36.0
text​Color String The color of the text in the widget. Small, 36.0 36.0
tooltip String The tooltip for the widget. Small, 42.0 42.0
Url​Widget​Parameters​Representation

UrlWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in UrlWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
type Connect​Wave​Url​Widget​Type The type of URL for the widget. Valid values are:
  • YouTube
 Small, 36.0 36.0
url String The URL for the widget. Small, 36.0 36.0
video​Size String The size of the video the URL loads for the widget. Small, 36.0 36.0
Values​Table​Widget​Parameters​Representation

ValueTablesWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in ValueTablesWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
explore​Link Boolean Indicates whether the widget has an explore link (true) or not (false). Small, 36.0 36.0
hide​Header​Link Boolean Indicates whether the header column is hidden for this widget (true) or not (false). Small, 36.0 36.0
max​Column​Width Integer The maximum column width for the widget. Small, 36.0 36.0
min​Column​Width Integer The minimum column width for the widget. Small, 36.0 36.0
step String The step name associated to the widget. Small, 36.0 36.0
totals Boolean Indicates whether to show the totals row for the widget (true) or not (false). Small, 36.0 36.0
Widget​Parameters​Representation
Property Name Type Description Filter Group and Version Available Version
onboarding Widget​Onboarding​Representation The value to indicate the widget onboarding content. Small, 46.0 46.0
select​Mode​Override Connect​Wave​Select​Mode​Enum The select mode types. Valid values are:
  • Multi
  • MultiRequired
  • None
  • Single
  • SingleRequired
 Small, 36.0 36.0
show​Action​Menu Boolean Indicates whether to display the widget action menu (true) or not (false). Small, 44.0 44.0
Widget​Onboarding​Representation
Property Name Type Description Filter Group and Version Available Version
title String The title of the onboarding content. Small, 46.0 46.0
url String The URL of the onboarding content. Small, 46.0 46.0
Selector​Widget​Parameters​Representation

SelectorWidgetParametersRepresentation inherits properties from the abstract WidgetParametersRepresentation. These base properties appear in SelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
display​Mode Connect​Wave​Selector​Display​Mode​Enum The display mode for dashboard selector widgets. Valid values are:
  • Combo
  • Filter
 Small, 46.0 46.0
filter​Style Filter​Style​Representation The styling properties for filter widgets. Small, 46.0 46.0
instant Boolean Indicates whether the list selector is instant (true) or not (false). Small, 36.0 36.0
step String The step name associated to the widget. Small, 36.0 36.0
title String The title of the widget. Small, 36.0 36.0
Widget​Position​Representation
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
Filter​Item​Options​Representation
Property Name Type Description Filter Group and Version Available Version
background​Color String The background color of the filter items. Small, 41.0 41.0
border​Color String The border color of the filter items. Small, 41.0 41.0
border​Radius Integer The border radius of the filter items. Small, 41.0 41.0
border​Width Integer The border width of the filter items. Small, 41.0 41.0
property​Color String The property color of the filter items. Small, 41.0 41.0
value​Color String The value color of the filter items. Small, 41.0 41.0
Filter​Item​Reference​Representation

FilterItemReferenceRepresentation inherits properties from the abstract FilterRepresentation. These base properties appear in FilterItemReferenceRepresentation alongside the properties defined explicitly in the following table.

Property Name Type Description Filter Group and Version Available Version
dataset Asset​Reference​Representation[] The dataset in the filters section. Small, 46.0 46.0
field String The field in the filters section. Small, 46.0 46.0
Filter​Panel​Title​Representation
Property Name Type Description Filter Group and Version Available Version
separator​Color String The filter panel's title separator color. Small, 41.0 41.0
text Text​Representation[] The filter panel's title text. Small, 41.0 41.0
visible Boolean Indicates whether the filter panel's title is visible (true) or not (false). Small, 41.0 41.0
Filter​Representation
Property Name Type Description Filter Group and Version Available Version
parameters Filter​Param​Representation[] The filter panel parameters. Small, 41.0 41.0
Filter​Param​Representation
Property Name Type Description Filter Group and Version Available Version
filter String The filter expression that specifies which records to include. Small, 41.0 41.0
saql​Filter String The SAQL expression that specifies which records to include. Small, 44.0 44.0
Link​Asset​Destination​Representation
Property Name Type Description Filter Group and Version Available Version
name String The name of the asset referenced by the link. Small, 45.0 45.0
namespace String The namespace of the asset referenced by the link. Small, 45.0 45.0
pageName String The page name for the link. Small, 45.0 45.0
saved​View​Id String The dashboard saved view id for the link. Small, 47.0 47.0
widget​Id String The dashboard widget id for the link. Small, 47.0 47.0
Link​Page​Destination​Representation
Property Name Type Description Filter Group and Version Available Version
name String The name of the page referenced by the link. Small, 45.0 45.0
Link​Url​Destination​Representation
Property Name Type Description Filter Group and Version Available Version
tooltip String The tooltip for the link. Small, 45.0 45.0
url String The URL of the link. Small, 45.0 45.0
Tab​Style​Parameters​Representation
Property Name Type Description Filter Group and Version Available Version
background​Color String The background color for the tab. Small, 43.0 43.0
border​Color String The border color for the tab. Small, 43.0 43.0
border​Edges Connect​Wave​Border​Edge​Type​Enum The edges of the border to be drawn. Valid values are:
  • All
  • Bottom
  • Left
  • Right
  • Top
 Small, 43.0 43.0
border​Width Integer The border width for the tab. Small, 43.0 43.0
text​Color String The text color for the selected tab. Small, 43.0 43.0
Link​Destination​Representation
Property Name Type Description Filter Group and Version Available Version
tooltip String The tooltip for the link. Small, 46.0 46.0
url String The URL for the link. Small, 43.0 43.0
Link​Mass​Action​Destination​Representation
Property Name Type Description Filter Group and Version Available Version
action​Name String The name of the action. Small, 51.0 51.0
field String The field name for the action. Small, 51.0 51.0
step String The step to invoke the action on. Small, 51.0 51.0
Tooltip​Representation
Property Name Type Description Filter Group and Version Available Version
content Tooltip​Content​Representation The content for the tooltip. Small, 51.0 51.0
customize​Tooltip Boolean Indicates whether the tooltip is customized (true) or not (false). Small, 51.0 51.0
Filter​Style​Representation
Property Name Type Description Filter Group and Version Available Version
title​Color String The color of the displayed title. Small, 46.0 46.0
value​Color String The color for the displayed value. Small, 46.0 46.0
Repeater​Widget​Card​Properties​Representation
Property Name Type Description Filter Group and Version Available Version
cell​Spacing​X Integer The horizontal spacing between grid cells. Small, 53.0 53.0
cell​Spacing​Y Integer The vertical spacing between grid cells. Small, 53.0 53.0
num​Columns Integer The number of columns for a repeater grid. Small, 53.0 53.0
row​Height Connect​Wave​Row​Height​Enum Specifies the grid cell row height. Valid values are:
  • Fine
  • Normal
 Small, 53.0 53.0
styles Grid​Layout​Widget​Style​Representation The styling for the card of the widget Small, 53.0 53.0
Repeater​Widget​Cell​Properties​Representation
Property Name Type Description Filter Group and Version Available Version
parameters Object The parameters of the cell, based on it's type. Small, 53.0 53.0
position Grid​Layout​Widget​Representation The cell position, dimension, and styles. Small, 53.0 53.0
type Connect​Wave​Repeater​Cell​Type​Enum The cell type. Valid values are:
  • Number
  • Text
 Small, 53.0 53.0
Table​Widget​Cell​Parameters​Representation
Property Name Type Description Filter Group and Version Available Version
background​Color String The background color of the cell. Small, 41.0 41.0
font​Color String The color for the cell text font. Small, 41.0 41.0
font​Size Integer The size for the cell text font. Small, 41.0 41.0
Column​Properties​Representation
Property Name Type Description Filter Group and Version Available Version
parameters Object The valid column parameters based on its type. Small, 42.0 42.0
type Connect​Wave​Column​Render​Type​Enum The render types of a column. Valid values are:
  • Bar
  • Image
  • Text
 Small, 41.0 41.0
Custom​Bulk​Action​Representation
Property Name Type Description Filter Group and Version Available Version
label String The label for the custom action. Small, 39.0 39.0
visualforce Asset​Reference​Representation The VisualForce page to invoke for the custom action. Small, 39.0 39.0
Text​Representation
Property Name Type Description Filter Group and Version Available Version
align Connect​Wave​Horizontal​Alignment​Enum The alignment of the text. Values are:
  • Center
  • Left
  • Right
 Small, 41.0 41.0
color String The color of the text. Small, 41.0 41.0
fontSize Integer The font size of the text. Small, 41.0 41.0
label String The label for the text. Small, 41.0 41.0
Column​Representation
Property Name Type Description Filter Group and Version Available Version
format Connect​Wave​Column​Format​Enum The column format value. Valid values are:
  • Currency​Cents
  • Currency​Dollars
  • Number
  • Percentage
 Small, 36.0 36.0
header String The header text of this column. Small, 36.0 36.0
hidden Boolean Indicates whether the column is hidden (true) or not (false). Small, 36.0 36.0
query Query​Representation The SAQL used to create the comparison table. Small, 36.0 36.0
showBars Boolean Indicates whether to show bars for the column (true) (true) or not (false) (false). Small, 36.0 36.0
sort Connect​Wave​Column​Sort​Enum The column sort order. Valid values are:
  • None
  • Ascending
  • Descending
  • Inner​Ascending
  • Inner​Descending
 Small, 36.0 36.0
Dynamic​Data​Representation
Property Name Type Description Filter Group and Version Available Version
display​Template String The dynamic expression to resolve. Small, 49.0 49.0
rich​Text​Content Map<String, Rich​Text​Content​Block​Representation[] List of rich text content blocks. Small, 52.0 52.0
values Map<String, Dynamic​Value​Representation> Map to contain the data for the dynamic values. Small, 49.0 49.0
Rich​Text​Content​Block​Representation
Property Name Type Description Filter Group and Version Available Version
attributes Map<String, Object> Map of text attribute names and values. Small, 52.0 52.0
insert String The text block content Small, 52.0 52.0
Dynamic​Value​Representation
Property Name Type Description Filter Group and Version Available Version
field String The column used to resolve the value. Small, 49.0 49.0
source​Type Connect​Wave​Dynamic​Data​Source​Type The interaction type for the value. Valid values are:
  • Result
  • Selection
 Small, 49.0 49.0
step String The step id for the value. Small, 49.0 49.0
Tooltip​Content​Representation
Property Name Type Description Filter Group and Version Available Version
body Tooltip​Visualization​Representation The visualization for the tooltip. Small, 51.0 51.0-52.0
description Dynamic​Data​Representation The text content for the tooltip. Small, 51.0 51.0
widget Tooltip​Widget​Representation The widget displayed in the tooltip. Small, 53.0 53.0
Tooltip​Widget​Representation
Property Name Type Description Filter Group and Version Available Version
height Object The height of the widget in the tooltip. Small, 53.0 53.0
name String The name of the widget in the tooltip. Small, 53.0 53.0
width Object The width of the widget in the tooltip. Small, 53.0 53.0
Tooltip​Visualization​Representation
Property Name Type Description Filter Group and Version Available Version
height Object The height for the tooltip. Small, 51.0 51.0
source Typed​Asset​Reference​Representation The source for the tooltip visualization. Small, 51.0 51.0
width Object The width for the tooltip. Small, 51.0 51.0
Tooltip​Source​Representation
Property Name Type Description Filter Group and Version Available Version
name String The name of the tooltip source. Small, 51.0 51.0
namespace String The namespace of the tooltip source. Small, 51.0 51.0
type String The type of the tooltip source. Small, 51.0 51.0