Public API reference

ThoughtSpot has several public APIs.

This reference details all the public ThoughtSpot APIs. The descriptions are aimed to help you solve specific use cases, such as syncing users and groups, or fetching visualization headers.

The following public APIs are available:

Pinboard Data
POST /tspublic/v1/pinboarddata

Get the pinboard data from the ThoughtSpot system.

GET /tspublic/v1/metadata/listobjectheaders

List the metadata object headers in the repository.

GET /tspublic/v1/metadata/listvizheaders

Get the visualization headers from the ThoughtSpot system.

POST /tspublic/v1/session/login

Authenticate and login a user.

POST /tspublic/v1/session/logout

Logout a user out of an existing session.

POST /tspublic/v1/user/transfer/ownership

Transfer ownership of all objects from one user to another.

POST /tspublic/v1/user/sync

Synchronize principal from your external system with ThoughtSpot system.

POST /tspublic/v1/user/updatepassword

Change the password of a user.

GET /tspublic/v1/user/list

Get all users, groups and their inter-dependencies.

POST /tspublic/v1/group/addprivilege

Add a privilege to a group.

POST /tspublic/v1/group/removeprivilege

Remove a privilege from a group.

POST /tspublic/v1/materialization/refreshview/

Re-execute the query and load data into the materialized view.

Search Data
POST /tspublic/v1/searchdata

Search data from a specific data source in the ThoughtSpot system.

See About the REST API for information on how to call and use the REST APIs.

Was this page helpful?