diff --git a/modules/ROOT/pages/api-changelog.adoc b/modules/ROOT/pages/api-changelog.adoc index 510e867e7..4022f96ea 100644 --- a/modules/ROOT/pages/api-changelog.adoc +++ b/modules/ROOT/pages/api-changelog.adoc @@ -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. @@ -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 @@ -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. + diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 1e5f6a9c3..1d1282b98 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -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# @@ -256,7 +338,8 @@ 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 \ @@ -264,23 +347,25 @@ curl -X POST \ -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] ---- diff --git a/modules/ROOT/pages/deploy-with-tml-apis.adoc b/modules/ROOT/pages/deploy-with-tml-apis.adoc index eee2a74a3..ffad32d04 100644 --- a/modules/ROOT/pages/deploy-with-tml-apis.adoc +++ b/modules/ROOT/pages/deploy-with-tml-apis.adoc @@ -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`. diff --git a/modules/ROOT/pages/embed-ai-analytics.adoc b/modules/ROOT/pages/embed-ai-analytics.adoc index 91109f804..1641ce495 100644 --- a/modules/ROOT/pages/embed-ai-analytics.adoc +++ b/modules/ROOT/pages/embed-ai-analytics.adoc @@ -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 + diff --git a/modules/ROOT/pages/locale-setting.adoc b/modules/ROOT/pages/locale-setting.adoc index 00e49b0b0..1c43f2a14 100644 --- a/modules/ROOT/pages/locale-setting.adoc +++ b/modules/ROOT/pages/locale-setting.adoc @@ -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`| 中文 (繁體) diff --git a/modules/ROOT/pages/mcp-integration.adoc b/modules/ROOT/pages/mcp-integration.adoc index 8b05690c6..6b877e5ae 100644 --- a/modules/ROOT/pages/mcp-integration.adoc +++ b/modules/ROOT/pages/mcp-integration.adoc @@ -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: @@ -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: diff --git a/modules/ROOT/pages/modify-tml.adoc b/modules/ROOT/pages/modify-tml.adoc index 9234c85d3..659a33093 100644 --- a/modules/ROOT/pages/modify-tml.adoc +++ b/modules/ROOT/pages/modify-tml.adoc @@ -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. diff --git a/modules/ROOT/pages/multi-tenancy-best-practices.adoc b/modules/ROOT/pages/multi-tenancy-best-practices.adoc index 604fc6d0d..b8315c099 100644 --- a/modules/ROOT/pages/multi-tenancy-best-practices.adoc +++ b/modules/ROOT/pages/multi-tenancy-best-practices.adoc @@ -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. diff --git a/modules/ROOT/pages/rest-api-java-sdk.adoc b/modules/ROOT/pages/rest-api-java-sdk.adoc index fc8e94be3..db8adb37c 100644 --- a/modules/ROOT/pages/rest-api-java-sdk.adoc +++ b/modules/ROOT/pages/rest-api-java-sdk.adoc @@ -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^] diff --git a/modules/ROOT/pages/rest-api-v2-reference-beta.adoc b/modules/ROOT/pages/rest-api-v2-reference-beta.adoc deleted file mode 100644 index 0b551fd5d..000000000 --- a/modules/ROOT/pages/rest-api-v2-reference-beta.adoc +++ /dev/null @@ -1,1037 +0,0 @@ -= REST API v2 ^Beta^ endpoints (Deprecated) -:toc: true - -:page-title: REST API Reference Guide -:page-pageid: rest-apiv2-beta-reference -:page-description: REST API Reference - -[div announcementBlock] --- -Starting from the ThoughtSpot Cloud 9.0.0.cl release, REST API v2 endpoints[beta betaBackground]^Beta^ are deprecated and removed from the ThoughtSpot API Playground. The API Playground will display the REST API V2 endpoints that are qualified for General Availability (GA). - -For detailed information about the endpoints listed in this article, see link:https://visual-embed-sdk-git-redoc-api-docs-thoughtspot-site.vercel.app/docs/apiv2Beta/index.html[REST API V2 (Beta) documentation, window=_blank]. --- - -The REST API v2 endpoints[beta betaBackground]^Beta^ includes the following resource collections and endpoints. - -== Session - --- -`**GET** /tspublic/rest/v2/session` - -Gets details of the current session for the logged-in user. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*POST* /tspublic/rest/v2/session/login` - -Signs in a user to ThoughtSpot. - -+++

