{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "AnalyticsDashboard - Metadata API",
"description": "Represents a Tableau Next dashboard.",
"file_information": ".uadash",
"directory_location": "analyticsDashboards",
"fields_columns": [
"type",
"required",
"description"
],
"fields": {
"analyticsWorkspace": {
"type": "string",
"required": true,
"description": "The Tableau Next workspace the dashboard belongs to."
},
"description": {
"type": "string",
"description": "The description of the dashboard."
},
"lastDraftModifiedDate": {
"type": "dateTime",
"description": "The date the dashboard draft was last modified."
},
"lastPublishedDate": {
"type": "dateTime",
"description": "The date the dashboard was last published."
},
"layouts": {
"type": "AnalyticsDashboardLayout[]",
"description": "The layouts for the dashboard. A dashboard has 0 or more layouts."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "The name of the dashboard."
},
"style": {
"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": {
"type": "string",
"description": "If the dashboard was created from a template, the name of the source dashboard in the template."
},
"templateSource": {
"type": "string",
"description": "If the dashboard was created from a template, the name of the source template."
},
"version": {
"type": "double",
"description": "The API version of the dashboard."
},
"widgets": {
"type": "AnalyticsDashboardWidget[]",
"description": "A list of widgets in the dashboard. A dashboard has 0 or more widgets."
},
"workspaceAssetRelationships": {
"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."
}
},
"sub_types": {
"AnalyticsDashboardLayout": {
"analyticsDashboard": {
"type": "string",
"required": true,
"description": "The name of the dashboard the layout is associated with."
},
"analyticsDashboardVersion": {
"type": "string",
"description": "The version of the dashboard the layout is associated with."
},
"columnCount": {
"type": "string",
"description": "The number of columns in the layout."
},
"label": {
"type": "string",
"description": "The label for the layout."
},
"layoutName": {
"type": "string",
"description": "The name of the layout."
},
"maxWidth": {
"type": "string",
"description": "The max width of the layout, in pixels."
},
"pages": {
"type": "AnalyticsDashboardPage[]",
"description": "The pages to display for this dashboard layout. A layout has 0 or more pages."
},
"rowHeight": {
"type": "string",
"description": "The row height for layout rows."
},
"style": {
"type": "string",
"description": "The style for the layout. This is a JSON string. Example: {\"backgroundColor\":\"#ffffff\",\"gutterColor\":\"#f3f3f3\",\"cellSpacingX\":8,\"cellSpacingY\":8"
},
"version": {
"type": "double",
"description": "The API version of the dashboard layout."
}
},
"AnalyticsDashboardPage": {
"index": {
"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": {
"type": "string",
"description": "The label for the dashboard page."
},
"pageName": {
"type": "string",
"description": "The generated unique ID for the dashboard page."
},
"pageWidgets": {
"type": "AnalyticsDashPageWidget[]",
"description": "A list of dashboard page widgets. A page has 0 or more page widgets."
}
},
"AnalyticsDashPageWidget": {
"analyticsDashboardWidget": {
"type": "string",
"required": true,
"description": "The name of dashboard widget, defined in the list of widgets for the dashboard."
},
"colspan": {
"type": "string",
"description": "The column span for the widget on the page. This is a numeric value."
},
"column": {
"type": "string",
"description": "The column the widget is placed in on the page. This is a numeric value."
},
"row": {
"type": "string",
"description": "The row the widget is placed in on the page. This is a numeric value."
},
"rowspan": {
"type": "string",
"description": "The row span for the widget on the page. This is a numeric value."
}
},
"AnalyticsDashboardWidget": {
"analyticsDashboard": {
"type": "string",
"required": true,
"description": "The API name of the dashboard the widget is associated with."
},
"buttonWidgetDefs": {
"type": "AnalyticsButtonWidgetDef[]",
"description": "The definition for a button widget type. A dashboard has 0 or more button widgets. Required for button widget."
},
"containerWidgetDefs": {
"type": "AnalyticsContainerWidgetDef[]",
"description": "The definition for a container widget type. A dashboard has 0 or more container widgets. Required for container widget."
},
"dynamicTokens": {
"type": "AnlytDshbrdWdgtDynamicTkn[]",
"description": "The definition for a dynamic widget token. A dashboard has 0 or more dynamic tokens."
},
"filterWidgetDefs": {
"type": "AnalyticsFilterWidgetDef[]",
"description": "The definition for a filter widget type. A dashboard has 0 or more filter widgets. Required for filter widget."
},
"imageWidgetDefs": {
"type": "AnalyticsImageWidgetDef[]",
"description": "The definition for a image widget type. A dashboard has 0 or more image widgets. Required for image widget."
},
"label": {
"type": "string",
"description": "The label for the widget."
},
"metricWidgetDefs": {
"type": "AnalyticsMetricWidgetDef[]",
"description": "The definition for a metric widget type. A dashboard has 0 or more metric widgets. Required for metric widget."
},
"parameterWidgetDefs": {
"type": "AnalyticsParamWidgetDef[]",
"description": "The definition for a parameter widget type. A dashboard has 0 or more paramet widgets. Required for parameter widget."
},
"textWidgetDefs": {
"type": "AnalyticsTextWidgetDef[]",
"description": "The definition for a text widget type. A dashboard has 0 or more text widgets. Required for text widget."
},
"type": {
"type": "AnalyticsWidgetType (enumeration of type string)",
"required": true,
"description": "The widget type.Values are: button container extension filter image metric parameter text summary visualization"
},
"vizWidgetDefs": {
"type": "AnalyticsVizWidgetDef[]",
"description": "The definition for a visualization widget type. A dashboard has 0 or more visualization widgets. Required for visualization widget."
},
"widgetActions": {
"type": "AnalyticsAssetAction[]",
"description": "The actions for the widget. A widget has 0 or more text widgets."
},
"widgetName": {
"type": "string",
"description": "The API name of the widget. Use this for the analyticsDashboardWidget value in AnalyticsDashPageWidget."
}
},
"AnalyticsAssetAction": {
"actionType": {
"type": "AnalyticsActionType (enumeration of type string)",
"required": true,
"description": "The action type. Values are: flow navigate parameter recordaction"
},
"analyticsAssetVerson": {
"type": "string",
"optional": true,
"description": "The version of the Analytics asset the action is associated with."
},
"eventType": {
"type": "AnalyticsActionEventType (enumeration of type string)",
"required": true,
"description": "The action event type. Values are: click select"
},
"parameters": {
"type": "string",
"description": "The parameter for the action. This is a JSON string. Example: {\"destination\":{\"type\":\"url\",\"target\":\"www.salesforce.com\"}}"
},
"version": {
"type": "double",
"description": "The API version of the action."
}
},
"AnalyticsButtonWidgetDef": {
"parameters": {
"type": "string",
"description": "The parameters for the button widget. This is a JSON String.Example: {\"text\":\"Button\",\"alignmentX\":\"center\",\"alignmentY\":\"center\",\"fontSize\":16}"
}
},
"AnalyticsContainerWidgetDef": {
"parameters": {
"type": "string",
"description": "The parameters for the container widget. This is a JSON String.Example: {\"widgetStyle\":{\"backgroundColor\":\"#1295FF\",\"borderEdges\":[]}}"
}
},
"AnlytDshbrdWdgtDynamicTkn": {
"description": {
"type": "string",
"description": "The description for the dynamic token."
},
"label": {
"type": "string",
"description": "The label for the dynamic token."
},
"source": {
"type": "string",
"description": "The source object of the dynamic token."
},
"tokenName": {
"type": "string",
"description": "The name of the dynamic token."
},
"tokenSpec": {
"type": "string",
"description": "The specification for the dynamic token."
},
"type": {
"type": "AnalyticsDynamicTokenType",
"description": "The type of dynamic token. Valid values include query and insights."
}
},
"AnalyticsFilterWidgetDef": {
"initialValues": {
"type": "string",
"description": "The initial values for the filter."
},
"parameters": {
"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": {
"type": "string",
"description": "The data source to apply the filter to."
}
},
"AnalyticsImageWidgetDef": {
"parameters": {
"type": "string",
"description": "The parameters for the image widget. This is a JSON String."
},
"source": {
"type": "string",
"description": "The data source the image is associated with."
}
},
"AnalyticsMetricWidgetDef": {
"parameters": {
"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": {
"type": "string",
"description": "The semantic model the metric is associated with."
},
"source": {
"type": "string",
"description": "The data source the metric is associated with."
},
"sourceDeprecated": {
"type": "string",
"description": "Present if the data source the metric is associated with is deprecated."
},
"version": {
"type": "double",
"description": "The API version of the metric."
}
},
"AnalyticsParamWidgetDef": {
"initialValues": {
"type": "string",
"description": "The initial values for the parameters."
},
"parameters": {
"type": "string",
"description": "The parameters for the filter widget. This is a JSON String.Example: {\"parameterName\":\"AccountParameter_prm\",\"isLabelHidden\":false}"
},
"source": {
"type": "string",
"description": "The data source the parameters are associated with."
}
},
"AnalyticsTextWidgetDef": {
"parameters": {
"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": {
"analyticsVisualization": {
"type": "string",
"description": "The API name of the visualization."
},
"analyticsVizVersion": {
"type": "string",
"description": "The version of the visualization."
},
"parameters": {
"type": "string",
"description": "The parameters for the filter widget. This is a JSON String.Example: {\"legendPosition\":\"Right\",\"receiveFilterSource\":{\"filterMode\":\"all\",\"widgetIds\":[]}}"
}
}
},
"wsdl_segment": "```xml\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of an AnalyticsDashboard component.",
"code": "\n\n My_Workspace\n A dashboard\n \n My_Dashboard\n 36\n default\n 1200\n \n \n 0\n \n e412bc11-d43b-4fba-ab44-b31bb842b49a\n \n visualization_1\n 11\n 1\n 2\n 10\n \n \n button_1\n 9\n 13\n 8\n 2\n \n \n container_1\n 11\n 23\n 2\n 10\n \n \n text_2\n 9\n 13\n 5\n 2\n \n \n metric_1\n 11\n 1\n 13\n 10\n \n \n list_4\n 9\n 13\n 13\n 2\n \n \n list_1\n 9\n 13\n 2\n 2\n \n \n 24\n \n \n My Dashboard\n \n 64.0\n \n My_Dashboard\n visualization\n \n New_Visualization\n {"legendPosition":"Right","receiveFilterSource":{"filterMode":"all","widgetIds":[]}}\n \n visualization_1\n \n \n My_Dashboard\n \n {"text":"Button","alignmentX":"center","alignmentY":"center","fontSize":16}\n \n button\n \n navigate\n click\n {"destination":{"type":"url","target":"www.salesforce.com"}}\n 63.0\n \n button_1\n \n \n My_Dashboard\n \n {"widgetStyle":{"backgroundColor":"#1295FF","borderEdges":[]}}\n \n container\n container_1\n \n \n My_Dashboard\n \n {"content":[{"attributes":{"color":"#000000","size":"12px"},"insert":"full dashboard"},{"attributes":{"align":"left"},"insert":"\\n"}]}\n \n text\n text_2\n \n \n My_Dashboard\n \n {"metricOption":{"layout":{"componentVisibility":{"details":true,"title":true,"value":true,"comparison":true,"chart":true,"insights":false}},"sdmApiName":"AccountModel","sdmId":"2SMxx0000004CFUGA2"},"receiveFilterSource":{"filterMode":"all","widgetIds":[]}}\n AccountMetric_mtc\n \n metric\n metric_1\n \n \n My_Dashboard\n \n null\n {"receiveFilterSource":{"filterMode":"all","widgetIds":[]},"filterOption":{"objectName":"Account","fieldName":"Account_Id","dataType":"Text","selectionType":"multiple"},"isLabelHidden":false}\n AccountModel\n \n \n filter\n list_4\n \n \n My_Dashboard\n \n \n null\n {"parameterName":"AccountParameter_prm","isLabelHidden":false}\n AccountModel\n \n parameter\n list_1\n \n \n \n \n \n AnalyticsDashboard\n Created\n My_Workspace\n \n"
}
]
}