AnalyticsDashboard | Metadata API Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

AnalyticsDashboard components have the suffix .uadash and are stored in the analyticsDashboards folder.

Version

AnalyticsDashboard components are available in API version 64.0 and later.

Limits

Definition	Limit
The maximum number of AnalyticsDashboard components in a single deploy operation.	50
The maximum number of AnalyticsDashboard components in a single retrieve operation.	100
The maximum number of AnalyticsDashboard components across all deploy operations in a 24-hour window.	100
The maximum number of AnalyticsDashboard components across all retrieve operations in a 24-hour window.	200

Fields

Field Name	Description
analyticsWorkspace	Field Type string Description Required. The Tableau Next workspace the dashboard belongs to.
backgroundSource	Field Type string Description The source for the dashboard background.
customConfig	Field Type string Description A custom configuration for the dashboard.
description	Field Type string Description The description of the dashboard.
lastDraftModifiedDate	Field Type dateTime Description The date the dashboard draft was last modified.
lastPublishedDate	Field Type dateTime Description The date the dashboard was last published.
layouts	Field Type AnalyticsDashboardLayout[] Description The layouts for the dashboard. A dashboard has 0 or more layouts.
masterLabel	Field Type string Description Required. The name of the dashboard.
style	Field Type string Description The style of the dashboard. This is a JSON string. Example: `1{"widgetStyle":{"backgroundColor":"#ffffff","borderEdges":[],"borderColor":"#cccccc","borderWidth":1,"borderRadius":0}} 2`
templateAssetSourceName	Field Type string Description If the dashboard was created from a template, the name of the source dashboard in the template.
templateSource	Field Type string Description If the dashboard was created from a template, the name of the source template.
version	Field Type double Description The API version of the dashboard.
widgets	Field Type AnalyticsDashboardWidget[] Description A list of widgets in the dashboard. A dashboard has 0 or more widgets.
workspaceAssetRelationships	Field Type AnalyticsWorkspaceAsset[] Description A list of analytics assets in the workspace this dashboard is associated with. A dashboard has 0 or more workspace asset relationships.

AnalyticsDashboardLayout

Represents a layout for a Tableau Next dashboard. A dashboard can have multiple layouts, like Desktop and Mobile.

Field Name	Description
analyticsDashboard	Field Type string Description Required. The name of the dashboard the layout is associated with.
analyticsDashboardVersion	Field Type string Description The version of the dashboard the layout is associated with.
columnCount	Field Type string Description The number of columns in the layout.
label	Field Type string Description The label for the layout.
layoutName	Field Type string Description The name of the layout.
maxWidth	Field Type string Description The max width of the layout, in pixels.
pages	Field Type AnalyticsDashboardPage[] Description The pages to display for this dashboard layout. A layout has 0 or more pages.
rowHeight	Field Type string Description The row height for layout rows.
style	Field Type string Description The style for the layout. This is a JSON string. Example: `1{"backgroundColor":"#ffffff","gutterColor":"#f3f3f3","cellSpacingX":8,"cellSpacingY":8`
version	Field Type double Description The API version of the dashboard layout.

AnalyticsDashboardPage

Represents a page in a Tableau Next dashboard.

Field Name	Description
index	Field Type int Description The index of the page in the dashboard. An index of `0` is the first page of the dashboard. No index is required if there is only the default page of the dashboard.
label	Field Type string Description The label for the dashboard page.
pageName	Field Type string Description The generated unique ID for the dashboard page.
pageWidgets	Field Type AnalyticsDashPageWidget[] Description A list of dashboard page widgets. A page has 0 or more page widgets.

AnalyticsDashPageWidget

Represents an dashboard page widget for a Tableau Next dashboard page.

Field Name	Description
analyticsDashboardWidget	Field Type string Description Required. The name of dashboard widget, defined in the list of widgets for the dashboard.
colspan	Field Type string Description The column span for the widget on the page. This is a numeric value.
column	Field Type string Description The column the widget is placed in on the page. This is a numeric value.
row	Field Type string Description The row the widget is placed in on the page. This is a numeric value.
rowspan	Field Type string Description The row span for the widget on the page. This is a numeric value.

