Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tableau Views API

Query views and download view images or data. Views are the individual sheets, dashboards, or stories within a workbook.

Tableau Views 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 Views. 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 8 operations across 8 paths, and defines 6 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}.

8 operations 8 paths 6 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.24.0
Base URL
https://[server]/api/[api-version]
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Tableau Views 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 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Views 8

Query views and download view images or data. Views are the individual sheets, dashboards, or stories within a workbook.

GET
/sites/{site-id}/workbooks/{workbook-id}/views
Tableau Query Views for Workbook
queryViewsForWorkbook 3 params → 200401403404
GET
/sites/{site-id}/views
Tableau Query Views for Site
queryViewsForSite 7 params → 200401403
GET
/sites/{site-id}/views/{view-id}
Tableau Query View by Id
queryViewById 2 params → 200401403404
GET
/sites/{site-id}/views/{view-id}/image
Tableau Query View Image
queryViewImage 5 params → 200401403404
GET
/sites/{site-id}/views/{view-id}/data
Tableau Query View Data
queryViewData 4 params → 200401403404
GET
/sites/{site-id}/views/{view-id}/pdf
Tableau Query View Pdf
queryViewPDF 4 params → 200401403404
GET
/sites/{site-id}/views/{view-id}/previewImage
Tableau Query View Preview Image
queryViewPreviewImage 2 params → 200401404
GET
/sites/{site-id}/views/{view-id}/recommendations
Tableau Get Recommendations for Views
getRecommendationsForViews 2 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are View (12 properties), Pagination (3 properties), ViewListResponse (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ViewListResponse
object
2 properties
ViewResponse
object
1 property
Tag
object
1 property
Pagination
object
3 properties
View
object
12 properties
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableau-views-api-openapi.yml Raw ↑

Other APIs Tableau publishes across the network.

Tableau Metadata API
Tableau Hyper API
Tableau Embedding API
Tableau Document API
Tableau Server Client (Python)
Tableau Extensions API
Tableau Web Data Connector
Tableau Connector SDK
Tableau Analytics Extensions API
Tableau Webhooks
Tableau VizQL Data Service
Tableau Pulse API