REST API v2.0 Reference

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

Try it out

Try it out

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.

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.

Try it out

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

Try it out

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

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/users/search
Gets details of one or several ThoughtSpot users.

Try it out

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

Try it out

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

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.

Try it out

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

Try it out

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

Try it out

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

Try it out

POST /api/rest/2.0/users/activate

Activates a deactivated user account.

Try it out

Try it out

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

Try it out

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

Try it out

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

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

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

Try it out

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

Try it out

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

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

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

Try it out

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

Try it out

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

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.

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

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

Try it out

POST /api/rest/2.0/groups/create

Creates a Group object.

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.

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.

Try it out

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

Try it out

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

Gets SQL query data for the visualizations on a Liveboard.

Try it out

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

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.

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.

Try it out

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

Try it out

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

Try it out

POST /api/rest/2.0/report/answer

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

Try it out

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.

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.

Try it out

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

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

POST /api/rest/2.0/searchdata

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

Try it out

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

Gets details of a Liveboard and its visualizations.

Try it out

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

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

Try it out

POST /api/rest/2.0/logs/fetch

Gets security audit logs from the ThoughtSpot system.

Try it out

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

Try it out

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

Gets Git commit history for a given metadata object.

Try it out

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

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.

Try it out

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

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

Try it out

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

Reverts to a previous commit in the Git branch.

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.

Try it out

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

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

Try it out

POST /api/rest/2.0/connection/search

Gets connection objects from ThoughtSpot.

Try it out

POST /api/rest/2.0/connection/create

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

Try it out

POST /api/rest/2.0/connection/update

Updates a connection object.

Try it out

POST /api/rest/2.0/connection/delete

Deletes a connection object.

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.

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.

Try it out

POST /api/rest/2.0/roles/search

Gets Role objects from ThoughtSpot.

Try it out

POST /api/rest/2.0/roles/create

Creates a Role with a defined set of privileges.

Try it out

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

Updates a Role object.

Try it out

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

Deletes a Role object.

Try it out

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

Gets custom action objects.

Try it out

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

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

Try it out

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

Updates the properties of a custom action object.

Try it out

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

Deletes a custom action.

Try it out

POST /api/rest/2.0/schedules/create

Creates a Liveboard schedule job.

Try it out

POST /api/rest/2.0/schedules/search

Gets details of the scheduled Liveboard jobs.

Try it out

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

Updates a Liveboard job schedule.

Try it out

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

Deletes a scheduled Liveboard job.

Try it out

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

Creates a DBT connection object in ThoughtSpot.

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.

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.

Try it out

POST /api/rest/2.0/dbt/search

Gets a list of DBT connection objects.

Try it out

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

Updates a DBT connection object.

Try it out