Tableau

Tableau is a data visualization and analytics platform that helps users explore, analyze, and share data through interactive dashboards and reports. The Tableau API ecosystem provides programmatic access to its features, allowing developers to automate tasks, integrate Tableau functionality into external applications, and extend its capabilities. Key APIs include the REST API, JavaScript API, and Extract API.

The REST API enables automation of administrative tasks such as creating users, groups, and workbooks, publishing and updating content, and managing permissions. The JavaScript API allows embedding interactive Tableau visualizations into web applications, with options for filtering, selecting data points, and responding to user interactions. The Extract API supports creating and updating Tableau data extracts programmatically, which can then be used in dashboards for analysis. These APIs collectively allow organizations to integrate Tableau with business applications, streamline reporting workflows, and embed analytics directly into customer-facing or internal tools, ensuring that data insights are accessible and actionable.

Documentation URL: https://www.tableau.com/developer/tools/rest-api

Installable Elements              (No items selected)



Base Elements

These elements are required for the templates below to work

  • Remote Site Settings for Tableau API calls

  • Custom Metadata Type and record to securely store the Tableau Credentials

  • Tableau Login API Call template to obtain access token

Analytics Extensions Settings Methods

Enable and configure analytics extensions on sites and, for on premise installations, on servers. With these extensions you can extend Tableau dynamic calculations with languages like R and python, and with other tools and platforms.

  • Enables or disables analytics extensions on a server.

  • Gets the enabled/disabled state of analytics extensions on a server.

  • Gets the enabled/disabled state of analytics extensions on a site.

  • Enables or disables analytics extensions on a site.

  • Adds an analytics extensions connection for an external service to a site.

  • Lists a site's analytics extension connections for external services.

  • Deletes a specific analytics extension connection for an external service from a site.

  • Get the details of a specified analytics extension connection to an external service.

  • Updates the details of specified analytics extension connection for an external service to a site.

  • Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name.

  • Gets basic details, including connection type and name, of the analytics extension connection to an external service that the specified workbook is currently using.

  • Remove the currently used analytics extension connection to an external service from the specified workbook. The connection remains configured, and is available for further usage by the workbook.

  • Updates the analytics extension connection to external service currently used by a workbook.

Connected Apps

Templates related to Connected Apps

Content Exploration Methods

Content Exploration Methods

  • Gets usage statistics for multiple content items. The batch of can include multiple content types.

  • Gets the usage statistics for a Tableau content item, specified by LUID and content type, such as workbook, datasource, or flow.

  • Searches across all supported content types for objects relevant to the search expression specified in the querystring of the request URI.

  • Returns a specified number of suggestions for auto-completion of user input as they type. You can specify content types of suggestions and prioritize recently viewed content.

Data Sources

Templates related to Data Sources

Extracts and Encryption

Templates related to Extracts and Encryption

Favorites

Templates related to Favorites

  • Delete Metric from Favorites

Flows

Templates related to Flows

  • Get Linked Tasks

  • Run Linked Task Now

Jobs, Tasks, and Schedules

Templates related to Jobs, Tasks, and Schedules

Metadata

Templates related to Metadata

  • Delete Data Quality Warning by ID (requires Data Management license)

  • Delete Data Quality Warning by Content (requires Data Management license)

  • Delete Data Quality Certification by ID (requires Data Management license)

  • Delete Quality Warning Trigger by ID (requires Data Management license)

  • Delete Quality Warning Trigger by Content (requires Data Management license)

  • Delete Label (requires Data Management license)

  • Delete Table Permissions for User (requires Data Management license)

  • Delete Table Permissions for Group (requires Data Management license)

  • Delete Tag from Column (requires Data Management license)

  • Delete Tag from Database (requires Data Management license)

  • Delete Tag from Table (requires Data Management license)

  • Get Label (requires Data Management license)

  • Query Column in a Table (requires Data Management license)

  • Query Columns in a Table (requires Data Management license)

  • Query Database (requires Data Management license)

  • Query Databases (requires Data Management license)

  • Query Database Permissions (requires Data Management license)

  • Query Default Database Permissions (requires Data Management license)

  • Query Data Quality Warning by ID (requires Data Management license)

  • Query Data Quality Warning by Content (requires Data Management license)

  • Query Data Quality Certification by ID (requires Data Management license)

  • Query Data Quality Certifications by Content (requires Data Management license)

  • Query Quality Warning Trigger (requires Data Management license)

  • Query All Quality Warning Triggers by Content (requires Data Management license)

  • Query Table (requires Data Management license)

  • Query Tables (requires Data Management license)

  • Query Table Permissions (requires Data Management license)

  • Remove Column (requires Data Management license)

  • Remove Database (requires Data Management license)

  • Remove Table (requires Data Management license)

  • Get labelValue

  • List labelValues on Site

  • Create or Update labelValue

  • Update labelValue

  • Delete labelValue

Mobile Settings

Templates related to Mobile Settings

  • Get Mobile Security Settings for Server

  • Get Mobile Security Settings for Site

  • Update Mobile Security Settings for Site

Notifications

Templates related to Notifications

  • Delete Data-Driven Alert

  • Delete User from Data-Driven Alert

  • Delete a Webhook

  • Get User Notification Preferences

  • Get a Webhook

  • List Webhooks

  • Query Data-Driven Alerts

  • Query Data-Driven Alert Details

  • Test a Webhook

Permissions

Templates related to Permissions

  • Delete Ask Data Permissions (for User)

  • Delete Ask Data Permissions (for Group)

  • Delete Datasource Permission for Group

  • Delete Datasource Permission for User

  • Delete Project Permission for Group

  • Delete Project Permission for User

  • Delete View Permission for User

  • Delete View Permission for Group

  • Delete Workbook Permission for User

  • Delete Workbook Permission for Group

  • List Ask Data Lens Permissions

  • Query Datasource Permissions

  • Query Project Permissions

  • Query View Permissions

  • Query Workbook Permissions

Projects

Templates related to Projects

  • Tableau API Call to List all projects

  • Delete Project

  • Query Projects

Publishing

Templates related to Publishing

  • Append to File Upload

  • Initiate File Upload

  • Publish Datasource

  • Publish Flow

  • Publish Workbook

Pulse (Cloud-only)

With Tableau Pulse, Tableau Cloud users can follow metrics and use guided exploration to understand more about their data. In addition to viewing metrics from the Tableau Pulse home page, users can receive digests via Slack or email that include insights into important changes in their data so users can stay up to date.

  • Creates a metric definition.

  • Lists the metric definitions configured for a site or, optionally, the details and definition for a specific metric.

  • Deletes a metric definition.

  • Gets a metric definition and optionally metrics it contains.

  • Updates a metric definition.

  • Lists the metrics contained in a metric definition.

  • Gets a batch of metric definitions and metrics available on a site.

  • Generates a bundle the current aggregated value for each metric.

  • Generates a detail insight bundle.

  • Generates a springboard insight bundle.

  • Creates a metric.

  • Deletes a metric.

  • Gets the details of the specified metric.

  • Updates the specification of a metric.

  • Gets a batch of metrics from a definition, specified in a comma delimited list.

  • Returns the details of a metric in a definition if it exists, or creates a new metric if it does not. Also returns `true` if a new metric was created, or `false` if it already existed.

  • Creates a subscription to a specified metric for a specified user or group.

  • Lists the subscriptions to a specified metric and/or for a specified user.

  • Deletes a specified subscription to a metric.

  • Gets a specified subscription to a metric.

  • Creates multiple subscriptions to a metric for specified users and/or groups.

  • Gets a batch of subscriptions, specified in a comma delimited list of subscriptions LUIDs.

  • Gets the number of unique users subscribed to a set of metrics specified in a comma separated list of metric LUIDs.

Revisions

Templates related to Revisions

  • Download Data Source Revision

  • Download Workbook Revision

  • Get Data Source Revisions

  • Get Workbook Revisions

  • Remove Data Source Revision

  • Remove Workbook Revision

Server

Templates related to Server

  • Delete Server Session (Server-only)

  • Get Current Server Session

  • List Server Active Directory Domains (Server-only)

  • Server Info

Sites

Templates related to Sites

  • Delete Site (by ID) (Server-only)

  • Delete Site (by Site Name) (Server-only)

  • Delete Site (by Content URL) (Server-only)

  • Get Data Acceleration Report for a Site (Server-only)

  • Get Embedding Settings for a Site

  • Get Recently Viewed for Site

  • Query Site (by ID)

  • Query Site (by Site Name)

  • Query Site (by Content URL)

  • Query Sites (Server-only)

  • Query Views for Site

  • List Auth Configurations for Site

  • Get User Personal Space

Subscriptions

Templates related to Subscriptions

  • Create Cloud Subscription (Cloud-only)

  • Delete Subscription

  • Update Cloud Subscription (Cloud-only)

  • Update Server Subscription (Server-only)

Users and Groups

Templates related to Users and Groups

  • Delete Group

  • Delete Users from Site with CSV

  • Get Groups for a User

  • Get Users in Group

  • Get Users On Site

  • Import Users to Site from CSV

  • Query Groups

  • Query User on Site

  • Remove User from Site

  • Remove User from Group

Virtual Connections

Templates related to Virtual Connections

  • List Virtual Connections

  • List Virtual Connection Database Connections

Workbooks and Views

Templates related to Workbooks and Views

  • Delete Custom View

  • Delete Tag from a View

  • Delete Tag from a Workbook

  • Delete Workbook

  • Download View Crosstab Excel

  • Download Workbook

  • Download Workbook PDF

  • Download Workbook PowerPoint

  • Download Workbook Revision (When version history is enabled for site)

  • Get Custom View

  • Get Custom View Image

  • Get View

  • Get View by Path

  • Get Recommendations for Views

  • Get Workbook Downgrade Info

  • Get Workbook Revisions

  • List Custom Views

  • Get the details of a specific workbok

  • Query Views for Site

  • Query Views for Workbook

  • Query View Data

  • Query View Image

  • Query View PDF

  • Query View Preview Image

  • Get Workbook

  • Query Workbooks for Site

  • Query Workbooks for User

  • Query Workbook Connections

  • Query Workbook Preview Image

  • Unhide a Recommendation for a View

Pulse Test

With Tableau Pulse, Tableau Cloud users can follow metrics and use guided exploration to understand more about their data. In addition to viewing metrics from the Tableau Pulse home page, users can receive digests via Slack or email that include insights into important changes in their data so users can stay up to date.

  • Creates a metric definition.

  • Lists the metric definitions configured for a site or, optionally, the details and definition for a specific metric.

  • Deletes a metric definition.

  • Gets a metric definition and optionally metrics it contains.

  • Updates a metric definition.

  • Lists the metrics contained in a metric definition.

  • Gets a batch of metric definitions and metrics available on a site.

  • Generates a bundle the current aggregated value for each metric.

  • Generates a detail insight bundle.

  • Generates a springboard insight bundle.

  • Creates a metric.

  • Deletes a metric.

  • Gets the details of the specified metric.

  • Updates the specification of a metric.

  • Gets a batch of metrics from a definition, specified in a comma delimited list.

  • Returns the details of a metric in a definition if it exists, or creates a new metric if it does not. Also returns `true` if a new metric was created, or `false` if it already existed.

  • Creates a subscription to a specified metric for a specified user or group.

  • Lists the subscriptions to a specified metric and/or for a specified user.

  • Deletes a specified subscription to a metric.

  • Gets a specified subscription to a metric.

  • Creates multiple subscriptions to a metric for specified users and/or groups.

  • Gets a batch of subscriptions, specified in a comma delimited list of subscriptions LUIDs.

  • Gets the number of unique users subscribed to a set of metrics specified in a comma separated list of metric LUIDs.

In order to install this in your org, you need to access the library from the Declarative Webhooks app in your Salesforce org, Declarative Webhooks Library tab.