AnalyticsDashboardWidget

Represents a widget on a Tableau Next dashboard.

Field Name	Description
analyticsDashboard	Field Type string Description Required. The API name of the dashboard the widget is associated with.
buttonWidgetDefs	Field Type AnalyticsButtonWidgetDef[] Description A list of button widget type definitions. A dashboard has 0 or more button widgets. Required if button widget are defined.
containerWidgetDefs	Field Type AnalyticsContainerWidgetDef[] Description A list of container widget type definitions. A dashboard has 0 or more container widgets. Required if container widgets are defined.
dynamicTokens	Field Type AnlytDshbrdWdgtDynamicTkn[] Description A list of dynamic widget tokens. A dashboard has 0 or more dynamic tokens.
filterWidgetDefs	Field Type AnalyticsFilterWidgetDef[] Description A list of filter widget type definitions. A dashboard has 0 or more filter widgets. Required if filter widgets are defined.
imageWidgetDefs	Field Type AnalyticsImageWidgetDef[] Description A list of image widget type definitions. A dashboard has 0 or more image widgets. Required if image widgets are defined.
label	Field Type string Description The label for the widget.
metricWidgetDefs	Field Type AnalyticsMetricWidgetDef[] Description A list of metric widget type defintions. A dashboard has 0 or more metric widgets. Required if metric widget are defined.
navigationWidgetDefs	Field Type AnalyticsNavWidgetDef[] Description A list of navigation widget type definitions. A dashboard has 0 or more navigation widgets. Required if navigation widgets are defined.
parameterWidgetDefs	Field Type AnalyticsParamWidgetDef[] Description A list of parameter widget type defintions. A dashboard has 0 or more parameter widgets. Required for parameter widgets are defined.
textWidgetDefs	Field Type AnalyticsTextWidgetDef[] Description TA list of text widget type definitions. A dashboard has 0 or more text widgets. Required if text widgets are defined.
type	Field Type AnalyticsWidgetType (enumeration of type string) Description Required. The widget type. Values are: `button` `container` `extension` `filter` `image` `metric` `parameter` `navigation` `text` `summary` `visualization`
vizWidgetDefs	Field Type AnalyticsVizWidgetDef[] Description A list of visualization widget type definitions. A dashboard has 0 or more visualization widgets. Required if visualization widgets are defined.
widgetActions	Field Type AnalyticsAssetAction[] Description The actions for the widget. A widget has 0 or more text widgets.
widgetName	Field Type string Description The API name of the widget. Use this for the `analyticsDashboardWidget` value in `AnalyticsDashPageWidget`.

AnalyticsAssetAction

Represents an action for a Tableau Next asset.

Field Name	Description
actionType	Field Type AnalyticsActionType (enumeration of type string) Description Required. The action type. Values are: `filter` `flow` `navigate` `parameter` `recordaction`
analyticsAssetVerson	Field Type string Description Optional. The version of the Analytics asset the action is associated with.
eventType	Field Type AnalyticsActionEventType (enumeration of type string) Description Required. The action event type. Values are: `click` `select`
parameters	Field Type string Description The parameter for the action. This is a JSON string. Example: `1{"destination":{"type":"url","target":"www.salesforce.com"}}`
version	Field Type double Description The API version of the action.

AnalyticsButtonWidgetDef

Represents a button widget definition for a Tableau Next dashboard.

Field Name	Description
parameters	Field Type string Description The parameters for the button widget. This is a JSON String. Example: `1{"text":"Button","alignmentX":"center","alignmentY":"center","fontSize":16} 2`

AnalyticsContainerWidgetDef

Represents a container widget definition for a Tableau Next dashboard.

Field Name	Description
parameters	Field Type string Description The parameters for the container widget. This is a JSON String. Example: `1{"widgetStyle":{"backgroundColor":"#1295FF","borderEdges":[]}}`

AnlytDshbrdWdgtDynamicTkn

Represents a widget dynamic token for a Tableau Next dashboard.

