Added Tableau Pulse MetricDefinition objects and supporting shortcuts to the schema.
Tableau Server: Lens objects and supporting shortcuts are retired. No lens or lens properties are returned from queries. (Removed from Tableau Server in this version. Already removed from Tableau Cloud in February 2023.)
Tableau Server: Metrics objects and supporting shortcuts are retired. No metrics or metrics properties are returned from queries. (Removed from Tableau Server in this version. Already removed from Tableau Cloud in February 2023.)
Tableau Cloud February 2024
Retired
Lens objects and supporting shortcuts are retired. No lens or lens properties are returned from queries.
Metrics objects and supporting shortcuts are retired. No metrics or metrics properties are returned from queries.
Tableau Cloud October 2023 / Server 2023.3
Added
Tableau Server: Added Metadata API request throttling. Requests that exceed the rate threshold receive a RATE_EXCEEDED error. (New for Tableau Server in this version. Already added to Tableau Cloud in June 2023.)
The Metadata API now respects credentials tokens that were obtained via a JSON web token (JWT) and Tableau connected apps. You still use the REST API Sign In method to get a credentials token, but now you can use a JWT in the REST API Sign In request. For information, see Sign in using a JSON web token (JWT).
Tableau Cloud June 2023
Added
Added Metadata API request throttling. Requests that exceed the rate threshold receive a RATE_EXCEEDED error.
Types that implement the Field interface can be filtered by name using a text filter. The filter will return fields where any word in the field name begins with the specified case-insensitive text.
Example:
query FilteredFields {
publishedDatasources {
name
fields (filter: {text: "age"}) {
id
name
}
}
}
Tableau Cloud March 2023 / Server 2023.1
Changed
The virtualConnection object’s connectionType attribute now returns ‘null’, and may be removed in a future release. Use ‘connectionType’ of ‘upstreamDatabases’ instead. (New for Tableau Server 2023.1. Changed in Tableau Cloud in December 2022)
The DataQualityWarning.asset and DataQualityCertification.asset edges now point to the CanHaveLabels interface instead of the Warnable and Certifiable interfaces. This change was made to move the schema towards a more general interface that works with all labels. Referencing edge names that exist on the Warnable and Certificable interfaces but do not exist on the CanHaveLabels interface will produce an error. For information on the error and adjusting queries that may be affected, see “Other Errors”, in the Common Errors topic. The list of affected edges is:
Warnable.hasActiveWarning
Warnable.dataQualityWarnings
Warnable.dataQualityWarningsConnection
Certifiable.isCertified
Certifiable.dataQualityCertifications
Certifiable.dataQualityCertificationsConnection
Tableau Cloud December 2022
Changed
The virtualConnection object’s connectionType attribute now returns ‘null’, and may be removed in a future release. Use ‘connectionType’ of ‘upstreamDatabases’ instead.
Tableau Cloud October 2022 / Server 2022.3
Added
Modified existing data quality warning shortcuts to support data quality warnings on columns.
Tableau Cloud June 2022
Added
Added lens objects and supporting shortcuts to the schema.
Added new fields to existing objects:
Object
New fields
tableauSites
createdAt
workbooks
projectLuid
datasources
createdAt, updatedAt
flows
createdAt, updatedAt
virtualConnections
createdAt, updatedAt
Tableau Cloud March 2022 / Server 2022.1
Added
Added the virtualConnection and virtualConnectionTable objects and supporting shortcuts to the schema.
Tableau Cloud December 2021 / Server 2021.4
Changed
Some shortcuts were changed to make the definitions of “upstream” and “downstream” more consistent throughout the schema.
The Column type’s upstreamTables and downstreamTables shortcuts no longer include the table that contains the column. Use Column.table to find information about the containing table instead.
The Table type’s upstreamDatabases shortcut no longer includes the database that contains the table. Use ... on DatabaseTable {database} instead.
The Workbook type’s downstreamOwners field no longer includes the owner of the workbook. Use Workbook.owner to find information about the workbook owner instead.
Older versions
The Metadata API was officially released in Tableau Server 2019.3 and Tableau Cloud in September of 2019. This document tracks Metadata API changes starting with 2021.4.