--- schema_version: "1" id: 50f04c1d45fcd8b83eae208dd7f82db847a65d286d925595e392f3f80a49aa9e title: AnalyticsDashboard collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_analyticsdashboard.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_analyticsdashboard.htm source_site: developer.salesforce.com content_type: documentation content_hash: a7d2a07fac890b5409dea6f33eba8960fec229f77600fc5530167514a68e5f8c description: Represents a Tableau Next dashboard. --- # AnalyticsDashboard Represents a Tableau Next dashboard. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important 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. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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\[\]](#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: {"widgetStyle":{"backgroundColor":"#ffffff","borderEdges":\[\],"borderColor":"#cccccc","borderWidth":1,"borderRadius":0}} | | 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\[\]](#AnalyticsDashboardWidget) Description A list of widgets in the dashboard. A dashboard has 0 or more widgets. | | workspaceAssetRelationships | Field Type [AnalyticsWorkspaceAsset\[\]](meta_analyticsworkspace.htm#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\[\]](#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: {"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\[\]](#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\[\]](#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\[\]](#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\[\]](#AnlytDshbrdWdgtDynamicTkn) Description A list of dynamic widget tokens. A dashboard has 0 or more dynamic tokens. | | filterWidgetDefs | Field Type [AnalyticsFilterWidgetDef\[\]](#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\[\]](#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\[\]](#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\[\]](#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\[\]](#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\[\]](#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\[\]](#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\[\]](#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 | | analyticsAssetVersion | 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: {"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: {"text":"Button","alignmentX":"center","alignmentY":"center","fontSize":16} | ## 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: {"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: {"receiveFilterSource":{"filterMode":"all","widgetIds":\[\]},"filterOption":{"objectName":"Account","fieldName":"Account\_Id","dataType":"Text","selectionType":"multiple"},"isLabelHidden":false} | | 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: {"metricOption":{"layout":{"componentVisibility":{"details":true,"title":true,"value":true,"comparison":true,"chart":true,"insights":false}},"sdmApiName":"AccountModel","sdmId":"2SMxx0000004CFUGA2"},"receiveFilterSource":{"filterMode":"all","widgetIds":\[\]}} | | 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: {"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: {"content":\[{"attributes":{"color":"#000000","size":"12px"},"insert":"full dashboard"},{"attributes":{"align":"left"},"insert":"\\n"}\]} | ## 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: {"legendPosition":"Right","receiveFilterSource":{"filterMode":"all","widgetIds":\[\]}} | ## Declarative Metadata Sample Definition The following is an example of an AnalyticsDashboard component. My\_Workspace A dashboard My\_Dashboard 36 default 1200 layoutLabel 0 Page 1 e412bc11-d43b-4fba-ab44-b31bb842b49a visualization\_1 11 1 2 10 button\_1 9 13 8 2 container\_1 11 23 2 10 text\_2 9 13 5 2 metric\_1 11 1 13 10 list\_4 9 13 13 2 list\_1 9 13 2 2 24 {"backgroundColor":"#ffffff","gutterColor":"#f3f3f3","cellSpacingX":8,"cellSpacingY":8} My Dashboard {"widgetStyle":{"backgroundColor":"#ffffff","borderEdges":\[\],"borderColor":"#cccccc","borderWidth":1,"borderRadius":0}} 64.0 My\_Dashboard visualization New\_Visualization {"legendPosition":"Right","receiveFilterSource":{"filterMode":"all","widgetIds":\[\]}} visualization\_1 My\_Dashboard {"text":"Button","alignmentX":"center","alignmentY":"center","fontSize":16} button navigate click {"destination":{"type":"url","target":"www.salesforce.com"}} 63.0 button\_1 My\_Dashboard {"widgetStyle":{"backgroundColor":"#1295FF","borderEdges":\[\]}} container container\_1 My\_Dashboard {"content":\[{"attributes":{"color":"#000000","size":"12px"},"insert":"full dashboard"},{"attributes":{"align":"left"},"insert":"\\n"}\]} text text\_2 My\_Dashboard {"metricOption":{"layout":{"componentVisibility":{"details":true,"title":true,"value":true,"comparison":true,"chart":true,"insights":false}},"sdmApiName":"AccountModel","sdmId":"2SMxx0000004CFUGA2"},"receiveFilterSource":{"filterMode":"all","widgetIds":\[\]}} AccountMetric\_mtc metric metric\_1 My\_Dashboard null {"receiveFilterSource":{"filterMode":"all","widgetIds":\[\]},"filterOption":{"objectName":"Account","fieldName":"Account\_Id","dataType":"Text","selectionType":"multiple"},"isLabelHidden":false} AccountModel Account Id filter list\_4 My\_Dashboard AccountParameter null {"parameterName":"AccountParameter\_prm","isLabelHidden":false} AccountModel parameter list\_1 AnalyticsDashboard Created My\_Workspace The following is an example package.xml that references the previous definition. My\_Dashboard AnalyticsDashboard 64.0 ## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").