Tableau

Tableau is a visual analytics platform transforming the way we use data to solve problems—empowering people and organizations to make the most of their data.

13 APIs 10 Features

AnalyticsBusiness IntelligenceDashboardsData Visualization

APIs

Tableau REST API

The Tableau REST API allows you to manage and change Tableau Server, Tableau Cloud site, and Tableau Prep Conductor resources programmatically, using HTTP.

Tableau Metadata API

GraphQL-based API for querying metadata about Tableau content, data sources, and lineage information.

Tableau Hyper API

API for creating, reading, and updating Hyper files, which are the data files that power Tableau extracts.

Tableau Embedding API

JavaScript API for embedding Tableau visualizations in web applications with advanced interaction capabilities.

Tableau Document API

Python library for programmatically updating Tableau workbook and data source files.

Tableau Server Client (Python)

Python library that wraps the Tableau REST API for easier programmatic access.

Tableau Extensions API

The Tableau Extensions API allows developers to create dashboard extensions and viz extensions that users can interact with directly in Tableau, enabling integration with other ...

Tableau Web Data Connector

The Tableau Web Data Connector (WDC) provides an SDK for building connectors to any data accessible over HTTP, allowing users to bring external data into Tableau for analysis an...

Tableau Connector SDK

SDK for developing custom Tableau connectors using ODBC or JDBC drivers, including documentation, example files, a test harness, and a packaging tool for distribution.

Tableau Analytics Extensions API

The Analytics Extensions API allows integration of external analytics engines such as Python, R, MATLAB, and data science platforms with Tableau calculations for advanced analyt...

Tableau Webhooks

Tableau Webhooks enable event-driven automation by sending HTTP POST notifications to specified URLs when events occur on Tableau Server or Tableau Cloud.

Tableau VizQL Data Service

The VizQL Data Service provides a programmatic HTTP interface to query published data sources outside of Tableau visualizations, enabling headless data access from any application.

Tableau Pulse API

The Tableau Pulse API enables programmatic creation, management, and querying of Tableau Pulse metrics and subscriptions, as well as embedding Pulse insights into web applications.

Collections

Tableau REST API

OPEN

GraphQL

Tableau GraphQL API

The Tableau Metadata API is a GraphQL-based API introduced in Tableau 2019.3 that enables querying of metadata about Tableau Server and Tableau Cloud content, data assets, and d...

GRAPHQL

Pricing Plans

Tableau Plans Pricing

4 plans

PLANS

Rate Limits

Tableau Rate Limits

6 limits

RATE LIMITS

FinOps

Tableau Finops

FINOPS

Features

Data Source Management

Publish, query, update, delete, and download data sources that define connections to data shared across workbooks.

Workbook Management

Publish, query, update, delete, and download workbooks containing views, dashboards, and stories.

Site Administration

Create, configure, and manage Tableau Server and Cloud sites with full lifecycle control.

User and Group Management

Add, update, and remove users and groups with role-based access control for content permissions.

Permission Management

Query and set granular permissions on workbooks, data sources, projects, views, and flows.

Schedule and Subscription Management

Create and manage schedules for extract refreshes and subscriptions for automated content delivery.

Embedded Analytics

Embed Tableau visualizations in web applications with interactive filtering and full API control.

Metadata and Lineage

Query metadata about content, data sources, and data lineage using the GraphQL-based Metadata API.

Custom Connectors

Build custom connectors using ODBC or JDBC drivers to bring any data source into Tableau.

Webhooks

Enable event-driven automation with HTTP POST notifications when events occur on Tableau Server or Cloud.

Use Cases

Enterprise Reporting

Automate the creation and distribution of business reports and dashboards across organizations.

Embedded Analytics

Embed interactive visualizations and analytics directly into customer-facing applications.

Data Governance

Track data lineage, manage permissions, and enforce data policies across the analytics platform.

Self-Service Analytics

