Data labels, introduced in the REST API with Tableau Server 2022.3 and Tableau Cloud June 2022, are metadata that you attach to assets. Using the data label methods, you can manage both data quality warnings and certifications in a unified way.

All label operations except those related to the certification of data sources require Catalog to be enabled. Catalog requires a Data Management license.

You can attach labels to the following Tableau content or external assets:

  • Databases
  • Tables
  • Columns - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3)
  • Data sources
  • Flows
  • Virtual connections
  • Virtual connection tables

Each data label has a category, a value, and a message. It can be active or inactive, elevated or not, and it has an owner (the last person to create or update the label).

Category

A data label can belong to one of the following categories:

Value

A data label has a value, the range of which depends on the category. The corresponding categories and their possible values are as follows:

Label category Valid label values
certification certified
warning warning
deprecated
stale
maintenance
sensitive_data
extract_refresh_failure
flow_run_failure

Values in the certification category

The certification category has one valid value: certified. It corresponds to certification as described at "Use Certification to Help Users Find Trusted Data" in the Tableau Server(Link opens in a new window) and Tableau Cloud(Link opens in a new window) Help, and in the certification methods listed in Metadata Methods.

Values in the warning category

The warning category values correspond to the warnings mentioned in "Set a Data Quality Warning" in the Tableau Server(Link opens in a new window) and Tableau Cloud(Link opens in a new window) Help, and in the data quality warnings methods listed in Metadata Methods.

Five of the warning category values correspond to data quality warnings:

  • warning : Warning
  • deprecated : Deprecated
  • stale : Stale data
  • maintenance : Under maintenance
  • sensitive_data : Sensitive data

Two of the warning category values correspond with monitoring quality warnings:

  • extract_refresh_failure : Extract Refresh Monitoring
  • flow_run_failure : Flow Run Monitoring

Once a monitoring quality warning has been triggered and the warning is attached to an asset, the warning can be seen using the data labels methods. However, you can’t create, update, or delete the monitoring quality warnings using the data labels methods. (You can’t create, update, or delete monitoring quality warnings using other methods either.) See also "How to set a monitoring quality warning" in the Tableau Server(Link opens in a new window) and Tableau Cloud(Link opens in a new window) Help and the quality warning trigger methods in Metadata Methods.

Active attribute

Data labels can be active or inactive.

An active data label can affect the treatment or display of the asset it’s attached to. For example, in the web interface, a database might show a certified icon, or a datasource might show a data quality warning indicating the data is stale.

An inactive data label does not affect the treatment or display of the asset it’s attached to. No special icons or indicators will be attached to the asset. The attributes of an inactive label are not removed, but they also do not affect the asset while the data label is inactive.

Elevated attribute

Data labels can be elevated. An elevated data label may be displayed differently in the Tableau Server or Tableau Cloud web interface. For example, in the web interface, an elevated warning will be seen as a high visibility data quality warning.

Certifications can also be elevated, but this has no effect on the treatment or display of the certification, and there is no method to change the elevated status of certifications in the web interface.

Owner

The user who created or last updated the data label is its owner.

Permissions

Permissions required to view, change, and delete labels are as listed below:

  • To view a data label, you must have read permissions on the associated asset.
  • To create, edit, or delete a warning label, you must have write permission on the associated asset.
  • To create, edit, or delete a certification label for an asset in a project, you must be a Tableau Server site or server admin, a Tableau Cloud site admin, a project leader for the project the asset is in, or the project owner for the project the asset is in.
  • To create, edit, or delete a certification label for an asset not in a project, you must have the change permissions permission on the associated asset.

Webhooks

You can create webhooks that trigger when a data label is created, updated, or deleted. For information, see "Label Events" in Webhook Events and Payloads(Link opens in a new window).


Thanks for your feedback!