Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions modules/ROOT/pages/api-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This changelog lists only the changes introduced in the Visual Embed SDK. For in
[width="100%" cols="1,4"]
|====

|[tag redBackground]#DEPRECATED# |**`defaultHeight` replaced with `minimumHeight` ** +
|[tag redBackground]#DEPRECATED# | ** Use `minimumHeight` instead of `defaultHeight` ** +

The `defaultHeight` parameter is deprecated in Visual Embed SDK v1.44.2 and later.
To set the minimum height of the embed container for ThoughtSpot components such as a Liveboard, use the `minimumHeight` attribute instead.
Expand Down Expand Up @@ -54,7 +54,8 @@ The `HostEvent.UpdateParameters` event now supports configuring the `isVisibleTo

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

The Visual Embed SDK now supports runtime overrides in Spotter embed.

* To apply runtime filters, use the `runtimeFilters` object
Expand Down Expand Up @@ -1063,7 +1064,7 @@ The earlier versions of the SDK supported only `GET` API requests. For more info
|====
|[tag greenBackground]#NEW FEATURE#|
This version of Visual Embed SDK includes the `enableSearchAssist` attribute, using which you can turn on the Search Assist feature on an embedded instance. +
For more information, see xref:search-assist-tse.adoc[Enable Search Assist, window=_blank].
//For more information, see xref:search-assist-tse.adoc[Enable Search Assist, window=_blank].
|[tag greenBackground]#NEW FEATURE#| The new version of SDK introduces the `AuthType.SAML` enum for SAML-based SSO authentication. Note that `AuthType.SAML` replaces the `AuthType.SSO` enum, which is deprecated in the v1.13.0 version of the SDK. +
For more information, see xref:embed-authentication.adoc#saml-sso-embed[Authentication].
|[tag redBackground]#DEPRECATED#| The `AuthType.SSO` enum is deprecated in v1.13.0. ThoughtSpot recommends using `AuthType.SAML` for the SAML SSO authentication method. +
Expand Down
109 changes: 97 additions & 12 deletions modules/ROOT/pages/data-report-v2-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -235,11 +235,93 @@ 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.
* If you want to be able to download each visualization in a separate workbook (instead of separate tabs), contact ThoughtSpot support.
* 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 @@ -256,31 +338,34 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T

====

==== 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
2 changes: 1 addition & 1 deletion modules/ROOT/pages/deploy-with-tml-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The process for exporting TML files into source control is:
. Use `/metadata/tml/export` endpoint in REST API v1 or v2.0 with `export_fqns=true` argument and `formmattype=YAML` to retrieve the TML of the object
. Save the TML response strings to disk in a Git-enabled directory using a consistent name format

You can use the link:https://thoughtspot.github.io/cs_tools/scriptability/[CS Tools, window=_blank] package for a pre-built tool for programmatic exporting or build your own equivalent using the link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python[thoughtspot_rest_api_v1 Python library, window=_blank].
You can use the link:https://thoughtspot.github.io/cs_tools/[CS Tools, window=_blank] package for a pre-built tool for programmatic exporting or build your own equivalent using the link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python[thoughtspot_rest_api_v1 Python library, window=_blank].

=== Best practices with TML export API
The `formattype` argument can be set to `YAML` or `JSON`.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/embed-ai-analytics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ a| * Supported data object is Model
Visual Embed SDK provides several configuration settings and controls for customizing Spotter embed view:

* Configuration properties that enable or disable features.
For more information, see xref:_spotterembedviewconfig.adoc[SpotterEmbedViewConfig] and xref:SpotterAgentEmbedViewConfig.adoc[SpotterAgentEmbedConfig]
For more information, see xref:SpotterEmbedViewConfig.adoc[SpotterEmbedViewConfig] and xref:SpotterAgentEmbedViewConfig.adoc[SpotterAgentEmbedConfig]
* The action customization framework to show or hide actions in the embedded view +
For more information, see xref:Action.adoc[Action] and xref:embed-action-ref.adoc[Action IDs in the SDK]
* Event handlers for host and embed app interaction +
Expand Down
16 changes: 8 additions & 8 deletions modules/ROOT/pages/locale-setting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,30 @@ If you want to set your embedded app view to a specific locale for your applicat
[options="header"]
|====================
| Locale | Language
| `ar-EG` | Egyptian Arabic
| `da-DK` | Dansk
| `de-DE` | Deutsch
| `de-CH` | German (Switzerland)
| `de-CH` | Deutsch (Switzerland)
| `en-AU` | English (Australia)
| `en-CA` | English (Canada)
| `en-DE` | English (Germany)
| `en-IN` | English (India)
| `en-NZ` | English (New Zealand)
| `en-GB` | English (United Kingdom)
| `en-US` | English (United States)
| `en-NZ` | English (New Zealand)
| `es-ES` | Español
| `es-US` | Español (Latinoamérica)
| `es-ES` | Español (España)
| `es-MX` | Spanish (Mexico)
| `fi-FI` | Suomi
| `es-MX` | Español (Mexico)
| `fr-CA` | Français (Canada)
| `fr-FR` | Français (France)
| `ja-JP` | 日本語
| `ko-KR` | 한국어
| `it-IT` | Italiano
| `ja-JP` | Japanese (Japan)/ 日本語
| `nb-NO` | Norsk
| `nl-NL` | Nederland
| `pt-BR` | Português (Brasil)
| `pt-PT` | Português (Portugal)
| `ru-RU` | Russian (Russia)
| `ru-RU` | Pусский (ограниченный выпуск)
| `fi-FI` | Suomi
| `sv-SE` | Svenska
| `zh-CN` | 中文(简体)
| `zh-HANT`| 中文 (繁體)
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/mcp-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ To enable tool calling:
You can generate an authentication token for a specific user from ThoughtSpot via a `POST` call to the `/api/rest/2.0/auth/token/full` REST API endpoint. +
Logged-in users can view the authentication token for their current session by using the `/api/rest/2.0/auth/session/token` REST API endpoint or by opening the following URL in a new tab on the web browser:
+
`https://{your-ts-instance}/api/rest/2.0/auth/session/token`
`\https://{your-ts-instance}/api/rest/2.0/auth/session/token`

