API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.4.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
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 Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.12.0.cl or later |
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 |
Authentication🔗
Users🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Deletes a user object from ThoughtSpot. | ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Activates a deactivated user account. | ThoughtSpot Cloud: 9.7.0.cl or later | |
| ThoughtSpot Cloud: 9.7.0.cl or later |
System🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.2.0.cl or later | |
Gets details of the current configuration running on your cluster. | ThoughtSpot Cloud: 9.2.0.cl or later |
Orgs🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.2.0.cl or later | |
| ThoughtSpot Cloud: 9.2.0.cl or later | |
| ThoughtSpot Cloud: 9.2.0.cl or later | |
Deletes an Org object from ThoughtSpot. | ThoughtSpot Cloud: 9.2.0.cl or later |
Tags🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Deletes an Org object from ThoughtSpot. | ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Removes the tag assigned to a metadata object. | ThoughtSpot Cloud: 9.0.0.cl or later |
Groups🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Creates a Group object. | ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Removes a group object from ThoughtSpot. | ThoughtSpot Cloud: 9.0.0.cl or later | |
Imports group objects from external databases into ThoughtSpot. | ThoughtSpot Cloud: 9.0.0.cl or later |
Metadata🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Gets SQL query data for the visualizations on a Liveboard. | ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Imports TML representation of the metadata objects into ThoughtSpot. | ThoughtSpot Cloud: 9.0.0.cl or later | |
Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format. | ThoughtSpot Cloud: 9.0.0.cl or later | |
| ThoughtSpot Cloud: 10.1.0.cl or later | |
| ThoughtSpot Cloud: 9.0.0.cl or later |
Reports🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.0.0.cl or later | |
Downloads a saved Answer in PDF, CSV, PNG, or XLSX format. | ThoughtSpot Cloud: 9.0.0.cl or later |
Security🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.0.0.cl or later | |
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 Cloud: 9.0.0.cl or later | |
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 |
Data🔗
API endpoint | Release version | Playground link |
---|---|---|
Generates results for the search query specified in the API request. | ThoughtSpot Cloud: 9.0.0.cl or later | |
Gets details of a Liveboard and its visualizations. | ThoughtSpot Cloud: 9.0.0.cl or later | |
Gets Answer data from ThoughtSpot. You can fetch data for saved Answers only. | ThoughtSpot Cloud: 9.0.0.cl or later |
Audit logs🔗
API endpoint | Release version | Playground link |
---|---|---|
Gets security audit logs from the ThoughtSpot system. | ThoughtSpot Cloud: 9.0.0.cl or later |
Version control🔗
API endpoint | Release version | Playground link |
---|---|---|
| ThoughtSpot Cloud: 9.2.0.cl or later | |
Gets Git commit history for a given metadata object. | ThoughtSpot Cloud: 9.2.0.cl or later | |
| ThoughtSpot Cloud: 9.2.0.cl or later | |
Updates the Git repository settings configured for a ThoughtSpot instance. | ThoughtSpot Cloud: 9.2.0.cl or later | |
Deletes the Git repository configuration. | ThoughtSpot Cloud: 9.2.0.cl or later | |
Commits TML files to the Git branch configured on your instance. | ThoughtSpot Cloud: 9.2.0.cl or later | |
Reverts to a previous commit in the Git branch. | ThoughtSpot Cloud: 9.2.0.cl or later | |
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 | |
Deploys commits to the destination environment ( | ThoughtSpot Cloud: 9.2.0.cl or later |
Connections🔗
API endpoint | Release version | Playground link |
---|---|---|
Gets connection objects from ThoughtSpot. | ThoughtSpot Cloud: 9.2.0.cl or later | |
Creates a connection to the data warehouse specified in the API request. | ThoughtSpot Cloud: 9.2.0.cl or later | |
Updates a connection object. | ThoughtSpot Cloud: 9.2.0.cl or later | |
Deletes a connection object. | ThoughtSpot Cloud: 9.2.0.cl or later | |
| ThoughtSpot Cloud: 9.10.5.cl or later | |
| ThoughtSpot Cloud: 9.10.5.cl or later |
Roles🔗
Early Access
API endpoint | Release version | Playground link |
---|---|---|
Gets Role objects from ThoughtSpot. | ThoughtSpot Cloud: 9.5.0.cl or later | |
Creates a Role with a defined set of privileges. | ThoughtSpot Cloud: 9.5.0.cl or later | |
Updates a Role object. | ThoughtSpot Cloud: 9.5.0.cl or later | |
Deletes a Role object. | ThoughtSpot Cloud: 9.5.0.cl or later |
Custom actions🔗
API endpoint | Release version | Playground link |
---|---|---|
Gets custom action objects. | ThoughtSpot Cloud: 9.6.0.cl or later | |
Creates a custom action and assigns it to a given metadata object. | ThoughtSpot Cloud: 9.6.0.cl or later | |
Updates the properties of a custom action object. | ThoughtSpot Cloud: 9.6.0.cl or later | |
Deletes a custom action. | ThoughtSpot Cloud: 9.6.0.cl or later |
Schedules🔗
API endpoint | Release version | Playground link |
---|---|---|
Creates a Liveboard schedule job. | ThoughtSpot Cloud: 9.4.0.cl or later | |
Gets details of the scheduled Liveboard jobs. | ThoughtSpot Cloud: 9.4.0.cl or later | |
Updates a Liveboard job schedule. | ThoughtSpot Cloud: 9.4.0.cl or later | |
Deletes a scheduled Liveboard job. | ThoughtSpot Cloud: 9.4.0.cl or later |
DBT🔗
API endpoint | Release version | Playground link |
---|---|---|
Creates a DBT connection object in ThoughtSpot. | ThoughtSpot Cloud: 9.10.0.cl or later | |
Creates TML for the given data objects and imports the TML data to ThoughtSpot. | ThoughtSpot Cloud: 9.10.0.cl or later | |
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 | |
Gets a list of DBT connection objects. | ThoughtSpot Cloud: 9.10.0.cl or later | |
Updates a DBT connection object. | ThoughtSpot Cloud: 9.10.0.cl or later |