Document API Python

Programmatically update your Tableau workbooks and data sources.

This site will get you up and running with the Python version of the Tableau Document API. The Document API, including the samples and documentation, are all open source.

Get Started   Download

Document API Overview

This repo contains Python source and example files for the Tableau Document API.

The Document API provides an unsupported way to programmatically make updates to Tableau workbook and data source files. If you’ve been making changes to these file types by directly updating the XML–that is, by XML hacking–this SDK is for you.

Features include:

• Support for TWB, TWBX, TDE and TDSX files starting roughly back to Tableau 9.x
• Getting connection information from data sources and workbooks
  • Server Name
  • Username
  • Database Name
  • Authentication Type
  • Connection Type
• Updating connection information in workbooks and data sources
  • Server Name
  • Username
  • Database Name
• Getting Field information from data sources and workbooks
  • Get all fields in a data source
  • Get all fields in use by certain sheets in a workbook

For Hyper files, take a look a the Tableau Hyper API.

We don’t yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information.