Enable business users to explore data and create visualizations without IT involvement.

Content Migration

Programmatically migrate workbooks, data sources, and configurations between Tableau environments.

Integrations

Salesforce

Native integration with Salesforce CRM for unified analytics across sales, service, and marketing data.

Slack

Share Tableau visualizations and receive metric alerts directly in Slack channels.

Python and R

Extend Tableau calculations with Python and R scripts through the Analytics Extensions API.

Snowflake

Optimized connector for Snowflake data warehouse with live query and extract support.

Google BigQuery

Connect to Google BigQuery for large-scale data analytics and visualization.

Semantic Vocabularies

Tableau Context

0 classes · 14 properties

JSON-LD

Tableau Rest Context

0 classes · 0 properties

JSON-LD

API Governance Rules

Tableau API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Tableau Rest Add Favorite Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Add Permissions Request Structure

0 properties

JSON STRUCTURE

Tableau Rest Add User Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Connection List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Connection Structure

6 properties

JSON STRUCTURE

Tableau Rest Create Group Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Create Project Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Create Site Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Create Subscription Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Data Source List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Data Source Response Structure

0 properties

JSON STRUCTURE

Tableau Rest Data Source Structure

15 properties

JSON STRUCTURE

Tableau Rest Error Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Favorites Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Group List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Group Response Structure

0 properties

JSON STRUCTURE

Tableau Rest Group Structure

6 properties

JSON STRUCTURE

Tableau Rest Job List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Job Response Structure

0 properties

JSON STRUCTURE

Tableau Rest Job Structure

13 properties

JSON STRUCTURE

Tableau Rest Pagination Structure

3 properties

JSON STRUCTURE

Tableau Rest Permission List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Permission Structure

1 properties

JSON STRUCTURE

Tableau Rest Project List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Project Response Structure

0 properties

JSON STRUCTURE

Tableau Rest Project Structure

9 properties

JSON STRUCTURE

Tableau Rest Publish Workbook Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Revision List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Revision Structure

6 properties

JSON STRUCTURE

Tableau Rest Schedule List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Schedule Structure

11 properties

JSON STRUCTURE

Tableau Rest Sign In Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Sign In Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Site List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Site Response Structure

0 properties

JSON STRUCTURE

Tableau Rest Site Structure

13 properties

JSON STRUCTURE

Tableau Rest Subscription List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Subscription Response Structure

0 properties

JSON STRUCTURE

Tableau Rest Subscription Structure

11 properties

JSON STRUCTURE

Tableau Rest Tag List Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Tag List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Tag Structure

1 properties

JSON STRUCTURE

Tableau Rest Update Data Source Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Update Group Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Update Project Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Update Site Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Update Subscription Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Update User Request Structure

1 properties

JSON STRUCTURE

Tableau Rest Update Workbook Request Structure

1 properties

JSON STRUCTURE

Tableau Rest User List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest User Response Structure

0 properties

JSON STRUCTURE

Tableau Rest User Structure

10 properties

JSON STRUCTURE

Tableau Rest View List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest View Response Structure

0 properties

JSON STRUCTURE

Tableau Rest View Structure

12 properties

JSON STRUCTURE

Tableau Rest Workbook List Response Structure

1 properties

JSON STRUCTURE

Tableau Rest Workbook Response Structure

0 properties

JSON STRUCTURE

Tableau Rest Workbook Structure

16 properties

JSON STRUCTURE

Tableau Structure

0 properties

JSON STRUCTURE

Example Payloads

Tableau Adddatasourcepermissions Example

6 fields

EXAMPLE

Tableau Addfavorites Example

6 fields

EXAMPLE

Tableau Addtagstodatasource Example

6 fields

EXAMPLE

Tableau Addtagstoworkbook Example

6 fields

EXAMPLE

Tableau Addusertogroup Example

6 fields

EXAMPLE

Tableau Addusertosite Example

6 fields

EXAMPLE

