REST API v2.0 Reference

REST API v2.0 Reference

This API Reference page lists the REST API v2.0 endpoints and provides basic information about the resource URLs and supported operations. If you want to try out these APIs, view detailed documentation, and download code samples, visit the REST API v2.0 Playground.

Note

Access to ThoughtSpot data is controlled based on user privileges and object-level permissions. Some operations are available to all users and may require at least view access to the metadata object. ThoughtSpot users are assigned access privileges based on the group to which they belong. Additionally, object owners can control access to a metadata object using MODIFY (Can edit), READ_ONLY (Can view), or NO_ACCESS permission when sharing an object with other users and groups.

Authentication🔗

API endpointRelease versionPlayground link

GET /api/rest/2.0/auth/session/user
Gets session information for the currently logged-in user.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

GET /api/rest/2.0/auth/session/token
Gets the authentication token used by the currently logged-in user.

ThoughtSpot Cloud: 9.4.0.cl or later
ThoughtSpot Software: 9.5.1.sw or later

Try it out

POST /api/rest/2.0/auth/session/login
Creates a login session for a ThoughtSpot user.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/auth/token/object

Gets an authentication token that grants access only to the metadata object specified in the API request.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/auth/token/full
Gets an authentication token from ThoughtSpot that grants access to a full application session.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/auth/session/logout
Logs out the currently logged-in user.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/auth/token/revoke
Revokes authentication token granted for a user.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/auth/token/validate
Validates the authentication token specified in the API request.

ThoughtSpot Cloud: 9.12.0.cl or later
ThoughtSpot Software: 10.0.0.sw or later

Try it out

POST /api/rest/2.0/auth/token/custom
Generates an authentication token with pre-defined RLS rules and filter attributes for a user.

ThoughtSpot Cloud: 10.4.0.cl or later
ThoughtSpot Software: 10.7.0.sw or later

Try it out

Users🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/users/search
Gets details of one or several ThoughtSpot users.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/users/create
Creates a user.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/users/{user_identifier}/update
Updates the properties of a user object.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/users/{user_identifier}/delete

Deletes a user object from ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/users/import
Gets an authentication token from ThoughtSpot that grants access to a full application session.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/users/change-password
Allows ThoughtSpot users to change the password of their account.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/users/reset-password
Resets the password of a user account.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/users/force-logout
Logs out a users from their current sessions.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/users/activate

Activates a deactivated user account.

ThoughtSpot Cloud: 9.7.0.cl or later
ThoughtSpot Software: 9.8.0.sw or later

Try it out

POST /api/rest/2.0/users/deactivate
Deactivates a user account.

ThoughtSpot Cloud: 9.7.0.cl or later
ThoughtSpot Software: 9.8.0.sw or later

Try it out

System🔗

API endpointRelease versionPlayground link

Get System Information
Gets system information of your current logged-in cluster.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

GET /api/rest/2.0/system
Gets details of the current configuration running on your cluster.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

GET /api/rest/2.0/system/config-overrides
Gets details of the configuration overrides on your cluster.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/system/config-update

Gets details of the current configuration running on your cluster.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.1.sw or later

Try it out

Orgs🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/orgs/search
Gets a list of Orgs configured on the ThoughtSpot system.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: Not Applicable

Try it out

POST /api/rest/2.0/orgs/create
Creates an Org object.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: Not Applicable

Try it out

POST /api/rest/2.0/orgs/{org_identifier}/update
Modifies the object properties of an Org.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: Not Applicable

Try it out

POST /api/rest/2.0/orgs/{org_identifier}/delete

Deletes an Org object from ThoughtSpot.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: Not Applicable

Try it out

Tags🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/tags/search
Gets details of tag objects from ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/tags/create
Creates a tag object in ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/tags/{tag_identifier}/update
Modifies the object properties of a tag.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/tags/{tag_identifier}/delete

Deletes an Org object from ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/tags/assign
Assigns a tag to metadata objects.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/tags/unassign

Removes the tag assigned to a metadata object.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

Groups🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/groups/search
Gets details of one or several Groups.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/groups/create

Creates a Group object.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/groups/{group_identifier}/update
Updates the object properties of a group. You can also use this API to add or remove users, sub-groups, and privileges.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/groups/{group_identifier}/delete

Removes a group object from ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/groups/import

Imports group objects from external databases into ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

Metadata🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/metadata/search
Gets details of metadata objects from ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/metadata/tml/async/status
Gets status details for scheduled TML import tasks.