Field Name	Description
description	Field Type string Description The description for the dynamic token.
label	Field Type string Description The label for the dynamic token.
source	Field Type string Description The source object of the dynamic token.
tokenName	Field Type string Description The name of the dynamic token.
tokenSpec	Field Type string Description The specification for the dynamic token.
type	Field Type AnalyticsDynamicTokenType Description The type of dynamic token. Values are: `query` `insights` `metric` `reference`

AnalyticsFilterWidgetDef

Represents a filter widget definition for a Tableau Next dashboard.

Field Name	Description
initialValues	Field Type string Description The initial values for the filter.
parameters	Field Type string Description The parameters for the filter widget. This is a JSON String. Example: `1{"receiveFilterSource":{"filterMode":"all","widgetIds":[]},"filterOption":{"objectName":"Account","fieldName":"Account_Id","dataType":"Text","selectionType":"multiple"},"isLabelHidden":false} 2`
source	Field Type string Description The data source to apply the filter to.

AnalyticsImageWidgetDef

Represents a image widget definition for a Tableau Next dashboard.

Field Name	Description
parameters	Field Type string Description The parameters for the image widget. This is a JSON String.
source	Field Type string Description The data source the image is associated with.

AnalyticsMetricWidgetDef

Represents a metric widget definition for a Tableau Next dashboard.

Field Name	Description
parameters	Field Type string Description The parameters for the filter widget. This is a JSON String. Example: `1{"metricOption":{"layout":{"componentVisibility":{"details":true,"title":true,"value":true,"comparison":true,"chart":true,"insights":false}},"sdmApiName":"AccountModel","sdmId":"2SMxx0000004CFUGA2"},"receiveFilterSource":{"filterMode":"all","widgetIds":[]}} 2`
semanticModel	Field Type string Description The semantic model the metric is associated with.
source	Field Type string Description The data source the metric is associated with.
sourceDeprecated	Field Type string Description Present if the data source the metric is associated with is deprecated.
version	Field Type double Description The API version of the metric.

AnalyticsNavWidgetDef

Represents a navigation widget definition for a Tableau Next dashboard.

Field Name	Description
parameters	Field Type string Description The parameters for the navigation widget. This is a JSON String.

AnalyticsParamWidgetDef

Represents a parameters widget definition for a Tableau Next dashboard.

Field Name	Description
initialValues	Field Type string Description The initial values for the parameters.
parameters	Field Type string Description The parameters for the filter widget. This is a JSON String. Example: `1{"parameterName":"AccountParameter_prm","isLabelHidden":false}`
source	Field Type string Description The data source the parameters are associated with.

AnalyticsTextWidgetDef

Represents a text widget definition for a Tableau Next dashboard.

Field Name	Description
parameters	Field Type string Description The parameters for the filter widget. This is a JSON String. Example: `1{"content":[{"attributes":{"color":"#000000","size":"12px"},"insert":"full dashboard"},{"attributes":{"align":"left"},"insert":"\n"}]} 2`

AnalyticsVizWidgetDef

Represents a visualization widget definition for a Tableau Next dashboard.

Field Name	Description
analyticsVisualization	Field Type string Description The API name of the visualization.
analyticsVizVersion	Field Type string Description The version of the visualization.
parameters	Field Type string Description The parameters for the filter widget. This is a JSON String. Example: `1{"legendPosition":"Right","receiveFilterSource":{"filterMode":"all","widgetIds":[]}}`

Declarative Metadata Sample Definition

