Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
efe570b
edits for review comments
ShashiSubramanya Dec 15, 2025
bf4d14e
draft
ShashiSubramanya Dec 19, 2025
ed80853
edits
ShashiSubramanya Dec 29, 2025
3eeebf6
edits
ShashiSubramanya Jan 6, 2026
f69ae3d
spotter-api and other edits
ShashiSubramanya Jan 7, 2026
95031a2
link fixes
ShashiSubramanya Jan 7, 2026
6fde79b
edits
ShashiSubramanya Jan 8, 2026
1486fd9
skill updates
ShashiSubramanya Jan 13, 2026
21e072c
SCAL-289827
ShashiSubramanya Jan 9, 2026
63eb665
edits
ShashiSubramanya Jan 13, 2026
79b9f58
lb report csv xlsx
rani2655 Jan 15, 2026
85c6831
API for security settings
rani2655 Jan 15, 2026
deb0ee2
whatsnew and changelog
rani2655 Jan 15, 2026
7d4a0d5
edits to lb report
rani2655 Jan 16, 2026
4894dd3
lb report feedback edits
rani2655 Jan 16, 2026
7a1e760
lb report feedback edits
rani2655 Jan 16, 2026
013011c
SpotterCode docs
ShashiSubramanya Jan 18, 2026
84bbfc2
Merge branch '26.2.0.cl' into Spottercode-docs
ShashiSubramanya Jan 18, 2026
8af1f34
edits
ShashiSubramanya Jan 18, 2026
05d0f99
edits
ShashiSubramanya Jan 18, 2026
be22669
added api payload for security settings
rani2655 Jan 18, 2026
1abec23
typo fixes
ShashiSubramanya Jan 19, 2026
896d8dc
formatting fixes
ShashiSubramanya Jan 19, 2026
1f37853
added api payload for security settings
rani2655 Jan 19, 2026
5c09cf0
added api payload for security settings
rani2655 Jan 19, 2026
f420b36
corrected level for heading
rani2655 Jan 19, 2026
efa3025
edits
ShashiSubramanya Jan 19, 2026
853d4ce
edited code examples
rani2655 Jan 19, 2026
0935080
edited code examples and lb report
rani2655 Jan 19, 2026
c2ce152
edited spacing in lb report
rani2655 Jan 19, 2026
a1cda59
review feedback
rani2655 Jan 19, 2026
682d11a
typo
rani2655 Jan 19, 2026
6712f6e
edited admin access
rani2655 Jan 20, 2026
542f647
edits
ShashiSubramanya Jan 20, 2026
6ed88ce
added security settings apis to v2 ref
rani2655 Jan 21, 2026
42505ef
removed #
rani2655 Jan 21, 2026
bde9480
added beta label for security apis
rani2655 Jan 21, 2026
6520ec1
edited changelog
rani2655 Jan 21, 2026
9430277
removed beta label for security apis
rani2655 Jan 22, 2026
c20e083
removed beta label for security apis
rani2655 Jan 22, 2026
6d43236
version update
ShashiSubramanya Jan 19, 2026
afa05f4
edits
ShashiSubramanya Jan 19, 2026
46a4416
v1, v2, and v3 images for clarity
ShashiSubramanya Jan 20, 2026
9d6a411
rls example fixes
ShashiSubramanya Jan 20, 2026
e22dcb5
spotter-update
ShashiSubramanya Jan 9, 2026
492db31
SCAL-281811 documentation fix
ShashiSubramanya Jan 22, 2026
0807e60
SCAL-291802
ShashiSubramanya Jan 22, 2026
4bb50aa
copyright update
ShashiSubramanya Jan 22, 2026
92cd118
Spotter updates
ShashiSubramanya Jan 29, 2026
c74b089
Spotter updates, cluster level rate limit, publishing doc updates
ShashiSubramanya Jan 30, 2026
66fcb57
26.2.0.cl merge
ShashiSubramanya Jan 30, 2026
b30fadc
reorganized content, troubleshooting tips
ShashiSubramanya Jan 31, 2026
2c052fe
copy button and style updates for the prompt examples table
ShashiSubramanya Jan 31, 2026
0602451
Edits
ShashiSubramanya Jan 31, 2026
ec4ac8d
limitations update
ShashiSubramanya Jan 31, 2026
fc4df8b
typo fixes
ShashiSubramanya Jan 31, 2026
b5a694b
Spotter updates
ShashiSubramanya Jan 31, 2026
d79dc0f
spottercode docs
ShashiSubramanya Feb 1, 2026
6a36785
26-2-0 changelog, sdk version, etc.
ShashiSubramanya Feb 2, 2026
1f96523
title update
ShashiSubramanya Feb 2, 2026
c71bd39
Merge branch '26.2.0.cl' into report
ShashiSubramanya Feb 2, 2026
b1ca493
Merge pull request #397 from thoughtspot/report
ShashiSubramanya Feb 2, 2026
2df4f34
Merge pull request #399 from thoughtspot/s-u-a
ShashiSubramanya Feb 2, 2026
a4f3cdd
nav and link updates for Spotter
ShashiSubramanya Feb 2, 2026
c690e4c
spotter api update
ShashiSubramanya Feb 2, 2026
3eb9e0c
full app and EA label for publishing
ShashiSubramanya Feb 3, 2026
db63b50
edits
ShashiSubramanya Feb 3, 2026
ae4e2a9
edits
ShashiSubramanya Feb 3, 2026
143acb5
edits
ShashiSubramanya Feb 5, 2026
3227149
rate limit update
ShashiSubramanya Feb 6, 2026
65d1955
Merge branch 'main' into 26.2.0.cl
ShashiSubramanya Feb 11, 2026
c2ca9c7
version info
ShashiSubramanya Feb 11, 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
15 changes: 13 additions & 2 deletions modules/ROOT/pages/about-rest-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,22 @@ ThoughtSpot users with Developer or Administrator privileges can access the REST
* 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**.

