--- schema_version: "1" id: 67884d2db7caea75c0889cbbdd86e024cd69a36a48f636ae8966321dbea4881e title: Label collection: tableau version: next locale: en-us portal_url: https://docs.salesforce.com/tableau/next/en-us/api/metadata_api/reference/label.doc.md canonical_url: https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/label.doc.html source_site: help.tableau.com content_type: documentation content_hash: 2466fec9b1a1dfb21ec8113aa5669e436defefa5e3c62d9ab5e62df6d84202d5 --- _menu_ Types 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) GraphQL Schema definition ` - interface Label { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/id.doc.html)! - # User who last updated this label - author: [TableauUser](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser.doc.html) - # Name of the user who last updated this label - authorDisplayName: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # Vizportal ID of this label, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html)! - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html)! - # True if the label is active - isActive: [Boolean](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if the label is elevated - isElevated: [Boolean](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/boolean.doc.html)! - # Value of the label - value: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html)! - # Category of the label - category: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html)! - # Message of the label - message: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # Time the label was created - createdAt: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the label was last updated - updatedAt: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html)! - # The asset that contains the label - asset: [CanHaveLabels](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/canhavelabels.doc.html) - } ` ## [_link_](#require-by) Require by - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [CloudFile_A cloud file connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Column_GraphQL type for a table column_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databaseserver.doc.html "DatabaseServer - A database server connection") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [DataCloud_A Data Cloud connection \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](datacloud.doc.html "DataCloud - A Data Cloud connection *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [DataQualityCertification_A data quality certification associated with a content item_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitycertification.doc.html "DataQualityCertification - A data quality certification associated with a content item") - [DataQualityWarning_A data quality warning associated with a content item_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarning.doc.html "DataQualityWarning - A data quality warning associated with a content item") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [GenericLabel_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](genericlabel.doc.html "GenericLabel - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [LabelsConnection_Connection Type for Label_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/labelsconnection.doc.html "LabelsConnection - Connection Type for Label") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [MetricDefinition_A Tableau Pulse metric definition. \*Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.\*_](metricdefinition.doc.html "MetricDefinition - A Tableau Pulse metric definition. *Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource.doc.html "PublishedDatasource - A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [VirtualConnectionTable_A table in a virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnectiontable.doc.html "VirtualConnectionTable - A table in a virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [WebDataConnector_A web data connector_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") - [Workbook_Workbooks 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)._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook.doc.html "Workbook - Workbooks 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).")