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 purpose:
get the pinboard and visualization data from the ThoughtSpot application.
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 will be shown.
List of APIs
The following APIs are available on the Swagger portal for ThoughtSpot users.
Use the user API to manage 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
Use the group API to manage user groups.
||Add a privilege to a group.|
||Remove a privilege from a group.|
Authentication and session management
Use the session API to manage user sessions.
||Authenticate and log in a user.|
||Log out a user from an existing session.|
Use the following data APIs to embed ThoughtSpot data:
|Data API||Request URL||Description|
||Fetch the pinboard data from the ThoughtSpot application.|
||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.|
To access APIs on Swagger:
Log in to ThoughtSpot as an admin user.
Go to the Swagger portal.
The portal displays a list of REST API services available for 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.