Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
135 commits
Select commit Hold shift + click to select a range
f71d334
edits
ShashiSubramanya Aug 5, 2026
749c248
whats new update
ShashiSubramanya Aug 5, 2026
8e02684
edited for Siddhant's input
rani2655 Aug 6, 2026
c3d2397
edited for Siddhant's input
rani2655 Aug 6, 2026
7196a2d
Merge pull request #520 from thoughtspot/edit-views
rani2655 Aug 6, 2026
2b65142
removed beta label for Coll from nav
rani2655 Aug 7, 2026
549b5ac
Merge pull request #522 from thoughtspot/coll-label
rani2655 Aug 7, 2026
2117f91
SCAL-330848 Replace record_size = -1 guidance with pagination warning
sastaachar Aug 7, 2026
7ebf819
SCAL-295712
ShashiSubramanya Aug 11, 2026
fec4dcc
compact header breaking change
ShashiSubramanya Aug 11, 2026
eb9c784
SCAL-318536
rani2655 Aug 11, 2026
e851383
SCAL-318536
rani2655 Aug 11, 2026
b206ec4
SCAL-330067 updates
ShashiSubramanya Aug 6, 2026
134cf5d
menu and css edits for typedoc files
ShashiSubramanya Aug 6, 2026
9ea4df8
changelog update
ShashiSubramanya Aug 11, 2026
89804e2
changelog edits
ShashiSubramanya Aug 11, 2026
23aaa83
edits
ShashiSubramanya Aug 11, 2026
cdc94a8
edited based on feedback
rani2655 Aug 12, 2026
21fa9bb
collections sdk support
rani2655 Aug 12, 2026
238fb93
highlighted coll changes
rani2655 Aug 12, 2026
db8f9bf
docs: add Snowflake Semantic View integration API reference (SCAL-309…
ShashiSubramanya Aug 12, 2026
d188100
test: verify write access
ShashiSubramanya Aug 17, 2026
a2f4016
docs: add 26.9.0.cl REST API changelog entries (SCAL-306069, SCAL-309…
ShashiSubramanya Aug 17, 2026
0a5ae84
docs: add Visual Embed SDK 1.52.x changelog entries (SCAL-317516, SCA…
ShashiSubramanya Aug 17, 2026
3a06bdb
docs: add Spotter conversation sharing APIs section (aug.26.mt, SCAL-…
ShashiSubramanya Aug 17, 2026
40511ea
docs: add Answer Export API GA documentation (SCAL-306069)
ShashiSubramanya Aug 17, 2026
ba2c7be
added Ramjith's feedback
rani2655 Aug 17, 2026
9da4bed
docs: add 26.9.0.cl REST API changelog section (SCAL-306069, SCAL-309…
ShashiSubramanya Aug 17, 2026
836dee5
docs: add Visual Embed SDK 1.52.x changelog (SCAL-317516, SCAL-314461)
ShashiSubramanya Aug 17, 2026
cc284b2
docs: add conversation sharing APIs to spotter-agent-apis.adoc (aug.2…
ShashiSubramanya Aug 17, 2026
235d418
docs: add Answer Report API GA section to data-report-v2-api.adoc (SC…
ShashiSubramanya Aug 17, 2026
668f2b4
docs: add 26.9.0.cl REST API changelog section (SCAL-306069, SCAL-309…
ShashiSubramanya Aug 17, 2026
508ed74
docs: add Visual Embed SDK 1.52.x changelog (SCAL-317516, SCAL-314461)
ShashiSubramanya Aug 17, 2026
e955874
docs: add conversation sharing APIs to spotter-agent-apis.adoc (aug.2…
ShashiSubramanya Aug 17, 2026
f17f395
docs: add Answer Report API GA section to data-report-v2-api.adoc (SC…
ShashiSubramanya Aug 17, 2026
bc6ae4f
docs: add 26.9.0.cl REST API changelog section — Answer Export GA, Se…
ShashiSubramanya Aug 17, 2026
190dd38
docs: add Visual Embed SDK 1.52.x changelog — overrideHistoryState, H…
ShashiSubramanya Aug 17, 2026
6daae0a
docs: add Answer Report API GA section to data-report-v2-api.adoc — p…
ShashiSubramanya Aug 17, 2026
e974859
docs: add conversation sharing APIs to spotter-agent-apis.adoc — shar…
ShashiSubramanya Aug 17, 2026
02a807b
docs: add conversation sharing APIs to spotter-agent-apis.adoc — shar…
ShashiSubramanya Aug 17, 2026
885e457
docs: add 26.9.0.cl REST API changelog section (SCAL-306069, SCAL-309…
ShashiSubramanya Aug 17, 2026
8b5ea25
docs: add Visual Embed SDK 1.52.x changelog (SCAL-317516, SCAL-314461)
ShashiSubramanya Aug 17, 2026
c152a93
docs: add Answer Report API GA section (SCAL-306069)
ShashiSubramanya Aug 17, 2026
3a1db02
docs: add 26.9.0.cl REST API changelog section (SCAL-306069, SCAL-309…
ShashiSubramanya Aug 17, 2026
fbac5b0
docs: add Visual Embed SDK 1.52.x changelog (SCAL-317516, SCAL-314461)
ShashiSubramanya Aug 17, 2026
de4cf40
docs: add Answer Report API GA section (SCAL-306069)
ShashiSubramanya Aug 17, 2026
b8701b0
docs: add What's New blurb for 26.9.0.cl / aug.26.mt / SDK 1.52.0
ShashiSubramanya Aug 17, 2026
fd3a26d
docs: add What's New blurb for 26.9.0.cl / aug.26.mt / SDK 1.52.0
ShashiSubramanya Aug 17, 2026
6db4094
docs: add What's New blurb for 26.9.0.cl / aug.26.mt / SDK 1.52.0
ShashiSubramanya Aug 17, 2026
4ec9f6d
docs: fix indentation in September 2026 What's New section
ShashiSubramanya Aug 17, 2026
18bb058
docs: fix indentation in September 2026 What's New section
ShashiSubramanya Aug 17, 2026
de530e8
formatting fixes
ShashiSubramanya Aug 17, 2026
3949c7b
objectid
rani2655 Aug 17, 2026
a14f67b
lang corrections
rani2655 Aug 17, 2026
7355110
split the data report apis
rani2655 Aug 18, 2026
b68e57d
Removed trailing beta msg for Coll
rani2655 Aug 12, 2026
04d9800
review changes
rani2655 Aug 12, 2026
70c01c9
SCAL-330028
ShashiSubramanya Aug 14, 2026
64b0735
SCAL-332127
ShashiSubramanya Aug 14, 2026
115b793
removed beta label
ShashiSubramanya Aug 14, 2026
09c2bca
SCAL-331857/SCAL-331862 fixes
ShashiSubramanya Aug 14, 2026
dbde42a
SCAL-313912
rani2655 Aug 3, 2026
7a63ab4
SCAL-313912
rani2655 Aug 3, 2026
78ccd59
SCAL-313912
rani2655 Aug 4, 2026
11d05e9
SCAL-313912
rani2655 Aug 4, 2026
750109f
SCAL-313912
rani2655 Aug 4, 2026
a37e826
review changes
rani2655 Aug 12, 2026
2007dff
search object tool updates
ShashiSubramanya Aug 17, 2026
7587b77
SCAL-331862 updates
ShashiSubramanya Aug 17, 2026
eab0c32
label update
ShashiSubramanya Aug 17, 2026
c0fa330
link and formatting fixes
ShashiSubramanya Aug 18, 2026
6ba8b40
typo fixes
ShashiSubramanya Aug 18, 2026
7593fde
edits
ShashiSubramanya Aug 18, 2026
0bcb139
review comments and typo fixes
ShashiSubramanya Aug 19, 2026
dc9104e
formatting fix
ShashiSubramanya Aug 19, 2026
ef9de7f
edits
ShashiSubramanya Aug 6, 2026
e1bfe2a
split the tml file
rani2655 Aug 19, 2026
28304b0
cleaned up for v1 apis
rani2655 Aug 19, 2026
1091302
API updates
ShashiSubramanya Aug 20, 2026
bd2a8a5
Merge branch '26.9.0.cl' into 26.9-Rani
rani2655 Aug 20, 2026
773dbd0
SCAL-333914
ShashiSubramanya Aug 21, 2026
6c85211
SCAL-333737
rani2655 Aug 21, 2026
90555e5
Spotter API chunking
ShashiSubramanya Aug 24, 2026
ddd7281
user-mgmt-page-formatting-fix
ShashiSubramanya Aug 25, 2026
3ffe396
v2 ref removal, v3 experience update, and formatting fixes
ShashiSubramanya Aug 25, 2026
51abff9
SCAL-334699 fix
ShashiSubramanya Aug 25, 2026
4096991
CSS and tutorial merge
ShashiSubramanya Aug 28, 2026
5c898b7
version updates
ShashiSubramanya Aug 28, 2026
d4de62f
swarnima's feedback
rani2655 Aug 31, 2026
f267c57
Merge pull request #529 from thoughtspot/cdn
rani2655 Aug 31, 2026
a2371e0
edits
ShashiSubramanya Aug 31, 2026
42798ea
spotterviz updates
ShashiSubramanya Aug 31, 2026
64e4b62
removed redundant text
ShashiSubramanya Sep 1, 2026
76d94de
spotterviz updates
ShashiSubramanya Aug 31, 2026
61a13b6
removed redundant text
ShashiSubramanya Sep 1, 2026
afca943
changelog and other edits
ShashiSubramanya Sep 1, 2026
68ed357
Merge pull request #526 from thoughtspot/docs/26-9-0.cl
ShashiSubramanya Sep 1, 2026
3298a56
Merge pull request #524 from thoughtspot/26.9-Rani
ShashiSubramanya Sep 1, 2026
094721e
merging updates from the 26.9.0.cl branch
ShashiSubramanya Sep 1, 2026
2d21ae3
minor edits
rani2655 Sep 1, 2026
9d6804c
nav updates
ShashiSubramanya Sep 2, 2026
3d3e466
edit wrt answer report api
rani2655 Sep 2, 2026
fba7bcc
edits
rani2655 Sep 2, 2026
79231be
minor tweaks
rani2655 Sep 2, 2026
e1bcfeb
minor tweaks
rani2655 Sep 2, 2026
4036cba
edits
ShashiSubramanya Sep 2, 2026
ca6325d
spotter customization article revamp
ShashiSubramanya Sep 2, 2026
3053994
broken xrefs fixed
rani2655 Sep 2, 2026
f1b44a7
Siddhant's feedback
rani2655 Sep 2, 2026
aa2e0ca
Siddhant's feedback
rani2655 Sep 2, 2026
4791037
minor tweak
rani2655 Sep 2, 2026
6ca8238
26-9-0 edits
ShashiSubramanya Sep 3, 2026
ae75f5e
whats new and other edits
ShashiSubramanya Sep 3, 2026
e08e872
prerender update
ShashiSubramanya Sep 3, 2026
4a65feb
prerender update
ShashiSubramanya Sep 3, 2026
51c0b75
typo fixes and edits
ShashiSubramanya Sep 3, 2026
f33e5d2
edits
ShashiSubramanya Sep 3, 2026
3df1d3f
prerender update
ShashiSubramanya Sep 3, 2026
54ad5b0
SCAL-323201, SCAL-317726 edits
ShashiSubramanya Sep 3, 2026
231ecd3
removed yellow highlights
rani2655 Sep 4, 2026
21d847c
Spotter and other updates
ShashiSubramanya Sep 4, 2026
cd97f43
Merge pull request #539 from thoughtspot/doc-updates-26.9.0.cl
ShashiSubramanya Sep 4, 2026
983336b
Merge branch 'main' into 26.9.0.cl
ShashiSubramanya Sep 4, 2026
032abc0
admonition style update
ShashiSubramanya Sep 5, 2026
881ba12
rest api deprecation note
ShashiSubramanya Sep 5, 2026
5d58e75
edits to spotter pages
ShashiSubramanya Sep 7, 2026
ae6a9a1
title update
ShashiSubramanya Sep 7, 2026
108cecb
feedback changes
rani2655 Sep 7, 2026
0238c65
edits
rani2655 Sep 7, 2026
ca6732f
edits to import
rani2655 Sep 7, 2026
d1f6916
nav edits
ShashiSubramanya Sep 7, 2026
e888657
prerender update
ShashiSubramanya Sep 7, 2026
25ca0c3
Update prerender.adoc
ShashiSubramanya Sep 7, 2026
9442cda
prerender fixes
ShashiSubramanya Sep 8, 2026
11aca39
granular download priv GA
rani2655 Sep 8, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/pages/.write-test
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
write access test - delete me
62 changes: 46 additions & 16 deletions modules/ROOT/pages/about-rest-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,56 @@

:page-title: ThoughtSpot REST APIs
:page-pageid: rest-apis
:page-description: ThoughtSpot REST API provides service endpoints for administration, embedding, and data management.
:page-description: ThoughtSpot REST APIs let you programmatically manage users, groups, and metadata objects, query data, and automate deployments. The REST API v2.0 framework is the current standard for all integrations.

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

ThoughtSpot REST API supports several resource collections and operations in two distinct versions:
== 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:

* REST API v1
+
The legacy framework with several endpoints to create, edit, administer and manage ThoughtSpot objects and data.
* *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.

* REST API v2.0
If you want to embed interactive ThoughtSpot components such as Liveboards, Search, or Spotter in your application, use the xref:getting-started.adoc[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 xref:rest-api-v2-reference.adoc[API endpoints] with enhanced functionality and provides an interactive Playground for ease of use.

* REST API v1 (Deprecated) +
The xref:rest-api-reference.adoc[legacy REST v1 endpoints] to create, edit, administer and manage ThoughtSpot objects and data.
+
The REST API v2.0 framework provides enhanced functionality and improved API experience with an interactive Playground.
include::{path}/rest-apiv1-deprecation-note.adoc[]

For more information about the differences between these two REST API versions, see xref:rest-api-v1v2-comparison.adoc[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 link:https://try-everywhere.thoughtspot.cloud/v2/#/everywhere/api/rest/playgroundV2_0[ThoughtSpot public instance, window=_blank].

ThoughtSpot users with Developer or Administrator privileges can access the REST API v1 and v2.0 endpoints in the *Develop* tab. The portal provides a separate Playground for each REST API version and lets you explore the API endpoints, request and response workflows.
In the Playground, you can:

* To try out the xref:rest-api-v1.adoc[REST API v1 endpoints], click **REST Playground v1**. +
* To access the xref:rest-api-v2.adoc[REST API v2 Playground], click **REST Playground v2.0**.
* 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.
Expand All @@ -37,11 +65,13 @@ These rate limits are enforced by default on all ThoughtSpot instances. Currentl

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

//ThoughtSpot administrators can monitor logs, add or update rate limits via TSCLI, and adjust these settings for different environments (dev or prod) as required.
== REST API SDKs

== 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:
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 xref:rest-api-sdk-libraries.adoc[REST API SDK libraries].

* xref:rest-api-reference.adoc[REST API v1 Reference]
* xref:rest-api-v2-reference.adoc[REST API v2.0 Reference]
== Related information

* xref:rest-api-v2-getstarted.adoc[Get started with REST API v2.0]
* xref:rest-api-v2-reference.adoc[REST API v2.0 reference]
* xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]
* xref:rest-api-sdk-libraries.adoc[REST API SDK libraries]
8 changes: 5 additions & 3 deletions modules/ROOT/pages/admin-api.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
= Admin APIs
= REST API v1 - Admin API endpoints
:toc: true
:toclevels: 1

:page-title: Admin APIs
:page-pageid: admin-api
:page-pageid: admin-api-v1
:page-description: The admin API endpoints allow you to view, edit, and manage your cluster configuration

The admin API service allows you to query and update configuration information for a ThoughtSpot cluster. You can also use these APIs to migrate data from one cluster to another.
include::{path}/rest-apiv1-deprecation-note.adoc[]


== Supported operations
The admin API service allows you to query and update configuration information for a ThoughtSpot cluster. You can also use these APIs to migrate data from one cluster to another.

include::{path}/admin-api-list.adoc[]

Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/api-auth-session.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
:page-pageid: api-auth-session
:page-description: To access ThoughtSpot objects and resource endpoints, authenticate and log in to the ThoughtSpot system

include::{path}/rest-apiv1-deprecation-note.adoc[]

To create, access, and modify ThoughtSpot objects and resources through the REST API, you must log in as an authorized user. A successful login operation returns session cookies from the ThoughtSpot system, which must be included in subsequent REST API calls.

When using the REST API through a web browser, ThoughtSpot recommends that you use the xref:configure-saml.adoc[SAML SSO] or xref:trusted-authentication.adoc[trusted authentication] service to authenticate to ThoughtSpot. A successful login using the Visual Embed SDK via either of those two methods will establish the session within the web browser.
Expand Down
Loading
Loading