Tableau CRM REST API Developer Guide
jNewer Version Available
Dashboards List Resource
- Resource URL
-
1/wave/dashboards - Formats
- JSON
- Available Version
- 36.0
- Available Components
-
- Aura — <wave:sdk> listDashboards()
- HTTP Methods
- GET POST
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version folderId ID Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder. Optional 36.0 ids String Filters the results to include only the dashboards with the specified ids. Optional 52.0 mobileOnly Boolean Filters the results for mobile enabled dashboards only. Optional 41.0 page String A generated token that indicates the view of dashboards to be returned. Optional 36.0 pageSize Integer The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. Optional 36.0 q String Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. Optional 36.0 scope ConnectWaveScopeTypeEnum The type of scope to be applied to the returned collection. Valid values are: - CreatedByMe
- Mru (Most Recently Used)
- SharedWithMe
Optional 38.0 sort ConnectWaveSortOrderTypeEnum The type of sort order to be applied to the returned collection. Valid values are: - App
- CreatedBy
- CreatedDate
- LastModified
- LastModifiedBy
- Mru (Most Recently Used, last viewed date)
- Name
- Type
Optional 38.0 templateApiName String Filters the results to include only a collection of dashboards created from a specific application template Optional 38.0 type ConnectWaveAssetTypeEnum The asset type. The default type is Dashboard. Valid types are: - Collection
- Component
- Dashboard
- DashboardSnapshot
- DataConnector
- DataPoolEntity
- DataPoolEntityVersion
- Dataflow
- DataflowJob
- DataflowJobNode
- Dataset
- DatasetShard
- DatasetVersion
- ExternalData
- Folder
- Lens
- LightningComponent
- Recipe
- RecipeModel
- ReplicatedDataset
- Story
- Widget
- Workflow
Optional, Small, 36.0 36.0 - GET Response Body
-
Property Name Type Description Filter Group and Version Available Version dashboards DashboardRepresentation[] A collection of Tableau CRM dashboards. Small, 36.0 36.0 nextPageUrl String The URL to retrieve the next page of contents in the collection. Small, 36.0 36.0 totalSize Integer The total count of the elements in the collection, including all pages. Medium, 36.0 36.0 url String The URL to retrieve the collection. Small, 36.0 36.0 - POST Request Body (DashboardInputRepresentation)
-
DashboardInputRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear in DashboardInputRepresentation alongside the properties defined explicitly in the following table.
Parameter Name Type Description Required or Optional Available Version currentHistoryId String The current saved history id to display for the dashboard. Optional 44.0 dateVersion Integer The version of dates used by the dashboard. Valid values are: - 1
- 2
Optional 44.0 folder AssetReferenceInputRepresentation The folder in which this dashboard is stored. Required for POST, optional for PATCH 44.0 historyLabel String A history label to tag the dashboard version being saved. Optional 44.0 mobileDisabled Boolean Indicates whether the dashboard is disabled for mobile or not. Optional 41.0 state DashboardStateInputRepresentation The state of the dashboard. Required for POST, optional for PATCH 36.0 type ConnectWaveAssetTypeEnum The asset type. The default type is Dashboard. Valid types are: - Collection
- Component
- Dashboard
- DashboardSnapshot
- DataConnector
- DataPoolEntity
- DataPoolEntityVersion
- Dataflow
- DataflowJob
- DataflowJobNode
- Dataset
- DatasetShard
- DatasetVersion
- ExternalData
- Folder
- Lens
- LightningComponent
- Recipe
- RecipeModel
- ReplicatedDataset
- Story
- Widget
- Workflow
Optional 44.0 xmd XmdInputRepresentation The asset XMD of the dashboard. Optional 44.0 visibility ConnectWaveAssetVisibilityType Indicates whether the asset is hidden from users with view access or not. Valid values are: - All (Show all assets)
- Limited (Hide assets from viewers with view access)
Optional 51.0 - POST Response Body (DashboardRepresentation)
-
Property Name Type Description Filter Group and Version Available Version allowPreview Boolean Indicates whether this dashboard is available for preview. Small, 36.0 36.0 currentHistoryId String The current saved history to display for the dashboard. If null, the latest dashboard is displayed Small, 44.0 44.0 datasets AssetReferenceRepresentation[] The list of datasets used to create this dashboard. Small, 36.0 36.0 dateVersion Integer The version of dates used by the dashboard. Valid values are: - 1
- 2
Small, 44.0 44.0 files LensFileRepresentation[] The list of files used to create this dashboard. Medium, 36.0 36.0 filesUrl String The URL for the files associated with the dashboard. Small, 36.0 36.0 folder AssetReferenceRepresentation[] The folder that contains this dashboard. Small, 36.0 36.0 historiesUrl String The URL for the dashboard histories associated with this dashboard. Small, 44.0 44.0 mobileDisabled Boolean Indicates whether the dashboard is disabled for mobile or not. Small, 41.0 41.0 refreshDate Date The date of the most recent current dataset that is used by the dashboard, in ISO8601 date format. Small, 36.0 36.0 state DashboardStateRepresentation The state of the dashboard Big, 36.0 36.0 visibility ConnectWaveAssetVisibilityType Indicates whether the asset is hidden from users with view access or not. Valid values are: - All (Show all assets)
- Limited (Hide assets from viewers with view access)
Small, 51.0 51.0