ThoughtSpot Cloud: 10.4.0.cl or later
ThoughtSpot Software: 10.7.0.sw or later

Try it out

POST /api/rest/2.0/metadata/liveboard/sql

Gets SQL query data for the visualizations on a Liveboard.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/metadata/answer/sql
Gets SQL query data for a saved Answer.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/metadata/tml/async/import

Schedules an asynchronous TML import task for the given objects.

ThoughtSpot Cloud: 10.4.0.cl or later
ThoughtSpot Software: 10.7.0.sw or later

Try it out

POST /api/rest/2.0/metadata/tml/import

Imports TML representation of the metadata objects into ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/metadata/tml/export

Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/metadata/tml/export/batch
Exports a complete set of TML for user, user group, or Role object.

ThoughtSpot Cloud: 10.1.0.cl or later
ThoughtSpot Software: 10.1.0.sw or later

Try it out

POST /api/rest/2.0/metadata/delete Removes a metadata object.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

Reports🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/report/liveboard
Exports a Liveboard and its visualizations as a PDF, CSV, XLSX, or PNG file.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/report/answer

Downloads a saved Answer in PDF, CSV, PNG, or XLSX format.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

Security🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/security/principals/fetch-permissions
Gets a list of objects that a user or group has access to. You can also specify the metadata type in the API request to fetch user permission details for Liveboards, Worksheets, or Answers.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/security/metadata/fetch-permissions

Gets access permission details for metadata objects. To get object access details for a user or group, specify the user or group identifiers.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/security/metadata/assign
Assigns a new author or changes the author of a metadata object.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/security/metadata/share

Allows sharing metadata objects, such as Liveboards, saved Answers, and Worksheets with another user or group in ThoughtSpot.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

Data🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/searchdata

Generates results for the search query specified in the API request.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/metadata/liveboard/data

Gets details of a Liveboard and its visualizations.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

POST /api/rest/2.0/metadata/answer/data

Gets Answer data from ThoughtSpot. You can fetch data for saved Answers only.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: 9.0.1.sw or later

Try it out

Audit logs🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/logs/fetch

Gets security audit logs from the ThoughtSpot system.

ThoughtSpot Cloud: 9.0.0.cl or later
ThoughtSpot Software: Not applicable

Try it out

Version control🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/vcs/git/config/search
Gets Git repository connections configured on the ThoughtSpot instance.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/vcs/git/commits/search

Gets Git commit history for a given metadata object.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/vcs/git/config/create
Connects your ThoughtSpot instance to a Git repository.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/vcs/git/config/update

Updates the Git repository settings configured for a ThoughtSpot instance.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/vcs/git/config/delete

Deletes the Git repository configuration.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/vcs/git/branches/commit

Commits TML files to the Git branch configured on your instance.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/vcs/git/commits/{commit_id}/revert

Reverts to a previous commit in the Git branch.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/vcs/git/branches/validate

Validates the content of your source branch against the objects in your destination environment and identifies merge conflicts.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/vcs/git/commits/deploy

Deploys commits to the destination environment (Staging or Production).

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

Connections🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/connection/search

Gets connection objects from ThoughtSpot.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/connection/create

Creates a connection to the data warehouse specified in the API request.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/connection/update DEPRECATED

Updates a connection object.

Note: This API endpoint is deprecated in ThoughtSpot 10.4.0.cl and later versions. To update a connection, use /api/rest/2.0/connections/update/{connection_identifier}.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/connections/{connection_identifier}/update
Updates a connection object.

ThoughtSpot Cloud: 10.4.0.cl or later
ThoughtSpot Software: 10.7.0.sw or later

Try it out

POST /api/rest/2.0/connection/delete DEPRECATED
Deletes a connection object.

Note: This API endpoint is deprecated in ThoughtSpot 10.4.0.cl and later versions. To delete a connection, use api/rest/2.0/connections/delete/{connection_identifier}.

ThoughtSpot Cloud: 9.2.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/connections/{connection_identifier}/delete
Deletes a connection

ThoughtSpot Cloud: 10.4.0.cl or later
ThoughtSpot Software: 10.7.0.sw or later

Try it out

POST /api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier}
Validates the connection metadata differences between Cloud Data Warehouse and ThoughtSpot.

ThoughtSpot Cloud: 9.10.5.cl or later
ThoughtSpot Software: 10.0.0.sw or later

Try it out

