INTERFACE
Label
A label that can be attached to assets.
Available in Tableau Cloud March 2023 / Server 2023.1 and later.
link GraphQL Schema definition
- interface Label {
- # Unique identifier used by the metadata API. Not the same as the numeric ID used
- # on server
- : ID!
- # User who last updated this label
- : TableauUser
- # Name of the user who last updated this label
- : String
- # Vizportal ID of this label, for use in client-to-server communications
- : String!
- # Locally unique identifier used for the REST API on the Tableau Server
- : String!
- # True if the label is active
- : Boolean!
- # True if the label is elevated
- : Boolean!
- # Value of the label
- : String!
- # Category of the label
- : String!
- # Message of the label
- : String
- # Time the label was created
- : DateTime!
- # Time the label was last updated
- : DateTime!
- # The asset that contains the label
- : CanHaveLabels
- }
link Require by
- CanHaveLabelsA content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*
- CloudFileA cloud file connection
- ColumnGraphQL type for a table column
- DashboardA dashboard contained in a published workbook.
- DatabaseA database containing tables
- DatabaseServerA database server connection
- DatabaseTableA table that is contained in a database
- DataCloudA Data Cloud connection *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*
- DataQualityCertificationA data quality certification associated with a content item
- DataQualityWarningA data quality warning associated with a content item
- EmbeddedDatasourceA data source embedded in a workbook
- FileA file connection
- FlowFlows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.
- GenericLabelA label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*
- LabelsConnectionConnection Type for Label
- MetricMetrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*
- MetricDefinitionA Tableau Pulse metric definition. *Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.*
- PublishedDatasourceA Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.
- SheetA sheet contained in a published workbook.
- TableauUserUser on a site on Tableau server
- ViewA view contained in a published workbook. Views can be sheets or dashboards.
- VirtualConnectionA virtual connection. *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.*
- WebDataConnectorA 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).