Automation

Automate tedious tasks and programmatically manage Tableau Server content, including workbooks, data sources, and users.

REST API

Automation

Programmatic access to work with your content, users, sites and more.

Document API

Automation

Programmatically modify Tableau files.

REST API & Tableau Server Client Library

Part of Tableau Server and Tableau Online, the REST API enables programmatic access to work with your content, users, sites and more.

Use Cases:

  • Automating tasks like managing users, groups, sites
  • Updating workbooks or datasources
  • Integrating Tableau content with a custom app or portal

Level of Support:  Tableau-supported

REST API Resources:

Tableau Server Client Library Resources:

Document API

Programmatically modify Tableau files (TDS(X), TWB(X)).

Use Cases: Create and deploy templates or migrate workbooks from test to production data sources.

Level of Support: Tableau-supported

Resources:

Hyper API

Data Connectivity

Create custom scripts that interact with extract (.hyper) files.

Extract API

Data Connectivity

Create custom scripts that pull your data into Tableau data extracts.

Hyper API

Create custom scripts that interact with extract (.hyper) files.

Use Cases: Connect to data sources with the Hyper API and write the data into extract files (in the .hyper file format for Tableau 10.5 and later). Write custom scripts that update data in existing extract files or read data from them.

Benefits: If you can connect to your data, you can use the Hyper API to create data extracts that improve performance and provide offline access. If you have data sources that are not currently supported, you can use the Hyper API to get the data into Tableau. If you want to update data within extract files, you can use the Hyper API to update the extract. If you need to access data from an extract, you can now write a script that reads the data from the extract.

Level of Support: Tableau-supported

Resources:

Extract API

Create custom scripts that pull your data into Tableau data extracts.

Use Cases: Connect to data sources with the Extract API and write the data into extract files (in the .hyper file format for Tableau 10.5 and later).

Benefits: If you can connect to your data, you can use the Extract API to create data extracts that improve performance and provide offline access. If you have data sources that are not currently supported, you can use the Extract API to get the data into Tableau. Runs on MacOS, Windows, and Linux systems, and your choice of programming language (C, C++, Java, and Python).

Level of Support: Tableau-supported

Resources:

  • Help Extract API 2.0 for .hyper format
  • Samples (.hyper format)
  • Help Tableau SDK for .tde format, if you are using Tableau 10.4 and earlier
  • Samples (.tde format)

Webhooks API

Automation

Notifications of Tableau events to your external application or workflow.

Webhooks

Part of Tableau Server and Tableau Online, webhooks enable Tableau events to send an HTTP POST notification to the web location of your choice.

Use Cases:

  • Send an SMS whenever a data source refresh occurs
  • Notify a web app to synchronize data when a workbook is created

Level of Support: Tableau-supported

Resources:

More resources

Community

Visit the Developer Portal to ask questions, contribute content, and connect.

Learn More

GitHub

Find Tableau's repositories to get the latest APIs and samples, submit issues, and more.

Learn More

Support

Learn more about support for our APIs and developer tools.

Learn More

Sign up for developer updates