AnalyticsDashboard

Represents a Tableau Next dashboard.

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.

This type extends Metadata and inherits its fields.

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

Introduced in API version 64.0.

DefinitionLimit
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

  • Type: string

  • Required: Yes

  • Description: Required.

    The Tableau Next workspace the dashboard belongs to.

  • Type: string
  • Required: No
  • Description: The source for the dashboard background.
  • Type: string
  • Required: No
  • Description: A custom configuration for the dashboard.
  • Type: string
  • Required: No
  • Description: The description of the dashboard.
  • Type: dateTime
  • Required: No
  • Description: The date the dashboard draft was last modified.
  • Type: dateTime
  • Required: No
  • Description: The date the dashboard was last published.

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the dashboard.

  • Type: string

  • Required: No

  • Description: The style of the dashboard. This is a JSON string.

    Example:

  • Type: string
  • Required: No
  • Description: If the dashboard was created from a template, the name of the source dashboard in the template.
  • Type: string
  • Required: No
  • Description: If the dashboard was created from a template, the name of the source template.
  • Type: AnalyticsDashboardType (enumeration of type string)
  • Required: No
  • Type: double
  • Required: No
  • Description: The API version of the dashboard.
  • Type: AnalyticsDashboardWidget[]
  • Required: No
  • Description: A list of widgets in the dashboard. A dashboard has 0 or more widgets.
  • Type: AnalyticsWorkspaceAsset[]
  • Required: No
  • Description: A list of analytics assets in the workspace this dashboard is associated with. A dashboard has 0 or more workspace asset relationships.

Represents an action for a Tableau Next asset.

  • Type: AnalyticsActionType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The action type.

    Values are:

  • Possible values:

    • filter
    • flow
    • navigate
    • parameter
    • recordaction

  • Type: string

  • Required: No

  • Description: Optional.

    The version of the Analytics asset the action is associated with.

  • Type: AnalyticsActionEventType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The action event type.

    Values are:

  • Possible values:

    • click
    • select

  • Type: string

  • Required: No

  • Description: The parameter for the action. This is a JSON string.

    Example:

  • Type: double
  • Required: No
  • Description: The API version of the action.

Represents a button widget definition for a Tableau Next dashboard.

  • Type: string

  • Required: No

  • Description: The parameters for the button widget. This is a JSON String.

    Example:

Represents a container widget definition for a Tableau Next dashboard.

  • Type: string
  • Required: No

  • Type: string

  • Required: No

  • Description: The parameters for the container widget. This is a JSON String.

    Example:

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

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the dashboard the layout is associated with.

  • Type: string
  • Required: No
  • Description: The version of the dashboard the layout is associated with.
  • Type: string
  • Required: No
  • Description: The number of columns in the layout.
  • Type: string
  • Required: No
  • Description: The label for the layout.
  • Type: string
  • Required: No
  • Description: The name of the layout.
  • Type: string
  • Required: No
  • Description: The max width of the layout, in pixels.
  • Type: string
  • Required: No
  • Type: AnalyticsDashboardPage[]
  • Required: No
  • Description: The pages to display for this dashboard layout. A layout has 0 or more pages.
  • Type: string
  • Required: No
  • Description: The row height for layout rows.

  • Type: string

  • Required: No

  • Description: The style for the layout. This is a JSON string.

    Example:

  • Type: double
  • Required: No
  • Description: The API version of the dashboard layout.

Represents a page in a Tableau Next dashboard.

  • Type: int
  • Required: No
  • 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.
  • Type: string
  • Required: No
  • Description: The label for the dashboard page.
  • Type: string
  • Required: No
  • Description: The generated unique ID for the dashboard page.
  • Type: AnalyticsDashPageWidget[]
  • Required: No
  • Description: A list of dashboard page widgets. A page has 0 or more page widgets.

