ThoughtSpot REST APIs

Table of Contents

Overview
When to use REST APIs
REST API versions
REST API Playground
Rate limits for API requests
REST API SDKs
Related information

The ThoughtSpot REST API framework lets you create, access, and manage ThoughtSpot resources programmatically.

Overview🔗

You can use REST APIs to integrate ThoughtSpot capabilities into your applications and automate workflows, without going through the ThoughtSpot UI. ThoughtSpot REST API endpoints allow you to:

Manage users, groups, and roles. Create and manage user accounts, define groups and privileges, and automate provisioning workflows.
Authenticate and manage sessions. Get authentication tokens for users, including tokens for embedded application users with trusted authentication.
Manage metadata objects. Search, create, update, and delete objects such as Liveboards, Answers, Models, Worksheets, and Tables. Import and export objects as ThoughtSpot Modeling Language (TML) representations.
Query data. Run search queries against your data and fetch Liveboard, Answer, and visualization data in your application.
Export reports. Download Liveboards and Answers in PDF, PNG, CSV, or XLSX formats.
Automate deployments. Move content between environments and Orgs with TML and version control APIs, and manage multi-tenant deployments.
Administer your instance. Configure Orgs, manage connections, set up custom actions, audit activity with system logs, and manage instance settings.
Work with AI and Spotter. Create Spotter conversations, send messages, manage Spotter memory, and share conversations programmatically.

When to use REST APIs🔗

Use REST APIs when you need to:

Automate administration tasks such as user provisioning, group management, or scheduled content deployment.
Fetch data from ThoughtSpot into your own application or service, without embedding ThoughtSpot UI components.
Build deployment pipelines that promote content across development, staging, and production environments.
Integrate ThoughtSpot operations into external systems, such as CI/CD tooling, orchestration services, or custom portals.

If you want to embed interactive ThoughtSpot components such as Liveboards, Search, or Spotter in your application, use the Visual Embed SDK. The Visual Embed SDK and REST APIs are complementary; embedded applications commonly use REST APIs alongside the SDK for tasks such as token issuance for trusted authentication and metadata automation.

REST API versions🔗

ThoughtSpot REST APIs are available in the following versions:

REST API v2.0 (Recommended)
The REST API v2 framework includes a wider set of API endpoints with enhanced functionality and provides an interactive Playground for ease of use.

REST API v1 (Deprecated)
The legacy REST v1 endpoints to create, edit, administer and manage ThoughtSpot objects and data.

Important

The REST API v1 endpoints are deprecated and replaced with the REST API v2 endpoints. Your existing integrations with REST API v1 endpoints will continue to function without disruption until further notice. ThoughtSpot strongly recommends migrating your integrations to the REST API v2 endpoints.

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

REST API Playground🔗

ThoughtSpot provides an interactive playground to explore and try out API workflows on your own instance or ThoughtSpot trial instance.

To view the Playground, go to Develop > REST API > REST Playground v2.0 in your ThoughtSpot instance, or use the ThoughtSpot public instance.

In the Playground, you can:

Browse endpoints by resource category and view request and response schemas.
Try API requests against your instance and inspect live responses.
View and copy generated code samples for your requests.

Rate limits for API requests🔗

To ensure API stability, optimize resource usage, and maintain service quality for all users, ThoughtSpot limits the number of public API requests allowed per client to prevent excessive requests from reaching application servers.

By default, on instances running 26.2.0.cl and later, a global rate limit of 100 requests per second per client IP is enforced at the cluster level for all public APIs. This limit is applied per client IP across all public APIs combined, not per endpoint. If a client IP exceeds this combined rate limit, a burst of 10 additional API requests is allowed before rejecting the requests with the 'HTTP 429: Too Many Requests' error.

For async status endpoints such as /api/rest/2.0/metadata/tml/async/status, up to 100 requests per minute per client IP are allowed, with a burst of 100 requests before requests are rejected with an HTTP 429 error.

These rate limits are enforced by default on all ThoughtSpot instances. Currently, rate limits are applied at the cluster level; Org-level rate limits are not supported.

To update rate limits or adjust the rate limit settings for your dev or prod environment, contact ThoughtSpot Support.

REST API SDKs🔗

To integrate v2.0 APIs into your applications faster, ThoughtSpot provides SDK libraries in several languages, including TypeScript and Python. The SDKs wrap endpoint calls, authentication, and typed request and response models. For more information, see REST API SDK libraries.