Tableau Addworkbookpermissions Example

6 fields

EXAMPLE

Tableau Creategroup Example

6 fields

EXAMPLE

Tableau Createproject Example

6 fields

EXAMPLE

Tableau Createsite Example

6 fields

EXAMPLE

Tableau Createsubscription Example

6 fields

EXAMPLE

Tableau Downloaddatasource Example

6 fields

EXAMPLE

Tableau Downloadworkbook Example

6 fields

EXAMPLE

Tableau Getdatasourcerevisions Example

6 fields

EXAMPLE

Tableau Getfavorites Example

6 fields

EXAMPLE

Tableau Getgroupmembers Example

6 fields

EXAMPLE

Tableau Getrecommendationsforviews Example

6 fields

EXAMPLE

Tableau Getusers Example

6 fields

EXAMPLE

Tableau Getworkbookrevisions Example

6 fields

EXAMPLE

Tableau Publishworkbook Example

6 fields

EXAMPLE

Tableau Querydatasource Example

6 fields

EXAMPLE

Tableau Querydatasourceconnections Example

6 fields

EXAMPLE

Tableau Querydatasourcepermissions Example

6 fields

EXAMPLE

Tableau Querydatasources Example

6 fields

EXAMPLE

Tableau Querydatasourcetags Example

6 fields

EXAMPLE

Tableau Querydefaultworkbookpermissions Example

6 fields

EXAMPLE

Tableau Querygroups Example

6 fields

EXAMPLE

Tableau Queryjob Example

6 fields

EXAMPLE

Tableau Queryjobs Example

6 fields

EXAMPLE

Tableau Queryprojects Example

6 fields

EXAMPLE

Tableau Queryschedules Example

6 fields

EXAMPLE

Tableau Querysite Example

6 fields

EXAMPLE

Tableau Querysites Example

6 fields

EXAMPLE

Tableau Querysubscription Example

6 fields

EXAMPLE

Tableau Querysubscriptions Example

6 fields

EXAMPLE

Tableau Queryuser Example

6 fields

EXAMPLE

Tableau Queryviewbyid Example

6 fields

EXAMPLE

Tableau Queryviewdata Example

6 fields

EXAMPLE

Tableau Queryviewimage Example

6 fields

EXAMPLE

Tableau Queryviewpdf Example

6 fields

EXAMPLE

Tableau Queryviewpreviewimage Example

6 fields

EXAMPLE

Tableau Queryviewsforsite Example

6 fields

EXAMPLE

Tableau Queryviewsforworkbook Example

6 fields

EXAMPLE

Tableau Queryworkbook Example

6 fields

EXAMPLE

Tableau Queryworkbookconnections Example

6 fields

EXAMPLE

Tableau Queryworkbookpermissions Example

6 fields

EXAMPLE

Tableau Queryworkbookpreviewimage Example

6 fields

EXAMPLE

Tableau Queryworkbooksforsite Example

6 fields

EXAMPLE

Tableau Queryworkbooksforuser Example

6 fields

EXAMPLE

Tableau Queryworkbooktags Example

6 fields

EXAMPLE

Tableau Rest Add Favorite Request Example

1 fields

EXAMPLE

Tableau Rest Add Permissions Request Example

EXAMPLE

Tableau Rest Add User Request Example

1 fields

EXAMPLE

Tableau Rest Connection Example

6 fields

EXAMPLE

Tableau Rest Connection List Response Example

1 fields

EXAMPLE

Tableau Rest Create Group Request Example

1 fields

EXAMPLE

Tableau Rest Create Project Request Example

1 fields

EXAMPLE

Tableau Rest Create Site Request Example

1 fields

EXAMPLE

Tableau Rest Create Subscription Request Example

1 fields

EXAMPLE

Tableau Rest Data Source Example

15 fields

EXAMPLE

Tableau Rest Data Source List Response Example

1 fields

EXAMPLE

Tableau Rest Data Source Response Example

EXAMPLE

Tableau Rest Error Response Example

1 fields

EXAMPLE

Tableau Rest Favorites Response Example

1 fields

EXAMPLE

Tableau Rest Group Example

6 fields

EXAMPLE

Tableau Rest Group List Response Example

1 fields

EXAMPLE

Tableau Rest Group Response Example

EXAMPLE

Tableau Rest Job Example

13 fields

EXAMPLE

Tableau Rest Job List Response Example

1 fields

EXAMPLE

Tableau Rest Job Response Example

EXAMPLE

Tableau Rest Pagination Example

3 fields

EXAMPLE

Tableau Rest Permission Example

1 fields

EXAMPLE

Tableau Rest Permission List Response Example

1 fields

EXAMPLE

Tableau Rest Project Example

9 fields

EXAMPLE

Tableau Rest Project List Response Example

1 fields

EXAMPLE

Tableau Rest Project Response Example

EXAMPLE

Tableau Rest Publish Workbook Request Example

1 fields

EXAMPLE

Tableau Rest Revision Example

6 fields

EXAMPLE

Tableau Rest Revision List Response Example

1 fields

EXAMPLE

Tableau Rest Schedule Example

11 fields

EXAMPLE

Tableau Rest Schedule List Response Example

1 fields

EXAMPLE

Tableau Rest Sign In Request Example

1 fields

EXAMPLE

Tableau Rest Sign In Response Example

1 fields

EXAMPLE

Tableau Rest Site Example

13 fields

EXAMPLE

Tableau Rest Site List Response Example

1 fields

EXAMPLE

Tableau Rest Site Response Example

EXAMPLE

Tableau Rest Subscription Example

11 fields

EXAMPLE

Tableau Rest Subscription List Response Example

1 fields

EXAMPLE

Tableau Rest Subscription Response Example

EXAMPLE

Tableau Rest Tag Example

1 fields

EXAMPLE

Tableau Rest Tag List Request Example

1 fields

EXAMPLE

Tableau Rest Tag List Response Example

1 fields

EXAMPLE

Tableau Rest Update Data Source Request Example

1 fields

EXAMPLE

Tableau Rest Update Group Request Example

1 fields

EXAMPLE

Tableau Rest Update Project Request Example

1 fields

EXAMPLE

Tableau Rest Update Site Request Example

1 fields

EXAMPLE

Tableau Rest Update Subscription Request Example

1 fields

EXAMPLE

Tableau Rest Update User Request Example

1 fields

EXAMPLE

Tableau Rest Update Workbook Request Example

1 fields

EXAMPLE

Tableau Rest User Example

10 fields

EXAMPLE

Tableau Rest User List Response Example

1 fields

EXAMPLE

Tableau Rest User Response Example

EXAMPLE

Tableau Rest View Example

12 fields

EXAMPLE

Tableau Rest View List Response Example

1 fields

EXAMPLE

Tableau Rest View Response Example

EXAMPLE

Tableau Rest Workbook Example

16 fields

EXAMPLE

Tableau Rest Workbook List Response Example

1 fields

EXAMPLE

Tableau Rest Workbook Response Example

EXAMPLE

Tableau Signin Example

6 fields

EXAMPLE

Tableau Switchsite Example

6 fields

EXAMPLE

Tableau Updatedatasource Example

6 fields

EXAMPLE

Tableau Updategroup Example

6 fields

EXAMPLE

Tableau Updateproject Example

6 fields

EXAMPLE

Tableau Updatesite Example

6 fields

EXAMPLE

Tableau Updatesubscription Example

6 fields

EXAMPLE

Tableau Updateuser Example

6 fields

EXAMPLE

Tableau Updateworkbook Example

6 fields

EXAMPLE

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Tableau REST API
  version: 3.24.0
request:
  auth:
    type: apikey
    key: X-Tableau-Auth
    value: '{{X-Tableau-Auth}}'
    placement: header
items:
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Tableau Sign in
      type: http
    http:
      method: POST
      url: https://{server}/api/{api-version}/auth/signin
      body:
        type: json
        data: '{}'
    docs: Signs you in as a user on the specified site on Tableau Server or Tableau Cloud. This call returns an authentication
      token that you use in subsequent calls to the server. Typically, a credentials token is valid for 240 minutes.
  - info:
      name: Tableau Sign Out
      type: http
    http:
      method: POST
      url: https://{server}/api/{api-version}/auth/signout
    docs: Signs you out of the current session. This invalidates the authentication token.
  - info:
      name: Tableau Switch Site
      type: http
    http:
      method: POST
      url: https://{server}/api/{api-version}/auth/switchSite
      body:
        type: json
        data: '{}'
    docs: Switches you to the specified site without having to provide a user name and password again. The new site must be
      on the same server.
- info:
    name: Sites
    type: folder
  items:
  - info:
      name: Tableau Query Sites
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites
      params:
      - name: pageSize
        value: ''
        type: query
        description: The number of items to return in one response. The minimum is 1 and the maximum is 1000.
      - name: pageNumber
        value: ''
        type: query
        description: The page number of the set of items to return. The default is 1.
    docs: Returns a list of the sites on the server that the caller has access to. This method is available to Tableau Server
      administrators.
  - info:
      name: Tableau Create Site
      type: http
    http:
      method: POST
      url: https://{server}/api/{api-version}/sites
      body:
        type: json
        data: '{}'
    docs: Creates a site on Tableau Server. To create a site, you must be a server administrator. Not available for Tableau
      Cloud.
  - info:
      name: Tableau Query Site
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: includeUsageStatistics
        value: 'true'
        type: query
        description: If true, returns usage statistics for the site.
    docs: Returns information about the specified site, with the option to return information about the storage space and
      the number of users.
  - info:
      name: Tableau Update Site
      type: http
    http:
      method: PUT
      url: https://{server}/api/{api-version}/sites/:site-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      body:
        type: json
        data: '{}'
    docs: Updates the settings for the specified site, including the name, URL namespace, storage quota, and other settings.
  - info:
      name: Tableau Delete Site
      type: http
    http:
      method: DELETE
      url: https://{server}/api/{api-version}/sites/:site-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
    docs: Deletes the specified site. Deleting a site also deletes all content on the site including workbooks, data sources,
      users, etc.
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: Tableau Query Projects
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/projects
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: pageSize
        value: ''
        type: query
        description: The number of items to return in one response. The minimum is 1 and the maximum is 1000.
      - name: pageNumber
        value: ''
        type: query
        description: The page number of the set of items to return. The default is 1.
      - name: filter
        value: ''
        type: query
        description: An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value.
          Operators include eq, gt, gte, lt, lte, has, and in.
      - name: sort
        value: ''
        type: query
        description: An expression that lets you specify the order in which items are returned. Use the format sort=field:direction
          where direction is asc or desc.
    docs: Returns a list of projects on the specified site, with optional pagination. You can filter and sort the list of
      projects.
  - info:
      name: Tableau Create Project
      type: http
    http:
      method: POST
      url: https://{server}/api/{api-version}/sites/:site-id/projects
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      body:
        type: json
        data: '{}'
    docs: Creates a project on the specified site. You can also create project hierarchies by setting a parent project.
  - info:
      name: Tableau Update Project
      type: http
    http:
      method: PUT
      url: https://{server}/api/{api-version}/sites/:site-id/projects/:project-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: project-id
        value: ''
        type: path
        description: The ID of the project.
      body:
        type: json
        data: '{}'
    docs: Updates the name, description, or project hierarchy of the specified project.
  - info:
      name: Tableau Delete Project
      type: http
    http:
      method: DELETE
      url: https://{server}/api/{api-version}/sites/:site-id/projects/:project-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: project-id
        value: ''
        type: path
        description: The ID of the project.
    docs: Deletes the specified project on a site. When you delete a project, all Tableau assets inside the project are also
      deleted.
- info:
    name: Workbooks
    type: folder
  items:
  - info:
      name: Tableau Query Workbooks for Site
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: pageSize
        value: ''
        type: query
        description: The number of items to return in one response. The minimum is 1 and the maximum is 1000.
      - name: pageNumber
        value: ''
        type: query
        description: The page number of the set of items to return. The default is 1.
      - name: filter
        value: ''
        type: query
        description: An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value.
          Operators include eq, gt, gte, lt, lte, has, and in.
      - name: sort
        value: ''
        type: query
        description: An expression that lets you specify the order in which items are returned. Use the format sort=field:direction
          where direction is asc or desc.
      - name: fields
        value: ''
        type: query
        description: An expression that lets you specify which fields are included in the response. Use the format fields=field1,field2.
          Use _default_ to return the default set of fields, or _all_ to return all fields.
    docs: Returns the workbooks on a site. If the user is not an administrator, the method returns just the workbooks that
      the user has permissions to view.
  - info:
      name: Tableau Query Workbook
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
    docs: Returns information about the specified workbook, including information about views and tags.
  - info:
      name: Tableau Update Workbook
      type: http
    http:
      method: PUT
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
      body:
        type: json
        data: '{}'
    docs: Modifies an existing workbook, allowing you to change the owner, project, or other properties.
  - info:
      name: Tableau Delete Workbook
      type: http
    http:
      method: DELETE
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
    docs: Deletes a workbook. When a workbook is deleted, all of its assets are also deleted, including associated views.
  - info:
      name: Tableau Query Workbook Connections
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/connections
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
    docs: Returns a list of data connections for the specified workbook.
  - info:
      name: Tableau Download Workbook
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/content
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
      - name: extractValue
        value: 'true'
        type: query
        description: If true, and the workbook contains extracts, the download includes the extracts.
    docs: Downloads a workbook in .twb or .twbx format. If the workbook contains extracts, the download is in .twbx format.
  - info:
      name: Tableau Query Workbook Preview Image
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/previewImage
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
    docs: Returns the thumbnail image for the specified workbook as a PNG file.
  - info:
      name: Tableau Publish Workbook
      type: http
    http:
      method: POST
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/publish
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: overwrite
        value: 'true'
        type: query
        description: If true, overwrites an existing workbook with the same name in the same project.
      - name: skipConnectionCheck
        value: 'true'
        type: query
        description: If true, skips the connection check during publish.
    docs: Publishes a workbook on the specified site. To make changes to an existing workbook, call Update Workbook or Publish
      Workbook with overwrite set to true.
  - info:
      name: Tableau Query Workbook Tags
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/tags
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
    docs: Returns a list of tags that have been added to the specified workbook.
  - info:
      name: Tableau Add Tags to Workbook
      type: http
    http:
      method: PUT
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/tags
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
      body:
        type: json
        data: '{}'
    docs: Adds one or more tags to the specified workbook.
  - info:
      name: Tableau Delete Tag From Workbook
      type: http
    http:
      method: DELETE
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/tags/:tag-name
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
      - name: tag-name
        value: example_value
        type: path
        description: The name of the tag to delete.
    docs: Deletes a tag from the specified workbook.
  - info:
      name: Tableau Get Workbook Revisions
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/revisions
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
      - name: pageSize
        value: ''
        type: query
        description: The number of items to return in one response. The minimum is 1 and the maximum is 1000.
      - name: pageNumber
        value: ''
        type: query
        description: The page number of the set of items to return. The default is 1.
    docs: Returns a list of revision information (revision number, published date, and other metadata) for each revision of
      the specified workbook.
- info:
    name: Views
    type: folder
  items:
  - info:
      name: Tableau Query Views for Workbook
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/views
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: workbook-id
        value: ''
        type: path
        description: The ID of the workbook.
      - name: includeUsageStatistics
        value: 'true'
        type: query
        description: If true, returns usage statistics for each view.
    docs: Returns all the views for the specified workbook, optionally including usage statistics.
  - info:
      name: Tableau Query Views for Site
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/views
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: pageSize
        value: ''
        type: query
        description: The number of items to return in one response. The minimum is 1 and the maximum is 1000.
      - name: pageNumber
        value: ''
        type: query
        description: The page number of the set of items to return. The default is 1.
      - name: filter
        value: ''
        type: query
        description: An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value.
          Operators include eq, gt, gte, lt, lte, has, and in.
      - name: sort
        value: ''
        type: query
        description: An expression that lets you specify the order in which items are returned. Use the format sort=field:direction
          where direction is asc or desc.
      - name: fields
        value: ''
        type: query
        description: An expression that lets you specify which fields are included in the response. Use the format fields=field1,field2.
          Use _default_ to return the default set of fields, or _all_ to return all fields.
      - name: includeUsageStatistics
        value: 'true'
        type: query
        description: If true, returns usage statistics for each view.
    docs: Returns all the views for the specified site, optionally including usage statistics.
  - info:
      name: Tableau Query View by Id
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/views/:view-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: view-id
        value: ''
        type: path
        description: The ID of the view.
    docs: Returns details about the specified view, including the view name, owner, project, and usage statistics.
  - info:
      name: Tableau Query View Image
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/views/:view-id/image
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: view-id
        value: ''
        type: path
        description: The ID of the view.
      - name: resolution
        value: standard
        type: query
        description: The resolution of the image (standard or high).
      - name: maxAge
        value: '10'
        type: query
        description: The maximum number of minutes a view image can be cached before being refreshed.
      - name: vf_<filter_name>
        value: example_value
        type: query
        description: Apply a filter to the view. Replace <filter_name> with the name of the filter field.
    docs: Returns an image of the specified view rendered as a PNG file. You can specify the resolution of the image.
  - info:
      name: Tableau Query View Data
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/views/:view-id/data
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: view-id
        value: ''
        type: path
        description: The ID of the view.
      - name: maxAge
        value: '10'
        type: query
        description: The maximum number of minutes a view can be cached before being refreshed.
      - name: vf_<filter_name>
        value: example_value
        type: query
        description: Apply a filter to the view. Replace <filter_name> with the name of the filter field.
    docs: Returns the data used in a view as a comma-separated values (CSV) file.
  - info:
      name: Tableau Query View Pdf
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/views/:view-id/pdf
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: view-id
        value: ''
        type: path
        description: The ID of the view.
      - name: type
        value: A3
        type: query
        description: The paper size for the PDF.
      - name: orientation
        value: portrait
        type: query
        description: The orientation of the PDF.
    docs: Returns a PDF rendering of the specified view.
  - info:
      name: Tableau Query View Preview Image
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/views/:view-id/previewImage
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: view-id
        value: ''
        type: path
        description: The ID of the view.
    docs: Returns the thumbnail image for the specified view as a PNG file.
  - info:
      name: Tableau Get Recommendations for Views
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/views/:view-id/recommendations
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: view-id
        value: ''
        type: path
        description: The ID of the view.
    docs: Returns a list of views that are recommended for a user, based on their viewing history.