+++ - -//// -++++ -View in Playground -++++ -//// - - -`**POST** /tspublic/rest/v2/session/gettoken` - -Gets an OAuth access token for a ThoughtSpot client. You must send this token in the `Authorization` header to authorize your API requests. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**POST** /tspublic/rest/v2/session/revoketoken` - -Revokes an existing access token assigned to a ThoughtSpot client. To make API calls, you must obtain a new access token. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**POST** /tspublic/rest/v2/session/logout` - -Logs out a ThoughtSpot user. -//// -++++ -View in Playground -++++ -//// --- - -== Users --- - -`*POST* /tspublic/rest/v2/user/create` - -Creates a user object. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`GET /tspublic/rest/v2/user` - -Gets details of a specific user. You must provide the username or the GUID of the user. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*PUT* /tspublic/rest/v2/user/update` - -Modifies the properties of a user object. You must specify a username or the GUID of the user. Requires administrator privileges. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`DELETE /tspublic/rest/v2/user/delete` - -Deletes a user object. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**PUT** /tspublic/rest/v2/user/addgroup` - -Assigns a user to groups. If the assigned groups have privileges configured, the user inherits these privileges. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*PUT* /tspublic/rest/v2/user/removegroup` - -Removes the groups assigned to a user. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**PUT** /tspublic/rest/v2/user/changepassword` - -Allows changing a ThoughtSpot user's password. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**POST** /tspublic/rest/v2/user/search` - -Gets a list of users available in the ThoughtSpot system. To filter your query, you can specify the user type, group, privileges, sharing visibility, and other such attributes. -//// -++++ -View in Playground -++++ -//// --- - -== Groups - --- -`*GET* /tspublic/rest/v2/group` - -Gets details of a specific group. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*POST* /tspublic/rest/v2/group/create` - -Creates a group object. Requires administrator privileges. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**PUT** /tspublic/rest/v2/group/update` - -Modifies the properties of a group object. Requires administrator privileges. -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**PUT **/tspublic/rest/v2/group/addprivilege` - -Assigns privileges to a group. Requires administrator privileges. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**PUT **/tspublic/rest/v2/group/removeprivilege` - -Removes privileges assigned to a group. Requires administrator privileges. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**DELETE** /tspublic/rest/v2/group/delete` - -Deletes a group object. Requires administrator privileges. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/group/adduser` - -Assigns users to a group. Requires administrator privileges. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**PUT **/tspublic/rest/v2/group/removeuser` - -Removes one or several users assigned to a group. Requires administrator privileges. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*PUT* /tspublic/rest/v2/group/addgroup` - -Adds a group to another group object. This API request creates a hierarchy of groups. The subgroups inherit the privileges assigned to the parent group. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**PUT** /tspublic/rest/v2/group/removegroup` - -Removes a group from the parent group. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*POST* /tspublic/rest/v2/group/search` - -Gets a list of groups created in the ThoughtSpot system. To filter your query, you can specify the group type, group name, privileges, sharing visibility, users, and other such attributes. -//// -++++ -View in Playground -++++ -//// --- - -== Admin - --- -`**GET ** /tspublic/rest/v2/admin/configuration` - -Gets details of the current configuration of a ThoughtSpot cluster. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*GET* /tspublic/rest/v2/admin/configuration/overrides` - -Gets details of configuration overrides. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**PUT **/tspublic/rest/v2/admin/configuration/update` - -Updates configuration settings of the ThoughtSpot cluster. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*PUT* /tspublic/rest/v2/admin/resetpassword` - -Resets the password of a user account. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/admin/syncprincipal` - -Synchronizes user account and group properties from an external database with ThoughtSpot. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/admin/changeauthor` - -Transfers the ownership of objects from one user to another. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/admin/assignauthor` - -Assigns ownership of objects to a specific user. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*POST* /tspublic/rest/v2/admin/forcelogout` + - -Logs out specified users from ThoughtSpot. - -//// -++++ -View in Playground -++++ -//// --- - -== Metadata - --- -`*GET* /tspublic/rest/v2/metadata/tag` - -Gets details for the specified tag. You must specify the tag name or the GUID. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*POST* /tspublic/rest/v2/metadata/tag/create` - -Creates a tag object. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/metadata/tag/update` - -Modifies the properties of a tag object. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/metadata/tag/assign` - -Assigns a tag to one or several metadata objects. You can assign a tag to a Liveboard, Answer, data object, and data connection objects. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/metadata/tag/unassign` - -Removes the tag assigned to an object. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*DELETE* /tspublic/rest/v2/metadata/tag/delete` - -Deletes the specified tag. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**PUT** /tspublic/rest/v2/metadata/favorite/assign` - -Adds an object such as Liveboards and answers to a user's favorites list. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**PUT ** /tspublic/rest/v2/metadata/favorite/unassign` - -Removes the specified object from the user's favorites list. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**GET** /tspublic/rest/v2/metadata/homeliveboard` - -Gets the details of the Liveboard that is set as a default Liveboard for the ThoughtSpot user. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**PUT** /tspublic/rest/v2/metadata/homeliveboard/assign` - -Assigns a Liveboard as a default Liveboard for a ThoughtSpot user. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/metadata/homeliveboard/unassign` - -Removes the default home Liveboard setting for a ThoughtSpot user. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*GET* /tspublic/rest/v2/metadata/incomplete` - -Gets a list of objects with incomplete metadata. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*GET* /tspublic/rest/v2/metadata/header` - -Gets header details for a specific metadata object. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*GET* /tspublic/rest/v2/metadata/details` - -Gets details of a specific metadata object. To filter your query, specify the metadata object type and the ID. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*GET* /tspublic/rest/v2/metadata/vizheaders` - -Gets a list of visualization headers associated with a Liveboard. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*POST* /tspublic/rest/v2/metadata/header/search` - -Gets a list of all metadata objects in the ThoughtSpot system. To filter your query, specify the metadata object type, access level, and other such attributes. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*POST* /tspublic/rest/v2/metadata/detail/search` - -Gets details of one or several metadata objects of a specific type. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*DELETE* /tspublic/rest/v2/metadata/delete` - -Deletes the specified metadata object. You can delete answers, Liveboards, Tags, Models, Views, Tables, Columns, and Table joins. + -Note that the endpoint does not support deleting the connection, user, and group objects. To delete these objects, use the following endpoints: - -* `DELETE /tspublic/rest/v2/connection/delete` -* `DELETE /tspublic/rest/v2/user/delete` -* `DELETE /tspublic/rest/v2/group/delete` - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*POST* /tspublic/rest/v2/metadata/dependency` - -Gets a list of dependent metadata objects. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*POST* /tspublic/rest/v2/metadata/tml/export` - -Exports a TML object and associated metadata. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**POST** /tspublic/rest/v2/metadata/tml/import` - -Imports one or several TML objects and object associations. - -//// -++++ -View in Playground -++++ -//// --- - -== Connections - --- -`*GET* /tspublic/rest/v2/connection` - -Gets details of a specific data connection. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**GET** /tspublic/rest/v2/connection/database` - -Gets details of the databases associated with a connection ID. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**POST** /tspublic/rest/v2/connection/table` - -Gets details of the tables associated with a connection ID. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*POST* /tspublic/rest/v2/connection/tablecoloumn` - -Gets details of the columns of the tables associated with a connection ID. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*POST* /tspublic/rest/v2/connection/create` - -Creates a data connection. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*PUT* /tspublic/rest/v2/connection/update` - -Updates an existing data connection. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -*DELETE* /tspublic/rest/v2/connection/delete - -Deletes a data connection. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/connection/addtable` - -Adds a table to an existing data connection. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*PUT* /tspublic/rest/v2/connection/removetable` - -Removes a table from an existing data connection. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*POST* /tspublic/rest/v2/connection/search` - -Gets details of all data connections. You can also query data for a specific connection type. - -//// -++++ -View in Playground -++++ -//// --- - -== Data - --- -`**POST** /tspublic/rest/v2/data/search` - -Allows constructing a search query string and retrieves data from a search query. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`**POST** /tspublic/rest/v2/data/answer` - -Gets data from a saved search answer. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**POST** /tspublic/rest/v2/data/liveboard` - -Gets data from the specified Liveboard and visualization. - -//// -++++ -View in Playground -++++ -//// --- - -+++

