> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/tableau.md).

# Tableau

Connect to Tableau Server or Tableau Cloud to access datasources, workbooks, views, and Pulse metrics. Query data, generate insights, and export visualizations.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication               |
| --------- | ---------------------------- |
| Tableau   | Personal Access Token Secret |

### Tableau

Connect to Tableau Server or Tableau Cloud using Personal Access Tokens to access datasources, workbooks, views, and Pulse metrics.

#### Set up in Tableau

1. Sign in to Tableau Server or Tableau Cloud, open your account settings (My Account Settings), and find the Personal Access Tokens section.
2. Create a new token, give it a name, and copy the token secret when it is shown (it is displayed only once).

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Tableau**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field                | Required | What to enter                                                                                                                                                                                                           |
| ---------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Server URL                   | Yes      | The base URL of your Tableau instance (without the /#/site/... part). Example: If your Tableau URL is <https://us-east-1.online.tableau.com/#/site/mysite/home>, enter <https://us-east-1.online.tableau.com>.          |
| Site Name                    | Yes      | The site identifier from your Tableau URL (the part after /#/site/). Example: If your URL is <https://us-east-1.online.tableau.com/#/site/mysite/home>, enter mysite.                                                   |
| Personal Access Token Name   | Yes      | The name you gave your PAT when creating it in Tableau. Find or create tokens at: Account Settings > Personal Access Tokens.                                                                                            |
| Personal Access Token Secret | Yes      | The secret value shown when you created the PAT. This is only displayed once - if lost, create a new token. [Provider instructions](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm). |

**Provider documentation:** [Setup reference](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Tableau** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Datasources

List all published datasources in your Tableau site.

#### Inputs

| Field       | Type    | Required | Description                                                            |
| ----------- | ------- | -------- | ---------------------------------------------------------------------- |
| Page Size   | integer | No       | Number of datasources to return per page (default: 100). Default: 100. |
| Page Number | integer | No       | Page number to retrieve (default: 1). Default: 1.                      |
| Filter      | string  | No       | Filter expression to narrow results.                                   |
| Sort        | string  | No       | Sort expression for results.                                           |

#### Outputs

| Field       | Type    | Description                            |
| ----------- | ------- | -------------------------------------- |
| Datasources | array   | List of datasources.                   |
| Pagination  | object  | Pagination information.                |
| Total Count | integer | Total number of datasources available. |

### Get Datasource Metadata

Get detailed metadata for a Tableau datasource including column information.

#### Inputs

| Field      | Type            | Required | Description                                                                    |
| ---------- | --------------- | -------- | ------------------------------------------------------------------------------ |
| Datasource | select (string) | Yes      | The datasource to get metadata for. Options load from the selected connection. |

#### Outputs

| Field              | Type    | Description                          |
| ------------------ | ------- | ------------------------------------ |
| Datasource ID      | string  | The datasource ID.                   |
| Datasource Name    | string  | The name of the datasource.          |
| Description        | string  | The datasource description.          |
| Columns            | array   | List of columns in the datasource.   |
| Is Certified       | boolean | Whether the datasource is certified. |
| Certification Note | string  | Note about the certification.        |
| Raw Metadata       | object  | Full raw metadata response.          |

### Query Datasource

Query data from a Tableau datasource using VizQL.

#### Inputs

| Field       | Type            | Required | Description                                                                                                                                                                                                     |
| ----------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Datasource  | select (string) | Yes      | The datasource to query. Options load from the selected connection.                                                                                                                                             |
| VizQL Query | string          | Yes      | VizQL query JSON with 'fields' array. Each field can have: fieldCaption (required), function (SUM/COUNT/AVG), fieldAlias, sortDirection (ASC/DESC), sortPriority. Optional 'filters' array for TOP/SET filters. |

#### Outputs

| Field     | Type    | Description                         |
| --------- | ------- | ----------------------------------- |
| Columns   | array   | List of column names in the result. |
| Data      | array   | Query result rows.                  |
| Row Count | integer | Number of rows returned.            |

### List Workbooks

List all workbooks in your Tableau site.

#### Inputs

| Field       | Type    | Required | Description                                                          |
| ----------- | ------- | -------- | -------------------------------------------------------------------- |
| Page Size   | integer | No       | Number of workbooks to return per page (default: 100). Default: 100. |
| Page Number | integer | No       | Page number to retrieve (default: 1). Default: 1.                    |
| Filter      | string  | No       | Filter expression to narrow results.                                 |
| Sort        | string  | No       | Sort expression for results.                                         |

#### Outputs

| Field       | Type    | Description                          |
| ----------- | ------- | ------------------------------------ |
| Workbooks   | array   | List of workbooks.                   |
| Pagination  | object  | Pagination information.              |
| Total Count | integer | Total number of workbooks available. |

### Get Workbook

Get details for a specific Tableau workbook including its views.

#### Inputs

| Field       | Type   | Required | Description                         |
| ----------- | ------ | -------- | ----------------------------------- |
| Workbook ID | string | Yes      | The ID of the workbook to retrieve. |

#### Outputs

| Field        | Type   | Description                          |
| ------------ | ------ | ------------------------------------ |
| Workbook     | object | The workbook details.                |
| Views        | array  | List of views in the workbook.       |
| Workbook URL | string | URL to view the workbook in Tableau. |

### List Views

List all views (dashboards and sheets) in your Tableau site.

#### Inputs

| Field                    | Type    | Required | Description                                                      |
| ------------------------ | ------- | -------- | ---------------------------------------------------------------- |
| Page Size                | integer | No       | Number of views to return per page (default: 100). Default: 100. |
| Page Number              | integer | No       | Page number to retrieve (default: 1). Default: 1.                |
| Filter                   | string  | No       | Filter expression to narrow results.                             |
| Sort                     | string  | No       | Sort expression for results.                                     |
| Include Usage Statistics | boolean | No       | Include view count statistics. Default: false.                   |

#### Outputs

| Field       | Type    | Description                      |
| ----------- | ------- | -------------------------------- |
| Views       | array   | List of views.                   |
| Pagination  | object  | Pagination information.          |
| Total Count | integer | Total number of views available. |

### Get View Data

Get the underlying data from a Tableau view.

#### Inputs

| Field             | Type    | Required | Description                            |
| ----------------- | ------- | -------- | -------------------------------------- |
| View ID           | string  | Yes      | The ID of the view to get data from.   |
| Max Age (minutes) | integer | No       | Maximum age of cached data in minutes. |

#### Outputs

| Field     | Type    | Description              |
| --------- | ------- | ------------------------ |
| Columns   | array   | List of column names.    |
| Data      | array   | View data rows.          |
| Row Count | integer | Number of rows returned. |

### Get View Image

Export a Tableau view as a PNG image.

#### Inputs

| Field             | Type    | Required | Description                                |
| ----------------- | ------- | -------- | ------------------------------------------ |
| View ID           | string  | Yes      | The ID of the view to capture as an image. |
| Resolution        | string  | No       | Image resolution (high or standard).       |
| Max Age (minutes) | integer | No       | Maximum age of cached image in minutes.    |
| View Filters      | object  | No       | Filters to apply to the view.              |

#### Outputs

| Field          | Type   | Description                           |
| -------------- | ------ | ------------------------------------- |
| Image (Base64) | string | Base64-encoded PNG image.             |
| View URL       | string | URL to view the dashboard in Tableau. |

### List All Pulse Metric Definitions

List all Tableau Pulse metric definitions.

#### Inputs

| Field      | Type    | Required | Description                                                   |
| ---------- | ------- | -------- | ------------------------------------------------------------- |
| Page Size  | integer | No       | Number of definitions to return (default: 100). Default: 100. |
| Page Token | string  | No       | Token for pagination.                                         |

#### Outputs

| Field              | Type    | Description                         |
| ------------------ | ------- | ----------------------------------- |
| Metric Definitions | array   | List of Pulse metric definitions.   |
| Next Page Token    | string  | Token for retrieving the next page. |
| Total Count        | integer | Number of definitions returned.     |

### List Pulse Metric Definitions by IDs

Get specific Pulse metric definitions by their IDs.

#### Inputs

| Field          | Type   | Required | Description                                    |
| -------------- | ------ | -------- | ---------------------------------------------- |
| Definition IDs | string | Yes      | Comma-separated list of metric definition IDs. |

#### Outputs

| Field              | Type    | Description                       |
| ------------------ | ------- | --------------------------------- |
| Metric Definitions | array   | List of Pulse metric definitions. |
| Total Count        | integer | Number of definitions returned.   |

### List Pulse Metrics by Definition ID

List Pulse metrics for a specific metric definition.

#### Inputs

| Field         | Type    | Required | Description                                               |
| ------------- | ------- | -------- | --------------------------------------------------------- |
| Definition ID | string  | Yes      | The metric definition ID to list metrics for.             |
| Page Size     | integer | No       | Number of metrics to return (default: 100). Default: 100. |
| Page Token    | string  | No       | Token for pagination.                                     |

#### Outputs

| Field           | Type    | Description                         |
| --------------- | ------- | ----------------------------------- |
| Metrics         | array   | List of Pulse metrics.              |
| Next Page Token | string  | Token for retrieving the next page. |
| Total Count     | integer | Number of metrics returned.         |

### List Pulse Metrics by IDs

Get specific Pulse metrics by their IDs.

#### Inputs

| Field      | Type   | Required | Description                                     |
| ---------- | ------ | -------- | ----------------------------------------------- |
| Metric IDs | string | Yes      | Comma-separated list of metric IDs to retrieve. |

#### Outputs

| Field       | Type    | Description                 |
| ----------- | ------- | --------------------------- |
| Metrics     | array   | List of Pulse metrics.      |
| Total Count | integer | Number of metrics returned. |

### List Pulse Metric Subscriptions

List Pulse metric subscriptions, optionally filtered by user or metric.

#### Inputs

| Field      | Type    | Required | Description                                                     |
| ---------- | ------- | -------- | --------------------------------------------------------------- |
| User ID    | string  | No       | Filter subscriptions by user ID.                                |
| Metric ID  | string  | No       | Filter subscriptions by metric ID.                              |
| Page Size  | integer | No       | Number of subscriptions to return (default: 100). Default: 100. |
| Page Token | string  | No       | Token for pagination.                                           |

#### Outputs

| Field           | Type    | Description                         |
| --------------- | ------- | ----------------------------------- |
| Subscriptions   | array   | List of Pulse metric subscriptions. |
| Next Page Token | string  | Token for retrieving the next page. |
| Total Count     | integer | Number of subscriptions returned.   |

### Generate Pulse Metric Insight Bundle

Generate AI-powered insights for a Tableau Pulse metric.

#### Inputs

| Field         | Type   | Required | Description                                               |
| ------------- | ------ | -------- | --------------------------------------------------------- |
| Metric ID     | string | Yes      | The metric ID to generate insights for.                   |
| Definition ID | string | Yes      | The metric definition ID.                                 |
| Metric Name   | string | No       | Display name for the metric (optional).                   |
| Bundle Type   | string | No       | Type of insight bundle (ban, basic, springboard, detail). |

#### Outputs

| Field          | Type   | Description                           |
| -------------- | ------ | ------------------------------------- |
| Metric ID      | string | The metric ID.                        |
| Current Value  | number | Current metric value.                 |
| Previous Value | number | Previous metric value for comparison. |
| Insights       | array  | Generated insights about the metric.  |
| Raw Response   | object | Full raw API response.                |

### Generate Pulse Insight Brief

Generate an AI-powered insight brief for Tableau Pulse metrics.

#### Inputs

| Field         | Type   | Required | Description                                      |
| ------------- | ------ | -------- | ------------------------------------------------ |
| Metric ID     | string | Yes      | The Pulse metric ID.                             |
| Definition ID | string | Yes      | The Pulse metric definition ID.                  |
| Question      | string | Yes      | The question to ask about the metric.            |
| Metric Name   | string | No       | Display name for the metric (optional).          |
| Action Type   | string | No       | Type of response (SUMMARIZE, ANSWER, or ADVISE). |

#### Outputs

| Field               | Type   | Description                            |
| ------------------- | ------ | -------------------------------------- |
| Markup              | string | AI-generated markdown response.        |
| Generation ID       | string | Unique identifier for this generation. |
| Follow-up Questions | array  | Suggested follow-up questions.         |
| Raw Response        | object | Full API response.                     |

### Search Content

Search for workbooks, datasources, views, and other content in Tableau.

#### Inputs

| Field          | Type            | Required | Description                                                                                                                                                         |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search Query   | string          | No       | Search terms to find content.                                                                                                                                       |
| Content Type   | select (string) | No       | Filter by content type. Available values: All Types, Workbook, Datasource, View, Flow, Metric, Collection, Project, Virtual Connection, Database, Table. Default: . |
| Limit          | integer         | No       | Number of results to return (default: 100, max: 2000). Default: 100.                                                                                                |
| Owner IDs      | string          | No       | Comma-separated owner user IDs to filter by.                                                                                                                        |
| Sort By        | string          | No       | Sort method (hitsTotal, hitsSmallSpanTotal, etc.).                                                                                                                  |
| Sort Direction | string          | No       | Sort direction (asc or desc).                                                                                                                                       |

#### Outputs

| Field          | Type    | Description              |
| -------------- | ------- | ------------------------ |
| Search Results | array   | List of search results.  |
| Pagination     | object  | Pagination information.  |
| Total Count    | integer | Total number of results. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/tableau.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
