OBJECT
Dashboard
dashboard contained in a published workbook.
link GraphQL Schema definition
- type Dashboard implements View, Taggable {
- # Unique identifier used by the metadata API. Not the same as the numeric ID used
- # on server
- ID! :
- # Name shown in server and desktop clients
- String :
- # Unique ID for the dashboard generated for and stored within the workbook,
- # survives renames, and is used for internal processes
- String :
- # Locally unique identifier used for the REST API on the Tableau Server (Blank if
- # worksheet is hidden in Workbook)
- String! :
- # Server path to dashboard
- String :
- # Time the dashboard was created
- DateTime! :
- # Time the dashboard was updated
- DateTime! :
- # Index of view; the order it appears in the workbook
- Int :
- # Tags associated with the view
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- Tag_Filter, : TagSortOrder): [Tag!]! ( :
- # Tags associated with the view
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Tag_Filter, :
- TagSortOrder :
- ): TagsConnection
- # Sheets referenced by this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Sheet_Filter, :
- SheetSortOrder, :
- PermissionMode :
- ): [Sheet!]!
- # Sheets referenced by this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Sheet_Filter, :
- SheetSortOrder, :
- PermissionMode :
- ): SheetsConnection
- # AskDataExtensions that are added into this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- AskDataExtension_Filter, :
- AskDataExtensionSortOrder, :
- PermissionMode :
- ): [AskDataExtension!]!
- # AskDataExtensions that are added into this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- AskDataExtension_Filter, :
- AskDataExtensionSortOrder, :
- PermissionMode :
- ): AskDataExtensionsConnection
- # Sheet field instances used by the sheets referenced by this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Field_Filter, :
- FieldSortOrder, :
- PermissionMode :
- ): [Field]
- # Sheet field instances used by the sheets referenced by this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Field_Filter, :
- FieldSortOrder, :
- PermissionMode :
- ): FieldsConnection
- # Data quality warnings upstream from this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- PermissionMode :
- ): [DataQualityWarning!]!
- # Data quality warnings upstream from this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- PermissionMode :
- ): DataQualityWarningsConnection
- # Labels upstream from this dashboard Available in Tableau Cloud March 2023 /
- # Server 2023.1 and later.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Label_Filter, :
- LabelSortOrder, :
- PermissionMode :
- ): [Label!]!
- # Labels upstream from this dashboard Available in Tableau Cloud March 2023 /
- # Server 2023.1 and later.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Label_Filter, :
- LabelSortOrder, :
- PermissionMode :
- ): LabelsConnection
- # The Metrics that reference this View
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Metric_Filter, :
- MetricSortOrder, :
- PermissionMode :
- ): [Metric]
- # The Metrics that reference this View
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Metric_Filter, :
- MetricSortOrder, :
- PermissionMode :
- ): MetricsConnection
- # The workbook that contains this view
- Workbook :
- # The databases that are upstream of this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- Database_Filter, :
- DatabaseSortOrder :
- ): [Database]
- # The databases that are upstream of this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Database_Filter, :
- DatabaseSortOrder :
- ): DatabasesConnection
- # The data sources that are upstream of this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- Datasource_Filter, :
- DatasourceSortOrder :
- ): [Datasource]
- # The data sources that are upstream of this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Datasource_Filter, :
- DatasourceSortOrder :
- ): DatasourcesConnection
- # The tables that are upstream of this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- Table_Filter, : TableSortOrder): [Table] ( :
- # The tables that are upstream of this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Table_Filter, :
- TableSortOrder :
- ): TablesConnection
- # The fields that are upstream of this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- Field_Filter, : FieldSortOrder): [Field] ( :
- # The fields that are upstream of this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Field_Filter, :
- FieldSortOrder :
- ): FieldsConnection
- # The Lenses that are upstream of this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- Lens_Filter, : LensSortOrder): [Lens] ( :
- # The Lenses that are upstream of this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Lens_Filter, :
- LensSortOrder :
- ): LensesConnection
- # The columns that are upstream of this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- Column_Filter, : ColumnSortOrder): [Column] ( :
- # The columns that are upstream of this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Column_Filter, :
- ColumnSortOrder :
- ): ColumnsConnection
- # The flows that are upstream of this dashboard
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- Flow_Filter, : FlowSortOrder): [Flow] ( :
- # The flows that are upstream of this dashboard
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Flow_Filter, :
- FlowSortOrder :
- ): FlowsConnection
- }
link Require by
- AskDataExtensionAskDataExtensions to base Tableau functionality.
- BinFieldGraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html
- CalculatedFieldGraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html
- CloudFile cloud file connection
- ColumnGraphQL type for a table column
- ColumnFieldColumnFields are a type of field which directly connects to a column in some type of table.
- CombinedFieldGraphQL type for a combined field. Combined fields concatanate fields together into one string.
- CombinedSetFieldGraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html#Combine
- CustomSQLTable table that represents the result of evaluating a custom SQL query. These "tables" are owned by the Tableau data source (embedded or published) which contains the SQL query, so they only exist within that data source.
- DashboardsConnectionConnection Type for Dashboard
- Database database containing tables
- DatabaseServer database server connection
- DatabaseTable table that is contained in a database
- DatasourceRoot GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm
- DatasourceFieldGraphQL type for a data source field. Data source fields can only exist in embedded data sources which connect to a published data source. A data source field is an embedded data source's 'layered' representation of a field that already exists in the published data source and is mostly a copy of the field in the published data source. Data source fields can get their own descriptions and renames local to the embedded data source, but cannot otherwise be modified in the embedded data source.
- EmbeddedDatasource data source embedded in a workbook
- FieldBase GraphQL type for a field
- File file connection
- FlowFlows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.
- FlowColumnOutputFieldColumn output field implementation
- FlowFieldOutputFieldField output field implementation
- FlowOutputField wrapper for an output field contained in a published flow.
- GroupFieldGraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html
- HierarchyFieldGraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs_hierarchies.html
- LensLenses are curated, embeddable Ask Data experiences. *Available in Tableau Cloud June 2022 / Server 2022.3 and later.*
- PublishedDatasource Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.
- QueryQuery root for Metadata GraphQL interface
- SetFieldGraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html
- Sheet sheet contained in a published workbook.
- Table table containing columns
- VirtualConnectionVirtual connections are sharable central access points to data. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*
- VirtualConnectionTableA table in a virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*
- WebDataConnector web data connector
- WorkbookWorkbooks are used to package up Tableau visualizations (which are called "sheets" in the Metadata API) and data models (which are called "embedded data sources" when they are owned by a workbook).