+++ - -`*GET* /tspublic/rest/v2/data/answer/querysql` - -Retrieves SQL for an Answer object. - -//// -++++ -View in Playground -++++ -//// --- - -+++

+++ - -`*GET* /tspublic/rest/v2/data/liveboard/querysql` - -Retrieves SQL for a visualization on a Liveboard. - -//// -++++ -View in Playground -++++ -//// --- - -== Report - --- -`*POST* /tspublic/rest/v2/report/answer` - -Downloads Answer data in the specified file format, such as PDF, CSV, PNG, and XLSX. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**POST** /tspublic/rest/v2/report/liveboard` - -Downloads a given Liveboard and its visualizations as a PDF, CSV, XLSX, or PNG file. - -//// -++++ -View in Playground -++++ -//// --- - -== Security - -`*POST* /tspublic/rest/v2/security/share/tsobject` - -Allows sharing an object with another user or group in ThoughtSpot. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**POST** /tspublic/rest/v2/security/share/visualization` - -Allows sharing a Liveboard visualization with another user or group in ThoughtSpot. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**GET** /tspublic/rest/v2/security/permission/tsobject` - -Gets access permission details for a metadata object. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*GET* /tspublic/rest/v2/security/permission/principal` - -Gets a list of objects that the specified user or group has access to. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*POST* /tspublic/rest/v2/security/permission/tsobject/search` - -Gets permission details for specific objects, and users and groups who have access to these objects. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*POST* /tspublic/rest/v2/security/permission/principal/search` - -Gets a list objects to which a user or group has `READ_ONLY` or `MODIFY` permissions. - -//// -++++ -View in Playground -++++ -//// - -== Custom actions - -`*GET* /tspublic/rest/v2/customaction` - -Gets details of a custom action. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**POST **/tspublic/rest/v2/customaction/create` - -Creates a custom action. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**PUT** /tspublic/rest/v2/customaction/update` - -Updates a custom action object. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**DELETE** /tspublic/rest/v2/customaction/delete` - -Deletes a custom action object. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**POST** /tspublic/rest/v2/customaction/search` - -Allows searching for custom actions available in ThoughtSpot. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`*GET* /tspublic/rest/v2/customaction/association` - -Gets metadata association details for a given custom action. - -//// -++++ -View in Playground -++++ -//// -+++