The following is an example of an AnalyticsDashboard component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AnalyticsDashboard xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <analyticsWorkspace>My_Workspace</analyticsWorkspace>
4    <description>A dashboard</description>
5    <layouts>
6        <analyticsDashboard>My_Dashboard</analyticsDashboard>
7        <columnCount>36</columnCount>
8        <layoutName>default</layoutName>
9        <maxWidth>1200</maxWidth>
10        <label>layoutLabel</label>
11        <pages>
12            <index>0</index>
13            <label>Page 1</label>
14            <pageName>e412bc11-d43b-4fba-ab44-b31bb842b49a</pageName>
15            <pageWidgets>
16                <analyticsDashboardWidget>visualization_1</analyticsDashboardWidget>
17                <colspan>11</colspan>
18                <column>1</column>
19                <row>2</row>
20                <rowspan>10</rowspan>
21            </pageWidgets>
22            <pageWidgets>
23                <analyticsDashboardWidget>button_1</analyticsDashboardWidget>
24                <colspan>9</colspan>
25                <column>13</column>
26                <row>8</row>
27                <rowspan>2</rowspan>
28            </pageWidgets>
29            <pageWidgets>
30                <analyticsDashboardWidget>container_1</analyticsDashboardWidget>
31                <colspan>11</colspan>
32                <column>23</column>
33                <row>2</row>
34                <rowspan>10</rowspan>
35            </pageWidgets>
36            <pageWidgets>
37                <analyticsDashboardWidget>text_2</analyticsDashboardWidget>
38                <colspan>9</colspan>
39                <column>13</column>
40                <row>5</row>
41                <rowspan>2</rowspan>
42            </pageWidgets>
43            <pageWidgets>
44                <analyticsDashboardWidget>metric_1</analyticsDashboardWidget>
45                <colspan>11</colspan>
46                <column>1</column>
47                <row>13</row>
48                <rowspan>10</rowspan>
49            </pageWidgets>
50            <pageWidgets>
51                <analyticsDashboardWidget>list_4</analyticsDashboardWidget>
52                <colspan>9</colspan>
53                <column>13</column>
54                <row>13</row>
55                <rowspan>2</rowspan>
56            </pageWidgets>
57            <pageWidgets>
58                <analyticsDashboardWidget>list_1</analyticsDashboardWidget>
59                <colspan>9</colspan>
60                <column>13</column>
61                <row>2</row>
62                <rowspan>2</rowspan>
63            </pageWidgets>
64        </pages>
65        <rowHeight>24</rowHeight>
66        <style>{&quot;backgroundColor&quot;:&quot;#ffffff&quot;,&quot;gutterColor&quot;:&quot;#f3f3f3&quot;,&quot;cellSpacingX&quot;:8,&quot;cellSpacingY&quot;:8}</style>
67    </layouts>
68    <masterLabel>My Dashboard</masterLabel>
69    <style>{&quot;widgetStyle&quot;:{&quot;backgroundColor&quot;:&quot;#ffffff&quot;,&quot;borderEdges&quot;:[],&quot;borderColor&quot;:&quot;#cccccc&quot;,&quot;borderWidth&quot;:1,&quot;borderRadius&quot;:0}}</style>
70    <version>64.0</version>
71    <widgets>
72        <analyticsDashboard>My_Dashboard</analyticsDashboard>
73        <type>visualization</type>
74        <vizWidgetDefs>
75            <analyticsVisualization>New_Visualization</analyticsVisualization>
76            <parameters>{&quot;legendPosition&quot;:&quot;Right&quot;,&quot;receiveFilterSource&quot;:{&quot;filterMode&quot;:&quot;all&quot;,&quot;widgetIds&quot;:[]}}</parameters>
77        </vizWidgetDefs>
78        <widgetName>visualization_1</widgetName>
79    </widgets>
80    <widgets>
81        <analyticsDashboard>My_Dashboard</analyticsDashboard>
82        <buttonWidgetDefs>
83            <parameters>{&quot;text&quot;:&quot;Button&quot;,&quot;alignmentX&quot;:&quot;center&quot;,&quot;alignmentY&quot;:&quot;center&quot;,&quot;fontSize&quot;:16}</parameters>
84        </buttonWidgetDefs>
85        <type>button</type>
86        <widgetActions>
87            <actionType>navigate</actionType>
88            <eventType>click</eventType>
89            <parameters>{&quot;destination&quot;:{&quot;type&quot;:&quot;url&quot;,&quot;target&quot;:&quot;www.salesforce.com&quot;}}</parameters>
90            <version>63.0</version>
91        </widgetActions>
92        <widgetName>button_1</widgetName>
93    </widgets>
94    <widgets>
95        <analyticsDashboard>My_Dashboard</analyticsDashboard>
96        <containerWidgetDefs>
97            <parameters>{&quot;widgetStyle&quot;:{&quot;backgroundColor&quot;:&quot;#1295FF&quot;,&quot;borderEdges&quot;:[]}}</parameters>
98        </containerWidgetDefs>
99        <type>container</type>
100        <widgetName>container_1</widgetName>
101    </widgets>
102    <widgets>
103        <analyticsDashboard>My_Dashboard</analyticsDashboard>
104        <textWidgetDefs>
105            <parameters>{&quot;content&quot;:[{&quot;attributes&quot;:{&quot;color&quot;:&quot;#000000&quot;,&quot;size&quot;:&quot;12px&quot;},&quot;insert&quot;:&quot;full dashboard&quot;},{&quot;attributes&quot;:{&quot;align&quot;:&quot;left&quot;},&quot;insert&quot;:&quot;\n&quot;}]}</parameters>
106        </textWidgetDefs>
107        <type>text</type>
108        <widgetName>text_2</widgetName>
109    </widgets>
110    <widgets>
111        <analyticsDashboard>My_Dashboard</analyticsDashboard>
112        <metricWidgetDefs>
113            <parameters>{&quot;metricOption&quot;:{&quot;layout&quot;:{&quot;componentVisibility&quot;:{&quot;details&quot;:true,&quot;title&quot;:true,&quot;value&quot;:true,&quot;comparison&quot;:true,&quot;chart&quot;:true,&quot;insights&quot;:false}},&quot;sdmApiName&quot;:&quot;AccountModel&quot;,&quot;sdmId&quot;:&quot;2SMxx0000004CFUGA2&quot;},&quot;receiveFilterSource&quot;:{&quot;filterMode&quot;:&quot;all&quot;,&quot;widgetIds&quot;:[]}}</parameters>
114            <source>AccountMetric_mtc</source>
115        </metricWidgetDefs>
116        <type>metric</type>
117        <widgetName>metric_1</widgetName>
118    </widgets>
119    <widgets>
120        <analyticsDashboard>My_Dashboard</analyticsDashboard>
121        <filterWidgetDefs>
122            <initialValues>null</initialValues>
123            <parameters>{&quot;receiveFilterSource&quot;:{&quot;filterMode&quot;:&quot;all&quot;,&quot;widgetIds&quot;:[]},&quot;filterOption&quot;:{&quot;objectName&quot;:&quot;Account&quot;,&quot;fieldName&quot;:&quot;Account_Id&quot;,&quot;dataType&quot;:&quot;Text&quot;,&quot;selectionType&quot;:&quot;multiple&quot;},&quot;isLabelHidden&quot;:false}</parameters>
124            <source>AccountModel</source>
125        </filterWidgetDefs>
126        <label>Account Id</label>
127        <type>filter</type>
128        <widgetName>list_4</widgetName>
129    </widgets>
130    <widgets>
131        <analyticsDashboard>My_Dashboard</analyticsDashboard>
132        <label>AccountParameter</label>
133        <parameterWidgetDefs>
134            <initialValues>null</initialValues>
135            <parameters>{&quot;parameterName&quot;:&quot;AccountParameter_prm&quot;,&quot;isLabelHidden&quot;:false}</parameters>
136            <source>AccountModel</source>
137        </parameterWidgetDefs>
138        <type>parameter</type>
139        <widgetName>list_1</widgetName>
140    </widgets>
141    <templateSource></templateSource>
142    <templateAssetSourceName></templateAssetSourceName>
143    <workspaceAssetRelationships>
144        <asset xsi:nil="true"/>
145        <assetType>AnalyticsDashboard</assetType>
146        <assetUsageType>Created</assetUsageType>
147        <workspace>My_Workspace</workspace>
148    </workspaceAssetRelationships>
149</AnalyticsDashboard>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>My_Dashboard</members>
5        <name>AnalyticsDashboard</name>
6    </types>
7    <version>64.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.