About REST APIs

Starting in December 2021, ThoughtSpot rebranded pinboards as Liveboards. For backward compatibility, we currently support internal processes and external methods that use the older naming convention.

The ThoughtSpot REST API framework lets you programmatically create, access, edit, and manage objects and resources in the ThoughtSpot system.

REST API v1 and v2

ThoughtSpot REST API supports several resource collections and request operations in two distinct versions:

  • REST API v1

    The legacy framework with several endpoints to create, edit, administer and manage ThoughtSpot objects and data.

  • REST API V2

    The REST API v2 Beta framework is a new developer-focused solution that provides additional functionality and an interactive Playground experience. The REST v2 framework also supports language-specific SDK and client libraries.

    The REST API v2 is a limited availability feature and is in Beta. To enable this feature on your instance, contact ThoughtSpot Support.

For more information about the differences between these two REST API versions, see REST API v1 and v2 comparison.

REST API Playground

ThoughtSpot users with Developer or Administrator privileges can access the REST v1 and v2 endpoints in the Developer portal. If the REST API SDK and PlaygroundBETA feature is enabled on your cluster, you can see the REST Playground v1 and REST Playground v2 menu options under REST API in the Develop tab.

The portal provides a separate Playground for each version and lets you explore the API endpoints and make an API call.

Get started

To know how to get started with REST APIs, see the following articles in ThoughtSpot Developer Documentation:

API endpoints

For a complete list of API endpoints and information about how to make an API call to these endpoints, see the following reference pages: