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 Favorites API

Add and remove content items from a user's list of favorites, including workbooks, views, data sources, projects, and flows.

Tableau Favorites 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 Favorites. 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 2 operations across 1 path, and defines 7 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}.

2 operations 1 paths 7 schemas 1 GET1 PUT

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 Favorites 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 2

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

Favorites 2

Add and remove content items from a user's list of favorites, including workbooks, views, data sources, projects, and flows.

GET
/sites/{site-id}/favorites/{user-id}
Tableau Get Favorites for User
getFavorites 2 params → 200
PUT
/sites/{site-id}/favorites/{user-id}
Tableau Add Favorites
addFavorites 2 params body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Workbook (16 properties), DataSource (15 properties), View (12 properties), Project (9 properties). Each schema is shown below with its type and property counts.

FavoritesResponse
object
1 property
Project
object
9 properties
AddFavoriteRequest
object
1 property
Tag
object
1 property
Workbook
object
16 properties
View
object
12 properties
DataSource
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableau-favorites-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