+++ - -`*PUT* /tspublic/rest/v2/customaction/association/update` - -Updates metadata association for a given custom action. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -`**DELETE **/tspublic/rest/v2/customactions/association/delete` - -Removes custom action association to a user, group or metadata object. - -//// -++++ -View in Playground -++++ -//// - -+++

+++ - -== Log --- -`*GET* /tspublic/rest/v2/logs/events` - -Gets security audit logs from the ThoughtSpot system. - -//// -++++ -View in Playground -++++ -//// -+++

+++ --- - -//// -== Materialization --- -`*PUT* /tspublic/rest/v2/materialization/refreshview` - -Refreshes data in a materialized view. + - -This endpoint is applicable to ThoughtSpot Software deployments only. - -++++ -View in Playground -++++ -+++

+++ --- - -== Database - -The Database endpoints are applicable to ThoughtSpot Falcon-based Software deployments only. - - -//// diff --git a/modules/ROOT/pages/security-settings.adoc b/modules/ROOT/pages/security-settings.adoc index 050132cc0..27f98ac27 100644 --- a/modules/ROOT/pages/security-settings.adoc +++ b/modules/ROOT/pages/security-settings.adoc @@ -1,6 +1,6 @@ = Security settings :toc: true -:toclevels: 2 +:toclevels: 3 :page-title: Security settings :page-pageid: security-settings @@ -8,6 +8,7 @@ The **Security Settings** page in ThoughtSpot UI allows administrators and developers to configure allowlists for Content Security Policy (CSP) and Cross-origin Resource Sharing (CORS), authentication attributes, and access control settings. +These settings can also be done via REST APIs v2, by sending a `POST` request to `POST /api/rest/2.0/system/security-settings/configure` API endpoint. == Overview Most web browsers block cross-site scripting, cross-domain requests, and third-party cookies by default. Web browsers also have built-in security mechanisms such as same-origin and content security policies. These policies restrict how applications and scripts from one origin (domain) can interact with the resources hosted on another origin (domain). To ensure data security and a seamless user experience in embedding applications, configure the settings described in this section. @@ -21,7 +22,7 @@ To avoid this issue, ThoughtSpot recommends the following: * If you are using a ThoughtSpot Cloud instance, set up your instance to the same domain as your host application. For more information, see link:https://docs.thoughtspot.com/cloud/latest/custom-domains[Custom domain configuration, window=_blank]. * If you are using authentication methods that rely on cookies, xref:_enable_partition_cookies[enable partition cookies]. -== Security settings in ThoughtSpot +== Configure security settings via the ThoughtSpot UI Users with administration privileges can configure security settings on the Security settings page of the ThoughtSpot UI. Note that the following settings on the **Security Settings** page will appear as locked for ThoughtSpot Analytics application users and will require an embedding license: @@ -31,7 +32,7 @@ Users with administration privileges can configure security settings on the Secu * xref:configure-saml.adoc#saml-redirect[SAML redirect domains] * xref:trusted-authentication.adoc[Trusted authentication] -=== Security settings for Orgs +==== Security settings for Orgs On ThoughtSpot instances with Orgs, security settings can be managed at two levels: @@ -86,7 +87,7 @@ Each Org can have a separate secret key, which can be used to authenticate users ==== -== CSP allowlists +=== CSP allowlists To allow another application to embed ThoughtSpot, you must xref:security-settings.adoc#csp-viz-embed-hosts[add your host application domain as a CSP Visual Embed host]. @@ -98,7 +99,7 @@ If your instance has Orgs configured, note that the default Org on your instance ==== [#csp-viz-embed-hosts] -=== Add CSP visual embed hosts +==== Add CSP visual embed hosts To allow your host domain to set the `frame-ancestors` CSP policy header and embed a ThoughtSpot object within your application frame, add your application domain as a CSP visual embed host. . On your ThoughtSpot application instance, go to *Develop* page. @@ -108,13 +109,16 @@ To allow your host domain to set the `frame-ancestors` CSP policy header and emb . In the *CSP visual embed hosts* text box, add the domain names. For valid domain name formats, See xref:security-settings.adoc#csp-cors-hosts[Domain name format for CSP and CORS configuration]. . Click *Save changes*. +#Through the API:: +`visual_embed_hosts`# + [NOTE] ==== Only users with a valid embed license can add Visual Embed hosts. ==== [#csp-connect-src] -=== Add URLs to CSP connect-src allowlist +==== Add URLs to CSP connect-src allowlist If you plan to use a custom action or webhook to send data to an external endpoint or application, you must add the domains of the target endpoints or applications to the `CSP connect-src` allowlist. . On your ThoughtSpot application instance, go to *Develop* page. @@ -125,7 +129,7 @@ If you plan to use a custom action or webhook to send data to an external endpoi . Click *Save changes*. [#csp-trusted-domain] -=== Add other trusted domains +==== Add other trusted domains To import images, fonts, and stylesheets from external sites, or load the content from an external site using an iFrame element, you must add the source URLs as trusted domains in the CSP allowlist. For example, in the Liveboard Note tiles, if you want to insert an image from an external site or embed content from an external site in an iFrame, you must add domain URLs of these sites to the CSP allowList. Similarly, to import fonts and custom styles from an external source, you must add the source URL as a trusted domain in ThoughtSpot. @@ -148,7 +152,7 @@ Add the domains from which you want host scripts. For more information, see xref Add the iframe source URL domains. //// -=== Add permitted iFrame domains +==== Add permitted iFrame domains Features such as link:https://docs.thoughtspot.com/software/latest/liveboard-notes[Liveboard Note tiles, window=_blank] and link:https://docs.thoughtspot.com/cloud/latest/chart-custom[custom charts, window=_blank] allow iFrame content. If you are planning to embed content from an external site, make sure the domain URLs of these sites are added to the iFrame domain allowlist: . On your ThoughtSpot application instance, go to *Develop* page. @@ -160,7 +164,7 @@ Features such as link:https://docs.thoughtspot.com/software/latest/liveboard-not [#cors-hosts] -=== Enable CORS +==== Enable CORS To allow your embedding application to call ThoughtSpot, access its resources, and render embedded content, add your host application domain URL as a trusted host for CORS. @@ -182,8 +186,12 @@ To add domain names to the CORS allowlist, follow these steps: . In the *CORS whitelisted domains* text box, add the domain names. For valid domain name formats, See xref:security-settings.adoc#csp-cors-hosts[Domain name format for CSP and CORS configuration]. . Click *Save changes*. +#Through the API:: +`cors_whitelisted_urls` is an array of whitelisted URLs. Set this to `null` when there is no urls to be set.# + + [#csp-cors-hosts] -=== Domain name format for CSP and CORS configuration +==== Domain name format for CSP and CORS configuration [IMPORTANT] ==== @@ -282,10 +290,10 @@ a|+++Wildcard (*) for port+++ |==== -== Block access to non-embedded ThoughtSpot pages +=== Block access to non-embedded ThoughtSpot pages If you have embedded ThoughtSpot content in your app, you may want your users to access only the ThoughtSpot pages embedded within the context of your host app. ThoughtSpot allows administrators to restrict user access to non-embedded application pages from the embedding application context or selectively grant access to specific user groups. For information, see xref:selective-user-access.adoc[Control User Access]. -== Enable partitioned cookies +=== Enable partitioned cookies Many web browsers do not allow third-party cookies. If you are using authentication methods that rely on cookies, users will not be able to access the embedded content when browsers block third-party cookies. Therefore, ThoughtSpot recommends using xref:trusted-auth-sdk.adoc[cookieless authentication] in production environments. However, if your implementation uses cookie-based authentication or xref:embed-authentication.adoc#none[AuthType.None], ensure that you enable partitioned cookies: @@ -304,5 +312,35 @@ With partitioned cookies enabled, when a user logs in to ThoughtSpot and accesse Safari blocks all third-party cookies and does not support partitioned cookies. You can switch to a different browser that supports partitioned cookies, or use cookieless authentication in your embedding implementation. ==== -== Trusted authentication +=== Trusted authentication See xref:trusted-authentication.adoc[Trusted authentication] and xref:_secret_key_management[Secret key management]. + +== Configure security settings via API +# +* For REST API v2 operations, the Org context is determined based on the authentication token used in your API requests. Ensure you log in to the appropriate Org context from which you want to send API requests. +* Ensure that you have developer or administrator privileges for the Org. + +=== Configure Security Settings +Security settings can be configured for the ThoughtSpot instance and for the Org as well. To configure security settings send a `POST` request to `POST /api/rest/2.0/system/security-settings/configure` API endpoint. + +[NOTE] +==== +* When security settings are defined at both levels, the Org-level settings take precedence over cluster-level settings within that Org. +* If the configuration settings are available at both levels and are configured only at the All Orgs level, the Orgs on the instance will inherit these settings. +* If the settings are not defined either at the All Orgs level or per Org, the system defaults will be applied. +==== + +=== Request parameters +In your `POST` request body, include the following parameters: + +[width="100%" cols="1,4"] +[options='header'] +|===== +|Parameter|Description + +|cluster_preferences a|__String__. Required. A JSON map of customizable security settings for the ThoughtSpot instance. +|enable_partitioned_cookies a|__Boolean__. +|org_identifier a|__String__. Required. The unique ID or name of the Org for which the email customization is being updated. +|===== +# + diff --git a/modules/ROOT/pages/spotter-apis.adoc b/modules/ROOT/pages/spotter-apis.adoc index 5485baa23..84cb5009c 100644 --- a/modules/ROOT/pages/spotter-apis.adoc +++ b/modules/ROOT/pages/spotter-apis.adoc @@ -62,7 +62,7 @@ xref:spotter-apis.adoc#_send_a_question_and_generate_streaming_responses[Streams __Available on ThoughtSpot Cloud instances from 10.13.0.cl onwards__. * `POST /api/rest/2.0/ai/agent/{conversation_identifier}/converse` + -xref:spotter-apis.adoc#_create_a_conversation_session_with_spotter_agent[Sends a message] to an ongoing conversation session with Spotter agent. + +xref:spotter-apis.adoc#_send_queries_to_a_conversation_session_with_spotter_agent[Sends a message] to an ongoing conversation session with Spotter agent. + __Available on ThoughtSpot Cloud instances from 10.15.0.cl onwards__. |Data literacy and guided analysis a| @@ -920,7 +920,7 @@ To use this API, the user must have access to the relevant conversational sessio |===== |Parameter|Type| Description |`conversation_identifier`|Path parameter|__String__. Required. Specify the conversation ID received from the xref:spotter-apis.adoc#_create_a_conversation_session_with_spotter_agent[POST /api/rest/2.0/ai/agent/conversation/create] API call. -|`message`|Form parameter|_String_. Required. Specify a natural language query string. For example, `total sales of jackets last month`. +|`messages`|Form parameter|_Array of strings_. Required. Specify at least one query in natural language. For example, `total sales of jackets last month`. |===== @@ -958,7 +958,7 @@ If the request is successful, the API returns an array of objects in the respons * `type` + Type of the message, such as text, answer, or error. -* `message` + +* `text` + Response message generated for the query. * `metadata` + Additional information based on the message type. diff --git a/modules/ROOT/pages/webhooks-lb-schedule.adoc b/modules/ROOT/pages/webhooks-lb-schedule.adoc index e695ee250..eec7e3d5a 100644 --- a/modules/ROOT/pages/webhooks-lb-schedule.adoc +++ b/modules/ROOT/pages/webhooks-lb-schedule.adoc @@ -396,7 +396,7 @@ If the webhook creation is successful, the API returns the following response: "modification_time_in_millis": 1761050197164, "created_by": { "id": "08c6b203-ff6e-4ed8-b923-35ebbbfef27b", - "name": "UserA@thoughtspot.com" + "name": "UserA@UserA@example.com" }, "last_modified_by": null } @@ -477,11 +477,11 @@ If the API request is successful, ThoughtSpot returns the webhook configuration "modification_time_in_millis": 1761051944507, "created_by": { "id": "08c6b203-ff6e-4ed8-b923-35ebbbfef27b", - "name": "UserA@thoughtspot.com" + "name": "UserA@UserA@example.com" }, "last_modified_by": { "id": "08c6b203-ff6e-4ed8-b923-35ebbbfef27b", - "name": "UserA@thoughtspot.com" + "name": "UserA@UserA@example.com" } } ], @@ -603,7 +603,7 @@ If the API request is successful, the webhook is deleted, and the API returns th "modification_time_in_millis": 1761184185887, "created_by": { "id": "08c6b203-ff6e-4ed8-b923-35ebbbfef27b", - "name": "UserA@thoughtspot.com" + "name": "UserA@UserA@example.com" }, "last_modified_by": null } diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index 1bbd50faa..40437acc7 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -957,7 +957,8 @@ For more information, see xref:security-settings.adoc[Security Settings]. .Support for Sage coach [%collapsible] ==== -In full application embedding, you can now review user feedback on the natural language search queries on the **Data** page. For more information, see link:https://docs.thoughtspot.com/cloud/latest/sage-coach[Sage Coach, window=_blank]. +In full application embedding, you can now review user feedback on the natural language search queries on the **Data** page. +//For more information, see link:https://docs.thoughtspot.com/cloud/latest/sage-coach[Sage Coach, window=_blank]. ==== .Visual Embed SDK @@ -1253,7 +1254,7 @@ For more information, see xref:version_control.adoc[Version control with Git int ==== The Visual Embed developer Playground now includes a *Try* button in the preview panel. The *Try* button is attached to an event handler. You can register a host event and click *Try* to trigger an action on the embedded page in the Playground. -For more information, see xref:embed-events.adoc#host-events[Events reference]. +For more information, see xref:embed-events.adoc[Events reference]. ==== .Visual Embed SDK diff --git a/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-05.adoc b/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-05.adoc index ac63049b4..7579d96e9 100644 --- a/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-05.adoc +++ b/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-05.adoc @@ -68,7 +68,7 @@ image:images/tutorials/tse-fundamentals/lesson-05-search-console.png[Console out Before embedding the search, we need to initialize the SDK. Initializing the SDK tells it which ThoughtSpot instance to communicate with and the type of authentication. -There are additional parameters you can pass, which you can read about in the link:https://developer-docs-nnh3ibjh0-thoughtspot-site.vercel.app/docs/tsembed#initSdk[documentation]. +There are additional parameters you can pass, which you can read about in the link:https://developers.thoughtspot.com/docs/tsembed#initSdk[documentation]. One useful parameter to consider is `callPrefetch`, which can speed up the first embed object's load time by caching static content locally. This will not have an effect if caching is disabled during development but can improve performance in production.