== 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.

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

== 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:

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

////

58 changes: 58 additions & 0 deletions modules/ROOT/pages/api-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,63 @@

This changelog lists only the changes introduced in the Visual Embed SDK. For information about new features and enhancements available for embedded analytics, see xref:whats-new.adoc[What's New].

== Version 1.45.0, February 2026

[width="100%" cols="1,4"]
|====
|[tag greenBackground]#NEW FEATURE# a|**Spotter enhancements **

You can now embed the Spotter 3 experience in your application and use features such as Auto mode for automatic data model selection, Chat history, and a new chat prompt interface.

* To enable the new chat prompt interface, set `updatedSpotterChatPrompt` to `true`.
* To use Auto mode, set the `worksheetId` to `_spotter_data_source_discovery_id`.
* To enable Chat history, set `enablePastConversationsSidebar` to `true`.

For more information, see xref:embed-spotter.adoc[Embedding Spotter] and xref:embed-ai-analytics.adoc#_feature_status_and_availability_in_embed_mode[Features available with Spotter 3 experience].

Events::

* `EmbedEvent.AddToCoaching` for the *Add to coaching* workflow in a Spotter conversation session
* `HostEvent.AddToCoaching` to trigger the *Add to coaching* action in a Spotter conversation session.
* `HostEvent.StartNewSpotterConversation` to trigger the action to start a new chat session with Spotter.

|[tag greenBackground]#NEW FEATURE# a| **Liveboard experience enhancements** +

Styling and grouping::

* The `isLiveboardStylingAndGrouping` attribute, used for enabling the Liveboard styling and grouping feature, is now replaced with `isLiveboardMasterpiecesEnabled`. While your existing configuration with the deprecated attribute, `isLiveboardStylingAndGrouping` continues to work, we recommend switching to the new configuration setting.
* The following action IDs are now available to show, disable, or hide the grouping menu actions on a Liveboard:
** `Action.MoveToGroup` for the **Move to Group** menu action.
** `Action.MoveOutOfGroup` for the **Move out of Group** menu action.
** `Action.CreateGroup` for the *Create Group* menu action.
** `Action.UngroupLiveboardGroup` for the **Ungroup Liveboard Group** menu action.

Filter chip masking::
The `showMaskedFilterChip` boolean parameter is now available to control the visibility of masked filter chips on a Liveboard. When set to `true`, if a Liveboard is shared with a user who has restricted access due to column-level security, the filter chip corresponding to those inaccessible columns will be displayed as masked to that user. When set to `false`, the filter chip for inaccessible columns will not be visible to the user.
+
For more information, see link:https://docs.thoughtspot.com/cloud/latest/security-data-object#csr-liveboard[Column security rules on Liveboards].
+
The `showMaskedFilterChip` setting is also available in full application embedding.

|[tag greenBackground]#NEW FEATURE# a|**Publishing objects**

The following action IDs are available for the data publishing menu actions in the *Data workspace* page:

* `Action.Publish` for *Publish*
* `Action.ManagePublishing` for *Manange publishing*
* `Action.Unpublish` foe *Unpublish*
* `Action.Parameterize` for *Parameterize*
|[tag greenBackground]#NEW FEATURE# a| **Error handling improvements**

To handle errors in the embedding workflows, the SDK includes the following features:

* `ErrorDetailsTypes` enum for categorizing error types, such as `API`, `VALIDATION_ERROR`, `NETWORK` error.
* `EmbedErrorCodes` enum with specific error codes for programmatic error handling
* `EmbedErrorDetailsEvent` interface for structured error event handling

For more information, see link:https://developers.thoughtspot.com/docs/Enumeration_EmbedErrorCodes[EmbedErrorCodes] and link:https://developers.thoughtspot.com/docs/Enumeration_ErrorDetailsTypes[ErrorDetailsTypes].
|====

== Version 1.44.x, January 2026

[width="100%" cols="1,4"]
Expand Down Expand Up @@ -35,6 +92,7 @@ Emits when an API call matching the conditions defined in `interceptUrls` is det
For more information, see xref:api-intercept.adoc[Intercept API calls and search requests].
|====


== Version 1.43.0, November 2025
[width="100%" cols="1,4"]
|====
Expand Down
18 changes: 12 additions & 6 deletions modules/ROOT/pages/common/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
**** link:{{navprefix}}/embed-liveboard[Embed a Liveboard]
**** link:{{navprefix}}/embed-a-viz[Embed a visualization]
*** link:{{navprefix}}/embed-ai-search-analytics[Embed AI Search and Analytics]
**** link:{{navprefix}}/embed-spotter[Embed Spotter]
**** link:{{navprefix}}/embed-spotter[Embed Spotter experience]
**** link:{{navprefix}}/embed-spotter-agent[Embed Spotter Agent]
**** link:{{navprefix}}/embed-nls[Embed Natural Language Search (legacy interface)]
*** link:{{navprefix}}/full-embed[Embed full application]
Expand Down Expand Up @@ -215,30 +215,36 @@ include::generated/typedoc/CustomSideNav.adoc[]
*** link:{{navprefix}}/webhooks-kpi[Webhook for KPI alerts]
*** link:{{navprefix}}/webhooks-lb-schedule[Webhook for Liveboard schedule events ^Beta^]

* MCP Servers and Tools
** link:{{navprefix}}/SpotterCode[SpotterCode for IDEs]
*** link:{{navprefix}}/integrate-SpotterCode[Integrating SpotterCode]
*** link:{{navprefix}}/spottercode-prompting-guide[SpotterCode prompting guide]
** link:{{navprefix}}/mcp-integration[ThoughtSpot MCP server]

* link:{{navprefix}}/development-and-deployment[Deployment and integration]
** link:{{navprefix}}/development-and-deployment[Development and deployment]
*** link:{{navprefix}}/thoughtspot-objects[ThoughtSpot objects overview]
*** link:{{navprefix}}/variables[Custom variables ^Beta^]
*** link:{{navprefix}}/variables[Custom variables]
*** link:{{navprefix}}/git-integration[Deploy with Git]
**** link:{{navprefix}}/git-configuration[Configure Git integration]
**** link:{{navprefix}}/git-api[Version Control REST APIs]
**** link:{{navprefix}}/guid-mapping[GUID mapping]
*** link:{{navprefix}}/deploy-with-tml-apis[Deploy with TML APIs]
**** link:{{navprefix}}/modify-tml[TML modification]
*** link:{{navprefix}}/publish-data-overview[Publish content to Orgs ^Beta^]
**** link:{{navprefix}}/parameterze-metdata[Parameterize metadata ^Beta^]
**** link:{{navprefix}}/publish-to-orgs[Publish objects to Orgs ^Beta^]
*** link:{{navprefix}}/publish-data-overview[Publish content to Orgs]
**** link:{{navprefix}}/parameterze-metdata[Parameterize metadata]
**** link:{{navprefix}}/publish-to-orgs[Publish objects to Orgs]

** link:{{navprefix}}/multi-tenancy[Multi-tenancy]
*** link:{{navprefix}}/orgs[Multi-tenancy with Orgs]
*** link:{{navprefix}}/multitenancy-within-an-org[Multi-tenancy within an Org]
*** link:{{navprefix}}/single-tenant-data-models[Single-tenant data models with Orgs]
*** link:{{navprefix}}/orgs-api-op[Org administration]
** link:{{navprefix}}/tse-cluster[Cluster maintenance and upgrade]

* Integration with external tools
** link:{{navprefix}}/external-tool-script-integration[External tools and scripts]
** link:{{navprefix}}/pendo-integration[Pendo integration with embed]
** link:{{navprefix}}/mcp-integration[MCP server integration]
** link:{{navprefix}}/sf-integration[Integration with Salesforce]
** link:{{navprefix}}/vercel-integration[Vercel integration]
* Additional references
Expand Down
110 changes: 97 additions & 13 deletions modules/ROOT/pages/data-report-v2-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -235,11 +235,92 @@ To download a personalized view of the Liveboard, specify the view name in the `
* Attempting to override existing filter values with runtime filters while exporting a Liveboard will result in an error.
====

==== File Format
==== File Formats

The default `file_format` is PDF. For PDF downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. You can also download the report in PNG format.
The default `file_format` is *CSV*.

For PNG downloads, you can now define
[NOTE]
If you do not have .csv downloads enabled for your ThoughtSpot instance, select either `PDF` or `PNG` `file_format` to successfully download the report. Using any other format will cause the API to return an error.


For *CSV* downloads [earlyAccess eaBackground]#Early Access#,

* Each visualization is exported as a separate .csv file.
* If multiple visualizations are selected, the downloaded report is a single compressed .zip file containing all .CSV files.
* It does not support any additional parameters to customize the page orientation and `include_cover_page`, `include_filter_page`, logo, footer text, and page numbers.
* Charts are exported as tabular data. Downloaded reports may include columns not seen in the visualization if they were used as tokens in the underlying search query.

===== Sample API payload for CSV downloads

[source,cURL]
----
curl -X POST \
--url 'https://{ThoughtSpot-Host}/api/rest/2.0/report/liveboard' \
-H 'Authorization: Bearer {access-token}'\
-H 'Content-Type: application/json' \
--data-raw '{
"metadata_identifier": "416052fd-ad22-4d48-be0a-e43b53109957",
"file_format": "CSV",
"tab_identifiers": [
"bc6d6fb8-1e06-4617-b02f-51745e6933a6"
]
}'
----

For *XLSX* downloads [earlyAccess eaBackground]#Early Access#,

* Visualization is exported as an Excel workbook (.xlsx).
* If multiple visualizations are selected, the downloaded report is a single Excel workbook (.xlsx) containing each visualization in their individual tab.
* A maximum of 255 tabs per .xlsx workbook are allowed.
* It does not support any additional parameters to customize the page orientation and `include_cover_page`, `include_filter_page`, logo, footer text, and page numbers.
* Charts are exported as tabular data. Downloaded reports may include columns not seen in the visualization if they were used as tokens in the underlying search query.
* Unlike the pivot tables that are downloaded for any pivot table Answer in the ThoughtSpot UI, pivot tables generated in .xlsx workbooks using this API endpoint are exported as their underlying raw data. The .xlsx currently does not support the pivot table format.

===== Sample API payload for XLSX downloads

[source,cURL]
----
curl -X POST \
--url 'https://{ThoughtSpot-Host}/api/rest/2.0/report/liveboard' \
-H 'Authorization: Bearer {access-token}'\
-H 'Content-Type: application/json' \
--data-raw '{
"metadata_identifier": "416052fd-ad22-4d48-be0a-e43b53109957",
"file_format": "XLSX",
"visualization_identifiers": [
"254c6e30-680c-41ea-aa4d-bb059f745462"
]
}'
----

For *PDF* downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers.

===== Sample API payload for XLSX downloads

[source,cURL]
----
curl -X POST \
--url 'https://{ThoughtSpot-Host}/api/rest/2.0/report/liveboard' \
-H 'Authorization: Bearer {access-token}'\
-H 'Content-Type: application/json' \
--data-raw '{
"metadata_identifier": "416052fd-ad22-4d48-be0a-e43b53109957",
"file_format": "PDF",
"visualization_identifiers": [
"254c6e30-680c-41ea-aa4d-bb059f745462"
],
"pdf_options": {
"include_cover_page": true,
"include_custom_logo": true,
"include_filter_page": true,
"include_page_number": true,
"page_orientation": "LANDSCAPE",
"page_footer_text": "Sample footer text"
}
}'
----

For *PNG* downloads, you can now define

* `image_resolution` [earlyAccess eaBackground]#Early Access#
* `image_scale` [earlyAccess eaBackground]#Early Access#
Expand All @@ -250,37 +331,40 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T
[IMPORTANT]
====
* If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later,
** You will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`.
** You will no longer be able to use the `include_cover_page`, `include_filter_page` within the `png_options`.
** PNG download will support exporting only one tab at a time. If the `tab_identifier` is not specified, the first tab will be downloaded.
* Due to UI limitations in the REST API Playground, you'll notice that some parameters are automatically included in the PNG options JSON. This may cause your API request to fail. As a workaround, click *View JSON* next to the `png_options`, review the parameters, remove additional parameters, and then click *Try it out*.

====

==== Example
===== Sample API payload for PNG downloads

[source,cURL]
----
curl -X POST \
--url 'https://{ThoughtSpot-Host}/api/rest/2.0/report/liveboard' \
-H 'Authorization: Bearer {access-token}'\
-H 'Content-Type: application/json' \
--data-raw '{
"metadata_identifier": "9bd202f5-d431-44bf-9a07-b4f7be372125",
"metadata_identifier": "416052fd-ad22-4d48-be0a-e43b53109957",
"file_format": "PNG",
"visualization_identifiers": [
"9bd202f5-d431-44bf-9a07-b4f7be372125",
"9bd202f5-d431-44bf-9a07-b4f7be372125",
"9bd202f5-d431-44bf-9a07-b4f7be372125"
"tab_identifiers": [
"bc6d6fb8-1e06-4617-b02f-51745e6933a6"
],
"png_options": {
"include_cover_page": true,
"include_filter_page": true
"include_cover_page": null,
"include_filter_page": null,
"personalised_view_id": null,
"image_resolution": 1920,
"image_scale": 100,
"include_header": true
}
}'
----

==== Override filters

If the Liveboard has filters applied and you want to override the filters before downloading the Liveboard, you can specify the filters in the `override_filters` array.
If the Liveboard has filters applied, and you want to override the filters before downloading the Liveboard, you can specify the filters in the `override_filters` array.

[source,JSON]
----
Expand Down
Loading
Loading