What's New in the REST API

This topic summarizes changes made to the REST API for Tableau Server and Tableau Online. All versions include updated documentation.

What's new in REST API 3.13 for Tableau Server 2021.3 and Tableau Online

What's new in REST API 3.12 for Tableau Server 2021.2 and Tableau Online

What's new in REST API 3.11 for Tableau Server 2021.1 and Tableau Online

Added in REST API 3.10 for Tableau Server 2020.4 and Tableau Online

Added in REST API 3.9 for Tableau Server 2020.3 and Tableau Online

Added in REST API 3.8 for Tableau Server 2020.2 and Tableau Online

Added in REST API 3.7 for Tableau Server 2020.1 and Tableau Online

  • Administrators can now use Get Site or Update Site to view the Tiered Capacities (maximum users of a site for each license type or role) configured for a site. For a site that has user-based licensing with no licensing limits set by its administrator, maximums for Creator, Explorer, and Viewer licensed users are determined by the activated licenses for each role on the site. On-premise server administrators can set the Tiered Capacity attributes to lower the user limits on any or all of the license types using Create Site or Update Site.
  • You can now get the groups a site user belongs to with a REST API call.
  • You can now manage view recommendations using the REST API. Use Get View Recommendations, to get a current list of recommended views. Use Hide a View Recommendation, to hide a view from the list of recommended views. Use Unhide a View Recommendation, to hide a view from the list of recommended views.

Added in REST API 3.6 for Tableau Server 2019.4

Added in REST API 3.5 for Tableau Server 2019.3

  • You can now manage extract encryption at rest. To learn more, see Extract Encryption Methods.
  • You can query or update metadata indexed by or surfaced through Tableau Catalog. To learn more, see Metadata Methods.
  • With administrator permissions, you can now globally enable or disable attachments for subscriptions to workbooks and views in a site. You can read the enablement status in response bodies for Query Sites, Query Site, Create Site, and Update Sites requests. Enablement state can be set during Create Site and Update Site calls.
  • Users can now determine the file format (.png and/or .pdf) of the attachments for a subscribed workbook or view. Attachment settings can be viewed in response bodies for Query Subscriptions, Query Subscriptions, Create Subscription, and Update Subscription requests. Attachment format can be set using Create Subscription or Update Subscription requests.

Added in REST API 3.4 for Tableau Server 2019.2

  • You can now use the maxAge parameter of the Query View Image method to set or get the limit for the age of a cached image of a view in your workbook. When that limit is passed accessing a view image will refresh the cache with a current image.
  • You can now use the public parameter of the Get Data-Driven Alert method to set or get whether users who do not own an alert can discover and subscribe to it.
  • You can now use the Download Workbook PDF method to download a PDF containing the views in the a workbook.

Added in REST API 3.3 for Tableau Server 2019.1

Added in REST API 3.2 for Tableau Server 2018.3

Added in REST API 3.1 for Tableau Server 2018.2

  • You can now move projects within the project hierarchy. You can now move projects to the top of the project hierarchy when using the Update Project method by passing an empty string ("") to the parentProjectId attribute of the <project> element.
  • You can now manage and cancel jobs. The following methods have been updated or added in the 2018.2 release to improve the management of jobs:
    • Added: The Query Jobs method returns a list of all active jobs on the specified site.
    • Added: The Cancel Job method allows you to cancel a job that is pending or in-progress.
    • Updated: The Query Job method now allows you to query jobs used to run workbook subscriptions or view subscriptions.
  • You can now manage which projects are included on a user's list of favorites, and query a list of favorites that includes favorite projects using the following methods that have been updated or added in the 2018.2 release:
  • You can now publish data sources asynchronously by adding the asJob parameter to the Publish Data Source request URI. To learn more, see Publishing workbooks and data sources asynchronously.

Added in REST API 3.0 for Tableau Server 2018.1

Added in REST API 2.8 for Tableau Server 10.5

Added in REST API 2.7 for Tableau Server 10.4

Added in REST API 2.6 for Tableau Server 10.3

Added in REST API 2.5 for Tableau Server 10.2

  • New method for getting views and workbooks that a user has marked as favorites. For more information, see Get Favorites for User.

  • New method for getting images for views. You can get images in standard resolution and high resolution. For more information, see Query View Image.

  • A new feature you can use to control the type and amount of data you want returned from some methods. You can qualify the return values based upon the type of resource (for example, workbooks or views), and fields (names, ids, and tags). You can include multiple fields in a request. You can combine this feature with filtering and sorting. For example, you can return the names of the all workbooks that were updated after a certain date. For more information, see Using Fields in the REST API.

  • Support for JSON in the REST API. You can set Content-Type and Accept headers to application/json or application/xml to control whether you want send requests or receive responses in XML or JSON. For more information, see Fundamentals of the Tableau Server REST API and REST API Example Requests.

  • Support for Cross Origin Resource Sharing (CORS). You can now enable CORS on Tableau Server to allow cross-orgin requests to the REST API, making it easier to use the API with JavaScript. For more information, see Enabling CORS on Tableau Server for the REST API.

  • Download workbooks or data sources without including the extracts. You can now download a data source or workbook without the large payload of the extract file by simply appending ?includeExtract=False to the URI. For more information, see the following methods:

  • New option to publish the Tableau provided sample workbooks when you create or update a project. For more information see the following methods:

Added in REST API 2.4 for Tableau Server 10.1

  • The Server Info method returns information about the version of Tableau Server and the version of the REST API compatible with the server.

  • Site administrators can now use the method to Query Workbooks for a User. Previously, only server administrators had permission to use this method.

  • Filtering and sorting can be performed on the following additional methods:

Added in REST API 2.3 for Tableau Server 10.0

Added in REST API 2.2 for Tableau Server 9.3

Added in REST API 2.1 for Tableau Server 9.2

Added in in REST API 2.0.1 for Tableau Server 9.1

  • Updated namespace. The namespace and schema locations that are returned in the <tsResponse> blocks of REST API responses have been changed from tableausoftware.com to tableau.com.


Thanks for your feedback!