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:

• Help
• Samples on GitHub

Tableau Server Client Library Resources:

• Help
• Samples on GitHub
• Project on GitHub

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)

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:

• Help
• Samples on GitHub
• Project on GitHub