The ThoughtSpot REST APIs enable your client applications to access data from the ThoughtSpot application. Client applications can use the REST APIs for the following purposes:
- get pinboard and visualization data from the ThoughtSpot application.
- get ThoughtSpot data by programmatically sending a search query.
- list the metadata object and visualization headers in the repository.
- transfer ownership of all objects from one user to another and more.
- embed data from visualizations and pinboards in a web page, portal, or application.
The REST APIs return data as a JSON string. To embed data into your application, extract the data from the JSON file, and render it on your Web page.
REST APIs retrieve live data from ThoughtSpot, so whenever the Web page is rendered, the current values are shown.
To access REST APIs on Swagger:
- Log in to your ThoughtSpot instance as an admin user.
Access the Swagger portal. If you have already logged into your ThoughtSpot instance, use the following URL to access the portal:
The portal displays a list of REST API services available for the logged in ThoughtSpot users.
Click on a header to expand and view the list of services.
- Click on a service name to view more details about the API service.
List of APIs
The following APIs are available on the Swagger portal for ThoughtSpot users.
You can use the user APIs to manage ThoughtSpot users.
||Get all users, groups, and their inter-dependencies.|
||Change the password of a user account.|
||Transfer ownership of all objects from one user to another.|
||Synchronize principal from your client application with ThoughtSpot.|
User group management
You can use the group APIs to configure privileges for user groups.
||Add a privilege to a group.|
||Remove a privilege from a group.|
Authentication and session management
You can use the session APIs to manage ThoughtSpot user sessions.
||Authenticate and log in a user.|
||Log out a user from an existing session.|
||Obtain an authentication token for a user.|
You can use the tml APIs to import and export TML objects.
||Validate and import the TML objects.|
||Export TML objects.|
You can use the data APIs to query and embed data from the ThoughtSpot application.
|Data API||Request URL||Description|
||Fetch the pinboard data from the ThoughtSpot application.|
||Download a pinboard or specific visualizations from a pinboard as a PDF file.|
||List the metadata object headers in the repository|
||Get the visualization headers from the ThoughtSpot system.|
||Search data from a specific data source in the ThoughtSpot application.|