Tableau APIs

Number of APIs: 918

Tableau REST API Collection

The Tableau REST API enables you to perform many Tableau actions from scripts and programs. You can use this collection to make requests to your Tableau site and see the response, without creating an app to do it.

Get Started

To get started, see How to Use the Collection.

Contribute

This collection is open source and we welcome your contributions by [creating a Qodex pull request for a fork] See Contributing for more info.

Issues

You can find and create issues with the collection in tableau-Qodex GitHub repo issues.

Learn more

For REST API method details and behaviors, see the Tableau REST API Reference.

To get familiar with the REST API try the Get Started Tutorial.

  1. Sample Workflows-Embedding Visualizations-Generate View Thumbnail - Query Views for Site GET {{base-path}}/sites/{{site-id}}/views?filter=workbookName:eq:{{workbook-name}},name:eq:Overview

  2. Sample Workflows-DevOps-Tag and Deploy to Prod - Query Workbooks for Site GET {{base-path}}/sites/{{site-id}}/workbooks?filter=name:eq:Superstore,projectName:eq:{{project-name}}

  3. Tableau REST API-Pulse (Cloud-only) - List metrics in definition (Cloud-only) GET {{baseUrl}}/api/-/pulse/definitions/:definition_id/metrics?page_size=<integer>&page_token=<string>&enable_sorting=<boolean>&order_by=<string>&filter=<string>

  4. Tableau REST API-Flows - Query Flows for a Site GET {{base-path}}/sites/{{site-id}}/flows

  5. Sample Workflows-DevOps-Tag and Deploy to Prod - Add Tags to a Workbook PUT {{base-path}}/sites/{{site-id}}/workbooks/:workbook-id/tags

  6. Tableau REST API-Flows - Query Flow Connections GET {{base-path}}/sites/{{site-id}}/flows/:flow-id/connections

  7. Sample Workflows-DevOps-Tag and Deploy to Prod - Download Workbook GET {{base-path}}/sites/{{site-id}}/workbooks/:workbook-id/content

  8. Tableau REST API-Flows - Run Flow Now POST {{base-path}}/sites/{{site-id}}/flows/:flow-id/run

  9. Sample Workflows-DevOps-Tag and Deploy to Prod - Download Workbook GET {{base-path}}/sites/{{site-id}}/workbooks/:workbook-id/content

  10. Tableau REST API-Metadata - Batch Add (or Update) Data Quality Certifications (requires Data Management license) POST {{base-path}}/sites/{{site-id}}/dataQualityCertifications