Tableau Workbooks API
Publish, query, update, delete, and download workbooks. Workbooks contain one or more views (sheets, dashboards, or stories) and can connect to one or more data sources.
Tableau Workbooks API is one of 25 APIs that Tableau publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Workbooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, a changelog, a getting-started guide, and 1 JSON Schema.
This API exposes 16 operations across 12 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version 3.24.0.
Requests are made against a single base URL, https://{server}/api/{api-version}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tableau Workbooks API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Tableau-Auth (TableauAuth).
By default, every request must be authenticated.
TableauAuth— The authentication token obtained from the Sign In method. Include this token in the X-Tableau-Auth header of all subsequent requests.
Paths & Operations 16
Across 12 paths, the API surfaces 16 operations — 2 DELETE, 10 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Publish, query, update, delete, and download workbooks. Workbooks contain one or more views (sheets, dashboards, or stories) and can connect to one or more data sources.
Schemas 19
The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Workbook (16 properties), View (12 properties), Connection (6 properties), Revision (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Tableau 12
Other APIs Tableau publishes across the network.