For information about calling MCP tools using LLM APIs and methods, see these sections:

Expand Down Expand Up @@ -236,7 +236,7 @@ For more information, see the link:https://docs.claude.com/en/docs/agents-and-to
==== OpenAI API for MCP tool calling
To enable tool calling and retrieve data from ThoughtSpot via OpenAI, you can use the Responses API endpoint.

To connect to the ThoughtSpot remote MCP server, call the `https://api.openai.com/v1/responses` API endpoint and specify the following properties in the API request:
To connect to the ThoughtSpot remote MCP server, call the `\https://api.openai.com/v1/responses` API endpoint and specify the following properties in the API request:

* `tools` +
In the `tools` array, include these parameters:
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/modify-tml.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ For more information, see link:https://docs.thoughtspot.com/cloud/latest/tml-mod

[IMPORTANT]
====
Worksheets are deprecated and replaced with Models in ThoughtSpot Cloud 10.12.0.cl and later versions. You'll no longer be able to import a Worksheet TML object into ThoughtSpot without link:https://docs.thoughtspot.com/latest/worksheet-migration[converting it into a Model, window=_blank]. For information about the TML properties of a Model object, see link:https://docs.thoughtspot.com/cloud/latest/tml-models[TML for Models].
Worksheets are deprecated and replaced with Models in ThoughtSpot Cloud 10.12.0.cl and later versions. You'll no longer be able to import a Worksheet TML object into ThoughtSpot without link:https://docs.thoughtspot.com/cloud/latest/worksheet-migration[converting it into a Model, window=_blank]. For information about the TML properties of a Model object, see link:https://docs.thoughtspot.com/cloud/latest/tml-models[TML for Models].
====

Worksheets combine several *tables*, including *Views*, into a coherent data model optimized for searches. The TML syntax for Worksheets defines all aspects, including the tables it joins together, the columns and their properties, filters, and so on.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/multi-tenancy-best-practices.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Sharing is controlled through the UI (including when embedded) or via the xref:s
Please see the full documentation on xref:access-control-sharing.adoc[sharing for access control] to learn how the various options work to isolate content for end customers that share a single "prod" environment.

==== What content should be shared?
While you can share individual tables from connections to users, the best practice is to create link:https://docs.thoughtspot.com/cloud/latest/worksheet-create[worksheets, window=_blank] and only share the relevant Models to end users. Any Liveboards and saved answers shared to users should only connect to Models.
While you can share individual tables from connections to users, the best practice is to create link:https://docs.thoughtspot.com/cloud/latest/models[Models, window=_blank] and only share the relevant Models to end users. Any Liveboards and saved Answers shared to users should only connect to Models.

Remember to share the Model as *READ_ONLY* along with the Liveboards and answers so the users can access self-service features such as changing filter values.

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/rest-api-java-sdk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ a|ThoughtSpot Cloud: 10.9.0.cl | v2.14.0 or later

|=====
|Method|HTTP request
|link:ThoughtSpotRestApi.md#activateUser[activateUser, window=_blank] |*POST*
|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#activateUser[activateUser, window=_blank] |*POST*
/api/rest/2.0/users/activate

|link:https://github.com/thoughtspot/rest-api-sdk/blob/release/sdks/java/docs/ThoughtSpotRestApi.md#assignChangeAuthor[assignChangeAuthor^]
Expand Down
Loading