> 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/thoughtspot.md).

# ThoughtSpot

Connect to ThoughtSpot to search and explore analytics metadata such as Liveboards, Answers, Worksheets, and Tables.

## Connectors

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

| Connector   | Authentication |
| ----------- | -------------- |
| ThoughtSpot | Credentials    |

### ThoughtSpot

Connect to ThoughtSpot to search and explore analytics metadata such as Liveboards, Answers, Worksheets, and Tables.

#### Set up in ThoughtSpot

1. Prepare the ThoughtSpot account or service that the workflow will access. Grant access to the required resources and operations.
2. **Access Token:** A pre-generated bearer token (from the REST API playground or a token-request service). Use this for SSO/Google accounts that have no password. Provide either a Password or an Access Token. Note: tokens are short-lived and cannot be auto-refreshed — the connection stops working when the token expires.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **ThoughtSpot**.
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                                                                                                                                                                                                                                                                                                  |
| -------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Instance URL   | Yes                      | The base URL of your ThoughtSpot instance, including https\:// and no trailing path (e.g. <https://my-company.thoughtspot.cloud>). This is the address shown in your browser when you are signed in to ThoughtSpot. [Provider instructions](https://developers.thoughtspot.com/docs/api-authv2).               |
| Username       | Optional / as applicable | The ThoughtSpot username (often an email) to authenticate as. Required when authenticating with a Password; leave blank when supplying an Access Token. For automated workflows, prefer a dedicated service account over a personal login.                                                                     |
| Password       | Optional / as applicable | The password for the username above. Used to mint a short-lived bearer token automatically. Provide either a Password or an Access Token; if both are set, the Access Token takes precedence.                                                                                                                  |
| Access Token   | Optional / as applicable | A pre-generated bearer token (from the REST API playground or a token-request service). Use this for SSO/Google accounts that have no password. Provide either a Password or an Access Token. Note: tokens are short-lived and cannot be auto-refreshed — the connection stops working when the token expires. |
| Org Identifier | Optional / as applicable | Optional organization ID for multi-org instances. Must be a numeric ID. Leave blank to use the primary org.                                                                                                                                                                                                    |

### 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 **ThoughtSpot** 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

### Search Metadata

Search for ThoughtSpot objects such as Liveboards, Answers, Worksheets, and Tables, with optional filtering by tag, creator, and name.

#### Inputs

| Field                  | Type            | Required | Description                                                                                                                                                          |
| ---------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Object Type            | select (string) | Yes      | The type of ThoughtSpot object to search for. Available values: Liveboard, Answer, Table / Worksheet, Column, Connection, Tag, User, User Group. Default: LIVEBOARD. |
| Name or ID             | string          | No       | Optional name or GUID of a specific object. Leave empty to list all objects of the selected type.                                                                    |
| Tags                   | array           | No       | Optional list of tag names or GUIDs. Objects carrying any of these tags match.                                                                                       |
| Created By             | array           | No       | Optional list of usernames or GUIDs to filter by object creator.                                                                                                     |
| Include Details        | boolean         | No       | Include the full structural detail of each object. Default: false.                                                                                                   |
| Include Stats          | boolean         | No       | Include usage statistics for each object. Default: false.                                                                                                            |
| Include Hidden Objects | boolean         | No       | Include objects that are normally hidden. Default: false.                                                                                                            |
| Offset                 | integer         | No       | The starting offset for pagination. Default: 0.                                                                                                                      |
| Limit                  | integer         | No       | The maximum number of records to return. Default: 10.                                                                                                                |

#### Outputs

| Field   | Type        | Description                           |
| ------- | ----------- | ------------------------------------- |
| Results | dict\_array | The list of matched metadata objects. |
| Count   | number      | The number of objects returned.       |

## 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/thoughtspot.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.