POST /api/rest/2.0/connections/download-connection-metadata-changes/{connection_identifier}
Downloads connection metadata differences between Cloud Data Warehouse and ThoughtSpot.

ThoughtSpot Cloud: 9.10.5.cl or later
ThoughtSpot Software: 10.0.0.sw or later

Try it out

Roles🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/roles/search

Gets Role objects from ThoughtSpot.

ThoughtSpot Cloud: 9.5.0.cl or later
ThoughtSpot Software: Not applicable

Try it out

POST /api/rest/2.0/roles/create

Creates a Role with a defined set of privileges.

ThoughtSpot Cloud: 9.5.0.cl or later
ThoughtSpot Software: Not applicable

Try it out

POST /api/rest/2.0/roles/{role_identifier}/update

Updates a Role object.

ThoughtSpot Cloud: 9.5.0.cl or later
ThoughtSpot Software: Not applicable

Try it out

POST /api/rest/2.0/roles/{role_identifier}/delete

Deletes a Role object.

ThoughtSpot Cloud: 9.5.0.cl or later
ThoughtSpot Software: Not applicable

Try it out

Custom actions🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/customization/custom-actions/search

Gets custom action objects.

ThoughtSpot Cloud: 9.6.0.cl or later
ThoughtSpot Software: 9.8.0.sw or later

Try it out

POST /api/rest/2.0/customization/custom-actions

Creates a custom action and assigns it to a given metadata object.

ThoughtSpot Cloud: 9.6.0.cl or later
ThoughtSpot Software: 9.8.0.sw or later

Try it out

POST /api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update

Updates the properties of a custom action object.

ThoughtSpot Cloud: 9.6.0.cl or later
ThoughtSpot Software: 9.8.0.sw or later

Try it out

POST /api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete

Deletes a custom action.

ThoughtSpot Cloud: 9.6.0.cl or later
ThoughtSpot Software: 9.8.0.sw or later

Try it out

Schedules🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/schedules/create

Creates a Liveboard schedule job.

ThoughtSpot Cloud: 9.4.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/schedules/search

Gets details of the scheduled Liveboard jobs.

ThoughtSpot Cloud: 9.4.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/schedules/{schedule_identifier}/update

Updates a Liveboard job schedule.

ThoughtSpot Cloud: 9.4.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

POST /api/rest/2.0/schedules/{schedule_identifier}/delete

Deletes a scheduled Liveboard job.

ThoughtSpot Cloud: 9.4.0.cl or later
ThoughtSpot Software: 9.5.0.sw or later

Try it out

DBT🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/dbt/dbt-connection

Creates a DBT connection object in ThoughtSpot.

ThoughtSpot Cloud: 9.10.0.cl or later
ThoughtSpot Software: 10.0.0.sw or later

Try it out

POST /api/rest/2.0/dbt/generate-tml

Creates TML for the given data objects and imports the TML data to ThoughtSpot.

ThoughtSpot Cloud: 9.10.0.cl or later
ThoughtSpot Software: 10.0.0.sw or later

Try it out

POST /api/rest/2.0/dbt/generate-sync-tml

Resynchronizes the existing list of Models, Tables, and Worksheet TML content for the specified DBT connection object and imports these to Thoughtspot.

ThoughtSpot Cloud: 9.10.0.cl or later
ThoughtSpot Software: 10.0.0.sw or later

Try it out

POST /api/rest/2.0/dbt/search

Gets a list of DBT connection objects.

ThoughtSpot Cloud: 9.10.0.cl or later
ThoughtSpot Software: 10.0.0.sw or later

Try it out

POST /api/rest/2.0/dbt/{dbt_connection_identifier}

Updates a DBT connection object.

ThoughtSpot Cloud: 9.10.0.cl or later
ThoughtSpot Software: 10.0.0.sw or later

Try it out

AI Beta🔗

API endpointRelease versionPlayground link

POST /api/rest/2.0/ai/conversation/create
Creates a conversation session with ThoughtSpot Spotter, your AI Analyst.

ThoughtSpot Cloud: 10.4.0.cl or later
ThoughtSpot Software: Not available

Try it out

POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse
Generates responses to user queries and follow-up questions sent in the specified conversation session.

ThoughtSpot Cloud: 10.4.0.cl or later
ThoughtSpot Software: Not available

Try it out

POST /api/rest/2.0/ai/answer/create
Generates an Answer for a Natural Language Search query.

ThoughtSpot Cloud: 10.4.0.cl or later
ThoughtSpot Software: Not available

Try it out