- info:
    name: Data Sources
    type: folder
  items:
  - info:
      name: Tableau Query Data Sources
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/datasources
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: pageSize
        value: ''
        type: query
        description: The number of items to return in one response. The minimum is 1 and the maximum is 1000.
      - name: pageNumber
        value: ''
        type: query
        description: The page number of the set of items to return. The default is 1.
      - name: filter
        value: ''
        type: query
        description: An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value.
          Operators include eq, gt, gte, lt, lte, has, and in.
      - name: sort
        value: ''
        type: query
        description: An expression that lets you specify the order in which items are returned. Use the format sort=field:direction
          where direction is asc or desc.
      - name: fields
        value: ''
        type: query
        description: An expression that lets you specify which fields are included in the response. Use the format fields=field1,field2.
          Use _default_ to return the default set of fields, or _all_ to return all fields.
    docs: Returns a list of published data sources on the specified site, with optional pagination, filtering, and sorting.
  - info:
      name: Tableau Query Data Source
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
    docs: Returns information about the specified data source.
  - info:
      name: Tableau Update Data Source
      type: http
    http:
      method: PUT
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
      body:
        type: json
        data: '{}'
    docs: Updates the owner, project, or certification status of the specified data source.
  - info:
      name: Tableau Delete Data Source
      type: http
    http:
      method: DELETE
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
    docs: Deletes the specified data source from a site.
  - info:
      name: Tableau Download Data Source
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/content
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
      - name: includeExtract
        value: 'true'
        type: query
        description: If true and the data source contains an extract, the download includes the extract.
    docs: Downloads the specified data source in .tdsx format.
  - info:
      name: Tableau Query Data Source Connections
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/connections
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
    docs: Returns a list of data connections for the specified data source.
  - info:
      name: Tableau Get Data Source Revisions
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/revisions
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
      - name: pageSize
        value: ''
        type: query
        description: The number of items to return in one response. The minimum is 1 and the maximum is 1000.
      - name: pageNumber
        value: ''
        type: query
        description: The page number of the set of items to return. The default is 1.
    docs: Returns a list of revision information for each revision of the specified data source.
  - info:
      name: Tableau Query Data Source Tags
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/tags
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
    docs: Returns a list of tags associated with the specified data source.
  - info:
      name: Tableau Add Tags to Data Source
      type: http
    http:
      method: PUT
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/tags
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
      body:
        type: json
        data: '{}'
    docs: Adds one or more tags to the specified data source.
  - info:
      name: Tableau Query Data Source Permissions
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/permissions
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
    docs: Returns a list of permissions for the specified data source.
  - info:
      name: Tableau Add Data Source Permissions
      type: http
    http:
      method: PUT
      url: https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/permissions
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: datasource-id
        value: ''
        type: path
        description: The ID of the data source.
      body:
        type: json
        data: '{}'
    docs: Adds permissions to the specified data source for a user or group.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Tableau Get Users on Site
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/users
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: pageSize
        value: ''
        type: query
        description: The number of items to return in one response. The minimum is 1 and the maximum is 1000.
      - name: pageNumber
        value: ''
        type: query
        description: The page number of the set of items to return. The default is 1.
      - name: filter
        value: ''
        type: query
        description: An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value.
          Operators include eq, gt, gte, lt, lte, has, and in.
      - name: sort
        value: ''
        type: query
        description: An expression that lets you specify the order in which items are returned. Use the format sort=field:direction
          where direction is asc or desc.
    docs: Returns the users associated with the specified site.
  - info:
      name: Tableau Add User to Site
      type: http
    http:
      method: POST
      url: https://{server}/api/{api-version}/sites/:site-id/users
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      body:
        type: json
        data: '{}'
    docs: Adds a user to the specified site. The user must already exist on the server or in the identity store.
  - info:
      name: Tableau Query User on Site
      type: http
    http:
      method: GET
      url: https://{server}/api/{api-version}/sites/:site-id/users/:user-id
      params:
      - name: site-id
        value: ''
        type: path
        description: The ID of the site. You can get the site ID from the response to the Sign In method.
      - name: user-id
        value: ''
        type: path
        description: The ID of the user.
    docs: Returns information about the specified user on the site.
  - info:
     

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tableau/refs/heads/main/apis.yml