Represents a widget on a Tableau Next dashboard.

  • Type: string

  • Required: Yes

  • Description: Required.

    The API name of the dashboard the widget is associated with.

  • Type: string
  • Required: No
  • Type: AnalyticsButtonWidgetDef[]
  • Required: No
  • Description: A list of button widget type definitions. A dashboard has 0 or more button widgets. Required if button widget are defined.
  • Type: AnalyticsContainerWidgetDef[]
  • Required: No
  • Description: A list of container widget type definitions. A dashboard has 0 or more container widgets. Required if container widgets are defined.
  • Type: AnlytDshbrdWdgtDynamicTkn[]
  • Required: No
  • Description: A list of dynamic widget tokens. A dashboard has 0 or more dynamic tokens.
  • Type: AnalyticsFilterWidgetDef[]
  • Required: No
  • Description: A list of filter widget type definitions. A dashboard has 0 or more filter widgets. Required if filter widgets are defined.
  • Type: AnalyticsImageWidgetDef[]
  • Required: No
  • Description: A list of image widget type definitions. A dashboard has 0 or more image widgets. Required if image widgets are defined.
  • Type: string
  • Required: No
  • Description: The label for the widget.
  • Type: AnalyticsMetricWidgetDef[]
  • Required: No
  • Description: A list of metric widget type defintions. A dashboard has 0 or more metric widgets. Required if metric widget are defined.
  • Type: AnalyticsNavWidgetDef[]
  • Required: No
  • Description: A list of navigation widget type definitions. A dashboard has 0 or more navigation widgets. Required if navigation widgets are defined.
  • Type: AnalyticsParamWidgetDef[]
  • Required: No
  • Description: A list of parameter widget type defintions. A dashboard has 0 or more parameter widgets. Required for parameter widgets are defined.
  • Type: AnalyticsTextWidgetDef[]
  • Required: No
  • Description: TA list of text widget type definitions. A dashboard has 0 or more text widgets. Required if text widgets are defined.

  • Type: AnalyticsWidgetType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The widget type.

    Values are:

  • Possible values:

    • button
    • container
    • extension
    • filter
    • image
    • metric
    • parameter
    • navigation
    • text
    • summary
    • visualization
  • Type: AnalyticsVizWidgetDef[]
  • Required: No
  • Description: A list of visualization widget type definitions. A dashboard has 0 or more visualization widgets. Required if visualization widgets are defined.
  • Type: AnalyticsAssetAction[]
  • Required: No
  • Description: The actions for the widget. A widget has 0 or more text widgets.
  • Type: string
  • Required: No
  • Description: The API name of the widget. Use this for the analyticsDashboardWidget value in AnalyticsDashPageWidget.

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

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of dashboard widget, defined in the list of widgets for the dashboard.

  • Type: string
  • Required: No
  • Description: The column span for the widget on the page. This is a numeric value.
  • Type: string
  • Required: No
  • Description: The column the widget is placed in on the page. This is a numeric value.
  • Type: string
  • Required: No
  • Description: The row the widget is placed in on the page. This is a numeric value.
  • Type: string
  • Required: No
  • Description: The row span for the widget on the page. This is a numeric value.

Represents a filter widget definition for a Tableau Next dashboard.

  • Type: string
  • Required: No
  • Description: The initial values for the filter.

  • Type: string

  • Required: No

  • Description: The parameters for the filter widget. This is a JSON String.

    Example:

  • Type: string
  • Required: No
  • Description: The data source to apply the filter to.

Represents a image widget definition for a Tableau Next dashboard.

  • Type: string
  • Required: No
  • Description: The parameters for the image widget. This is a JSON String.
  • Type: string
  • Required: No
  • Description: The data source the image is associated with.

Represents a metric widget definition for a Tableau Next dashboard.

  • Type: string

  • Required: No

  • Description: The parameters for the filter widget. This is a JSON String.

    Example:

  • Type: string
  • Required: No
  • Description: The semantic model the metric is associated with.
  • Type: string
  • Required: No
  • Description: The data source the metric is associated with.
  • Type: string
  • Required: No
  • Description: Present if the data source the metric is associated with is deprecated.
  • Type: double
  • Required: No
  • Description: The API version of the metric.

Represents a navigation widget definition for a Tableau Next dashboard.

  • Type: string
  • Required: No
  • Description: The parameters for the navigation widget. This is a JSON String.

Represents a parameters widget definition for a Tableau Next dashboard.

  • Type: string
  • Required: No
  • Description: The initial values for the parameters.

  • Type: string

  • Required: No

  • Description: The parameters for the filter widget. This is a JSON String.

    Example:

  • Type: string
  • Required: No
  • Description: The data source the parameters are associated with.

Represents a text widget definition for a Tableau Next dashboard.

  • Type: string

  • Required: No

  • Description: The parameters for the filter widget. This is a JSON String.

    Example:

Represents a visualization widget definition for a Tableau Next dashboard.

  • Type: string
  • Required: No
  • Description: The API name of the visualization.
  • Type: string
  • Required: No
  • Description: The version of the visualization.

  • Type: string

  • Required: No

  • Description: The parameters for the filter widget. This is a JSON String.

    Example:

Represents a widget dynamic token for a Tableau Next dashboard.

  • Type: string
  • Required: No
  • Description: The description for the dynamic token.
  • Type: string
  • Required: No
  • Description: The label for the dynamic token.
  • Type: string
  • Required: No
  • Description: The source object of the dynamic token.
  • Type: string
  • Required: No
  • Description: The name of the dynamic token.
  • Type: string
  • Required: No
  • Description: The specification for the dynamic token.

  • Type: AnalyticsDynamicTokenType (enumeration of type string)

  • Required: No

  • Description: The type of dynamic token.

    Values are:

  • Possible values:

    • query
    • insights
    • metric
    • reference

The following is an example of an AnalyticsDashboard component.

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

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.