APIs are executed on the server


Tableau supports a robust extension framework for deep and complex company integration and for embedded analytics solutions. The expansion options range from the automation of administrative tasks and the integration of extensive visualization to company portal applications that can be used to transfer data from any data source into a format supported by Tableau and enable system automation with an increasing number of standards-based APIs. For more information, see IT Tools and the Tableau Developer Program.


Tableau's REST API lets you create, read, update, delete, and manage Tableau Server and Tableau Online entities programmatically over HTTP. The API provides easy access to the functionality behind the data sources, projects, workbooks, site users, and sites on Tableau Server or Tableau Online. You can use this access to create your own custom applications or define interactions with Tableau resources via script.

Hyper API

Tableau Server provides direct support for and connection to a large number of data sources. However, you can also preprocess or access and compile data from other applications before working with it in Tableau. The Tableau Hyper API includes a number of features that you can use to automate interactions with Tableau extract (.hyper) files, such as the following, for Tableau 10.5 and later and for Tableau Online:

  • Create extract files for data sources that are not currently supported by Tableau
  • Automate custom ETL (extract, transform, and load) operations, such as: For example, implementing updates with a rolling time window or custom incremental updates
  • Retrieving data from an extract file

In addition to supporting all the features of the previous Extract API 2.0 for creating extract files, the Hyper API offers access to new features. You can create, read, update and delete data in .hyper files while using the full speed of Hyper for creating and updating extract files. Data from CSV files can be loaded directly without special programming. With the power of SQL to interact with data in .hyper files, the API provides methods for executing any SQL commands on .hyper files.

Web data connector

You can use the Tableau Web Data Connector SDK to create connectors for additional data sources with Javascript and HTML in Tableau Server and Tableau Online. Web data connectors (WDCs) are web pages that provide an HTTP data connection for data sources that don't already have a connector in Tableau. WDCs allow users to connect to almost any data accessible over the Internet and create extracts for their workbooks. Data sources for a WDC can be web services, JSON data, REST APIs, and other sources available over HTTP or HTTPS. Users can create their own WDC or use connectors created by others. For more information, see Use a Web Data Connector with Tableau Server and Tableau Online. For more information about community connectors, see Web Data Connector Forum.

JavaScript API

With Tableau's JavaScript API, you can fully integrate Tableau visualizations into your own web applications. The API uses an event-based architecture with which you can flexibly and comprehensively control user actions in Tableau visualizations. For example, your company can link various business unit applications and dashboards with a web portal. A uniform user interface for all applications is recommended to simplify user operation. The JavaScript API lets you create buttons and other controls in your preferred style that can be used to access elements of a Tableau dashboard.

Extensions API

Tableau's Extensions API enables developers to create dashboard extensions that allow users to integrate data from other applications and use them interactively directly in a Tableau dashboard. Such extensions include, for example, a write-back function, user-defined interactive interfaces and the integration of third-party products. Dashboard extensions run in custom dashboard zones. You can interact with the rest of the dashboard using the Tableau Extensions API. The available third-party extensions are listed in the Extensions Gallery. In order to publish on Tableau Server, extensions must be added to the allow list (Windows | Linux). Tableau Server administrators can enable per server or per site, depending on your code review and security rating. For information about Tableau Online, see Manage Dashboard Extensions in Tableau Online.

Document API

The Document API provides a way to modify Tableau workbooks and data source XML. You can use Python to create a template workbook in Tableau and then easily deploy it to multiple servers, update data sources and connections, and evaluate fields from a data source.


Tableau Server includes a set of management services called Tableau Services Manager (TSM). This documentation describes the TSM API (0.5 alpha version) which is under development. It allows you to perform a wide range of tasks, such as: These include starting and stopping Tableau Server, viewing the status of services and nodes, backing up and restoring Tableau Server, making changes to the configuration and topology, changing port assignments for services, and creating archives for log files.

Metadata API

The Tableau Metadata API can be used to query tables, data sources, workbooks and sheets in Tableau Server and Tableau Online. This fast and flexible API includes common attributes such as name, host name and URI as well as type-specific information such as field data types and certification. You can also use the API to create related elements such as B. Query tables and columns used by a particular data source. In addition to the Metadata API, the Tableau REST API also contains metadata methods. See the topic Metadata Methods for an explanation.

Bootstrap for mobile apps

You can use Bootstrap for Mobile Apps (Mobile App Bootstrap, MAB) to develop custom apps for mobile devices. The MAB is an exemplary open source application for mobile devices that shows how to connect to Tableau Server and stay logged in, embed Tableau content and make Tableau content available with a click using the Tableau JavaScript API. For more information, see Bootstrap for Mobile Apps - React Native, Bootstrap for Mobile Apps - Cordova, and Bootstrap for Mobile Apps - Objective-C.

Webhooks API

Webhooks are a common way to trigger automated workflows that respond to events in your Tableau deployment. You can create workflows with Tableau Server 2019.4 and higher, as well as with Tableau Online. For more information, see the webhooks documentation and examples.