What’s new

What’s new

This page lists new features, enhancements, and deprecated functionality in ThoughtSpot Embedded instances.

Version 10.0.0.cl🔗

Customize number, currency, and date format🔗

You can now customize the number, date, and currency format displayed on embedded pages.

For more information, see Set locale.

Git integration🔗

If RBAC is enabled on your instance, ensure that the Version Control API users have the Can manage version control (CAN_MANAGE_VERSION_CONTROL) Role privilege.

Visual Embed SDK🔗

For information about the new features and enhancements introduced in Visual Embed SDK version 1.29.x and 1.30.0, see Visual Embed changelog.

REST API🔗

For information about REST API enhancements, see REST API v1 changelog and REST API v2.0 changelog.

Feature deprecations🔗

For information about deprecated features, see Deprecation announcements.

Version 9.12.5.cls🔗

New home page and navigation Early Access🔗

The new navigation and homepage experience is now available for ThoughtSpot users.

ThoughtSpot administrators can enable this feature on their application instance on the Admin page. If the new navigation and homepage experience is enabled on your instance, users can turn on the New Experience mode on their Profile settings page.

On embedding apps, the new navigation and homepage experience is disabled by default. To enable it, you must set the modularHomeExperience property to true in the AppEmbed component.

The new navigation and homepage experience introduces the following notable changes:

  • The top navigation menu bar is replaced with an app selector the app switcher menu that allows users to switch between different apps.

  • The Insights module presents a redesigned homepage with modular content and a left navigation panel. Users can navigate to Liveboards, Answers, SpotIQ Analysis, and Monitor Subscriptions pages from the homepage by using the left navigation menu options.

For more information, see Customize full application embedding.

Visual Embed SDK🔗

For information about the new features and enhancements introduced in Visual Embed SDK version 1.29.x and 1.30.0, see Visual Embed changelog.

REST API🔗

For information about REST API enhancements, see REST API v1 changelog and REST API v2.0 changelog.

Version 9.12.0.cl🔗

SSO authentication with IAMv2 on ThoughtSpot embedded instances🔗

ThoughtSpot now supports managing user authentication through IAMv2 on embedded instances. With this feature, administrators can set up SAML and OIDC authentication with Identity providers such as Okta, Google, and so on. You can also map Identity Provider (IDP) attributes on the ThoughtSpot Admin page when setting up OIDC or SAML authentication on your instance.

IAMv2 is turned off by default. To enable it on your instance, contact ThoughtSpot Support.

OIDC authentication on Orgs-enabled clusters🔗

ThoughtSpot now supports Orgs through OpenID Connect (OIDC) authentication on embedded instances. With Org mapping, the IdP will have the ability to assign users to specific Orgs when they log in via OIDC authentication. You need administrator privileges to enable Org mapping on the cluster.

Ask Sage Beta🔗

ThoughtSpot application users can now ask follow-up questions and seek clarifications about visualizations and Answers generated using natural language search. The Ask Sage action on Liveboard visualizations and Ask a follow-up action search results page allow you to start a conversation with the AI analyst, ask successive questions, and refine the Answer retrieved from a Natural Language Search query.

The Ask Sage feature is turned off by default. To enable this feature on your instance, contact ThoughtSpot Support. To enable or disable this feature for embedded application users, use the enableAskSage attribute.

Liveboard UI changes🔗

The following TML menu actions are now grouped under the TML sub-menu of the More the more options menumenu.

  • Export TML

  • Edit TML

  • Update TML

Version 9.10.5.cl🔗

Row-level security via tokens Beta🔗

You can now implement Row-Level Security (RLS) and Attribute-Based Access Control (ABAC) via tokens for ThoughtSpot embedded application users. You can now configure your authentication process in the SDK to assign security attributes for any user during session creation.

For more information, see ABAC via token.

Note

ABAC via tokens is supported only with the Trusted Authentication method.

AI Highlights Early Access🔗

You can now get quick insights on how top metrics have changed in your Liveboard via AI Highlights.

Important
  • Users with administration privileges can enable AI Highlights at the cluster level on the Admin page.

  • When AI Highlights is enabled, the AI highlights AI Highlights icon icon appears on the Liveboard header and the Edit button moves to the More menu the more options menu.

  • You can hide this feature on your embedded instance by adding Action.AIHighlights to the hiddenActions array in the SDK.

For more information, see AI Highlights.

Granular Roles for data management🔗

If the RBAC is enabled on your ThoughtSpot instance, administrators can use the following Roles for granular access control and data management:

  • CAN_MANAGE_CUSTOM_CALENDAR

  • CAN_CREATE_OR_EDIT_CONNECTIONS

  • CAN_MANAGE_WORKSHEET_VIEWS_TABLES

For more information, see Role-based access control.

Note

The RBAC feature is in beta and turned off by default. To enable this feature, contact ThoughtSpot Support.

Version 9.10.0.cl🔗

Integration with Vercel projects

You can now integrate your ThoughtSpot instance with a Vercel project. If you are using Vercel to build and maintain your embedding application, you can install ThoughtSpot analytics integration, connect to ThoughtSpot data, and embed content in your app seamlessly.

For more information, see Vercel integration.

CSS variables for custom styling

The following custom CSS variables are deprecated and not supported from 9.10.0.cl onwards:

  • --ts-var-sage-bar-img-url

  • --ts-var-sage-bar-img-color

  • --ts-var-sage-bar-img-visibility

Security settings for non-embedded instances

The Security Settings page in the Develop tab now allows any ThoughtSpot user with developer or admin privileges to modify CSP settings for image, font, and style import.

For more information, see Security Settings.

Support for Sage coach

In full application embedding, you can now review user feedback on the natural language search queries on the Data page. For more information, see Sage Coach.

Visual Embed SDK

For information about the new features and enhancements introduced in Visual Embed SDK version 1.28.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API v1 changelog and REST API v2.0 changelog.

Version 9.8.0.cl🔗

Support for Natural Language Search embedding

You can now embed ThoughtSpot Search with Natural Language Search capabilities using SageEmbed SDK package. Natural Language Search allows your application users to search for data using natural language query strings. This feature also provides AI-suggested sample questions and popular queries to assist users in their data search operations.

Using SageEmbed, you can embed the ThoughtSpot Search interface with Natural Language Search components in your app and also customize the search experience as per your requirements.

For more information, see Embed Natural Language Search.

Embed Playground enhancements

The Visual Embed playground now allows you to explore Natural Language Search embedding options and Search page customization capabilities. For more information, see Natural Language Search.

Git integration enhancements

The Deploy Commit Version Control API now provides the VALIDATE_ONLY option to validate TML imports to the destination environment. If your destination environment has TML content that has been modified or is different from the content on the main branch, you can run the validation before deploying changes to the destination environment.

For more information, see Deploy commits.

CSS variables for Natural Language Search interface customization

To customize Natural Language Search interface, you can use the following variables in your custom CSS:

  • --ts-var-sage-bar-header-background-color

  • --ts-var-source-selector-background-color

  • --ts-var-sage-search-box-font-color

  • --ts-var-sage-search-box-background-color

  • --ts-var-sage-embed-background-color

  • --ts-var-sage-seed-questions-background

  • --ts-var-sage-seed-questions-font-color

  • --ts-var-sage-seed-questions-hover-background

  • --ts-var-sage-bar-img-url

  • --ts-var-sage-bar-img-color

  • --ts-var-sage-bar-img-visibility

For mor information, see Customize CSS.

Visual Embed SDK

For information about the new features and enhancements introduced in Visual Embed SDK version 1.27.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API v2.0 changelog.

Version 9.7.0.cl🔗

Git integration and version control

The Git integration feature and Version Control APIs are GA and enabled by default on ThoughtSpot. This version also includes several enhancements to the Version Control APIs. For more information, see REST API v2 Changelog and Git integration and version control.

Custom styles

You can now customize icon sprites and add custom text strings. For more information, see Customize text strings and Customize icons.

Liveboard experience
Personalized Liveboard Views Early Access

Embedding application users can now create a personalized version of Liveboard with their changes. The personalized Liveboard view inherits any changes made to the master Liveboard, including changes made to pinned visualizations, tabs, filter chips, and re-ordering.

This feature is disabled by default and can be enabled by administrators. For more information, see ThoughtSpot Product Documentation.

Embedding in note tiles

You can now embed interactive content such as videos in an iFrame on a Liveboard Note tile. For more information, see ThoughtSpot Product Documentation.

Liveboard customization

You can now customize Liveboard headers, show or hide Liveboard users, tabs, description text, and Liveboard title.

For more information, see Visual Embed SDK Changelog and SDK documentation.

Search experience

You can now enable the new data panel experience on the embedded Search page in the SDK. The new data panel experience is turned off by default on embedded ThoughtSpot instances.

For more information, see Embed ThoughtSpot Search.

Visual Embed SDK

For information about the new features and enhancements introduced in Visual Embed SDK version 1.26.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API v2.0 changelog.

Version 9.6.0.cl🔗

Playground enhancements

The 9.6.0.cl release adds the following features to the Visual Embed Playground:

  • Liveboard tab selection
    The Playground page for Liveboard embedding now shows the tab selection drop-down, which allows users to set the default tab view on an embedded Liveboard.

  • Use host event checkbox

    On selecting the Use host event checkbox, the code panel in the Playground displays the code snippet to try out host events. You can use this code snippet to register a host event and trigger an action using the Try Event button in the Playground.

Home page experience in Full application embedding mode

If you are embedding the full ThoughtSpot experience with the ThoughtSpot Sage feature, the Home page allows you to use AI-generated search answers. To enable AI-assisted search on your instance, contact ThoughtSpot Support.

Role-Based Access Control Beta

The role-based access control (RBAC) feature allows administrators to create a role in the UI or via REST API calls and assign a set of privileges. With the RBAC feature, you can assign granular permissions and control user access to ThoughtSpot features and application workflows. For more information, see Role-based Access Control.

The RBAC feature is turned off by default. To enable this feature, contact ThoughtSpot Support.

Visual Embed SDK

For information about the new features and enhancements introduced in Visual Embed SDK version 1.25.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API v2.0 changelog.

Version 9.5.0.cl🔗

Webhooks for KPI monitor alerts Beta

ThoughtSpot administrators and developers can now create a Webhook to send KPI monitor alerts to the REST endpoint of an external application. The Webhooks feature is turned off by default. To enable this feature on your instance, contact ThoughtSpot Support.

For more information, see Webhooks for KPI Monitor alerts.

Version control and Git integration Beta

The Git integration feature now supports pushing commits and publishing content to Org-based deployment environments. If your ThoughtSpot cluster has Orgs and multi-tenancy enabled, you can create dev and prod environments on the same ThoughtSpot instance and connect these environments to your GitHub repository.

For more information, see Git integration and version control.

SDK library to embed AI-powered ThoughtSpot Search experience Beta

The Visual Embed SDK provides a new JavaScript library to embed the Search page with AI-powered features such as natural language search and AI-suggested answers. To view the AI-suggested answers, make sure the AI search support is enabled on the data source or worksheet used for searching data.

ThoughtSpot does not display AI-suggested search responses if the Search Assist feature is enabled.

For more information, see SageEmbed SDK reference.

Visual Embed SDK

For information about the new features and enhancements introduced in Visual Embed SDK version 1.24.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API v1 changelog and REST API v2.0 changelog.

Version 9.4.0.cl🔗

Version control and Git integration Beta
GUID mapping

If a TML file on your source environment contains GUIDs that don’t match the GUIDs on your destination environment, the version control APIs can now automatically handle the mapping of GUIDs when deploying the TML content.

For more information, see Git integration and version control.

Folder structure changes BREAKING CHANGE

The folder structure of the TML objects in the Git repository is modified in 9.4.0.cl. In earlier releases, the TML objects were stored in the object directory of the primary root folder, for example primary/liveboard. Starting from 9.4.0.cl, the TML objects will be stored in the object folder at the root level. ThoughtSpot will not migrate your existing TML files from primary/<object-dir> to the new folder structure. You must move these files to the respective object directory at the root level.

File naming convention BREAKING CHANGE

Starting from 9.4.0.cl, the TML files pushed to a Git branch from a ThoughtSpot instance are named in the <object-name>.<guid>.tml format. The earlier releases used the <guid>.<object-name>.tml naming convention for TML files. This change may break your current setup. We recommend that you reconfigure the Git connection on your ThoughtSpot instance and start using the version control feature from scratch.

Security settings enhancements for Orgs
CORS settings per Org

On multi-tenant clusters with Orgs, developers can now add a list of CORS hosts at the Org level. For more information, see Security Settings.

Block user access to non-embedded application pages

ThoughtSpot administrators and developers can now enable the Block non-embed full app access feature at the Org level.

For more information, see Security Settings.

Visual Embed SDK

For information about the new features and enhancements introduced in Visual Embed SDK version 1.23.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API v1 changelog and REST API v2.0 changelog.

Version 9.3.0.cl🔗

Support for cookieless authentication

Developers can now enable cookieless authentication when embedding ThoughtSpot in their applications. The cookieless authentication method allows using a bearer token instead of session cookies when users interact with embedded content or initiate API requests. If the embedded content does not load from the same domain as your embedding application, and your Web browser does not allow third-party cookies, you can use Cookieless authentication in the Trusted authentication mode.

For more information, see Trusted authentication.

Idle sensing and APIs for managing cluster states

ThoughtSpot Cloud clusters support idle sensing in embedded deployments. With idle sensing enabled on your embedded ThoughtSpot instance, your instance becomes inactive if there is no active user session detected for a period of 120 minutes. You can restart an inactive cluster using API when required.

For more information, see Manage your cluster state.

Per-Org style customization

The Develop tab now allows customizing UI styles and layout at the Org level. To enable this feature on your multi-tenant instance, contact ThoughtSpot support.

Version control and Git integration via REST API Beta

You can now connect your ThoughtSpot instance to a Git repository and push commits from your application instance to a Git branch via REST API. With the Git integration Beta feature, ThoughtSpot provides the ability to integrate your application environment with Git workflows and deploy commits from a development instance to a production cluster.

For more information, see Version control with Git integration.

Visual Embed Playground enhancements

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 Events reference.

Visual Embed SDK

For information about the new features and enhancements introduced in Visual Embed SDK versions 1.22.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API v1 changelog and REST API v2.0 changelog.

Version 9.2.0.cl🔗

Per-Org secret key and tokens for Trusted authentication

ThoughtSpot now supports generating secret keys per Org. Org administrators can generate a secret key for trusted authentication in their Org context and allow their Org users to obtain authentication tokens using this secret key.

Starting from 9.2.0.cl, Org users require Org-specific authentication tokens issued for their user accounts when switching between Orgs. When generating an authentication token via REST API, make sure to request separate tokens for each Org context.

For more information, see Trusted authentication.

Custom styles

The 9.2.0.cl release introduces the following new variables for custom styling of the ThoughtSpot Search page:

  • --ts-var-search-auto-complete-font-color

  • --ts-var-search-auto-complete-subtext-font-color

  • --ts-var-answer-edit-panel-background-color

For more information, see Customize CSS.

GraphQL playground Beta

The Develop tab in the ThoughtSpot UI introduces the GraphQL playground to allow users to interact with GraphQL endpoints and run query and mutation operations. To enable this feature on your instance, contact ThoughtSpot Support.

For more information, see GraphQL Playground.

Runtime Parameter overrides

Embedded application users can now create Worksheet and Answer Parameters to optimize data queries. You can also adjust values and apply overrides at runtime on a Liveboard or Answer either via REST API or by appending Parameters to the query URL in the UI.

For more information, see Runtime Parameter overrides.

Link customization

You can now customize the navigation links in your app using the Generic link option in the Develop > Customization > Link settings page.

For more information, see Customize links.

Cross filters on Liveboard visualizations Early Access

ThoughtSpot now supports brushing and linking of visualizations on a Liveboard using cross filters. Cross filters allow you to present a coordinated view of a Liveboard by applying filters across all visualizations based on the current selection.

Note
The Cross filters feature is turned off by default. To enable this feature on your instance, contact your ThoughtSpot administrator.

To hide or disable the cross filter feature on an embedded instance, use the Action.CrossFilter and Action.RemoveCrossFilter parameters in the SDK. For more information, see Show or hide menu items and Action reference.

Contextual menu behavior🔗

By default, the contextual menu in ThoughtSpot application pages is set as right-click pop-up menu. Starting from 9.2.0.cl, you can set the contextual menu to trigger on left-click.

To trigger the contextual menu on left-click or right-click on an embedded app, you can use the contextMenuTrigger property in the Visual Embed SDK. In the following example, the contextual menu is configured to trigger on left-click.

contextMenuTrigger: "left-click"
contextMenuTrigger: ContextMenuTriggerOptions.LEFT_CLICK
When set as right-click menu (default behavior)

The contextual menu opens on right-click. If you want to monitor right-click actions and listen to the right-click events on a chart or table, use EmbedEvent.VizPointRightClick event. For more information, see VizPointRightClick.

When set as left-click menu

The contextual menu opens on left-click. If your app is already using EmbedEvent.VizPointClick to listen to left-click events on a visualization, the VizPointClick event will be triggered whenever a user clicks on an action in the contextual menu. If you are using EmbedEvent.VizPointClick to trigger actions such as updating runtime filters on a Liveboard visualization, the click events from left-click contextual menu may impact your app’s current workflow.

We recommend using a development environment to test your customizations before rolling them out on production servers. For more information, contact ThoughtSpot Support.

Note tiles on Liveboards Early Access

In the new Liveboard experience mode, you can now add Note tiles with custom text, images, and links. This feature is turned off by default and can be enabled by ThoughtSpot administrators.

For more information, see Note tiles.

Visual Embed SDK

For information about the new features and enhancements introduced in Visual Embed SDK versions 1.20.0 and 1.21.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API v1 changelog and REST API v2.0 changelog.

Version 9.0.0.cl🔗

New Liveboard experience

The new Liveboard experience is now Generally Available (GA) on embedded instances and is enabled by default.

New CSS variables for custom styling

The CSS customization feature supports new variables to customize the look and feel of the following UI elements:

  • Search bar and navigation panel

  • Search suggestion panel

  • Dialogs

For more information, see Customize CSS.

REST API v2.0 endpoints and Playground

Starting with 9.0.0.cl, the REST API v2 Beta API endpoints are deprecated and removed from the REST API v2 Playground. A set of new endpoints is now generally available (GA) on all ThoughtSpot instances.

The new REST API v2.0 endpoints introduce several improvements to the request and response structure and let you perform more tasks in a single API call. For example, you can create a new user, map the user to groups and Orgs, set home Liveboards for the user, and assign privileges in a single API request.

  • All REST API v2 Beta endpoints are deprecated, but remain functional until further notice. The REST API SDK that was available with REST API v2 Beta version is no longer supported.
    ThoughtSpot does not recommend using REST API v2 Beta endpoints for production use cases. For more information, see Deprecation announcements.

  • The new REST API v2.0 endpoints are not an extension of the REST API v2 Beta endpoints. The resource categories, base path, endpoint URIs, and the structure of API requests and responses are different from those of the REST API v2 Beta version.

  • Some API operations such as the CRUD operations for data connections and passing runtime filters on Liveboard visualizations are not available in the initial release. For more information, see REST API v1 and v2.0 comparison and REST API v2.0 reference.

  • For Org CRUD operations in production environments, ThoughtSpot recommends using REST API v1 endpoints.

Early Access features

Starting from 9.0.0.cl, ThoughtSpot allows its administrators to turn on Early Access features from the Admin portal. Early Access features are qualified by ThoughSpot for customer use but are not enabled by default on ThoughtSpot instances until the features are GA.

The 9.0.0.cl release introduces the following Early Access features:

  • Custom maps

    Allows uploading map files (TopoJSON) to configure custom regions and visualize data on these regions. For more information, see Upload custom geo maps.

  • Mandatory filters

    Allows setting certain filters as mandatory on a Liveboard. For more information, see Mandatory Liveboard filter.

  • Chart configuration experience

    Allows making multiple edits to a chart configuration and applying all changes at once. For more information, see Reorder labels on the axis or legend.

  • Chart data labels

    Allows displaying data labels in a lighter color on charts with a dark background. For more information, see Show data labels.

Visual Embed SDK version 1.19.0

For information about the new features and enhancements introduced in Visual Embed SDK version 1.19.0, see Visual Embed changelog.

REST API

For information about REST API v1 enhancements, see REST API v1 changelog.

Version 8.10.0.cl🔗

Ability to embed only the Search bar in an app Beta

You can now embed the ThoughtSpot search bar component in your app. For example, if you are using Google Sheets for data analysis, you can embed the ThoughtSpot search bar and let your users search data from a specific data source. The embedded Search bar allows passing search tokens and modifying search options. You can also retrieve the search results as raw data and let your host application render it in the format you want.

For more information, see Embed ThoughtSpot search bar.

Advanced style customization with custom CSS

The CSS customization feature supports new variables to customize the look and feel of the following UI elements:

  • Search data button in the navigation panel

  • Font type and text style of search tokens

  • Data panel on the Search and saved Answer pages

  • Filter chips on Liveboard, visualizations, and Answer pages

  • Menu components

  • X-axis and Y-axis titles and labels on charts

For more information, see Customize CSS.

CSP allowlist for font, image and stylesheet sources

You can now enable CSP overrides for font, stylesheet, and image sources in ThoughtSpot UI. If you want to load fonts, stylesheets, images, or favicons from an external source, add the source URLs to the CSP allowlist on the Security Settings page.

For more information, see Security Settings.

Multi-tenancy with Orgs

You can now set up your ThoughtSpot Cloud instance as a multi-tenant cluster and partition it into logical and isolated workspaces called Orgs. Each Org can have its own users, groups, and metadata, and stay independent of and invisible to other Orgs configured on the same application instance.

For more information, see Multi-tenancy with Orgs.

Visual Embed SDK version 1.18.0

For information about the new features and enhancements introduced in Visual Embed SDK version 1.18.0, see Visual Embed changelog.

REST API

For information about REST API v1 enhancements, see REST API changelog.

Version 8.9.0.cl🔗

Improvements to authentication methods and AuthType enums in the SDK

The following changes are introduced in the Visual Embed SDK to improve the authentication framework and options for embedded application users:

  • New auth type enum for embedded SSO authentication

    The AuthType.EmbeddedSSO enum allows you to enable SSO login on embedded instances. This authentication method allows you to use your current SAML IdP or OpenID Connect configuration and redirect users to the IdP for authentication within the embedded iFrame.

  • Changes to the existing AuthType enums:

    • AuthType.SAML is renamed as AuthType.SAMLRedirect

    • AuthType.OIDC is renamed as AuthType.OIDCRedirect

    • AuthType.AuthServer is renamed to AuthType.TrustedAuthToken

For more information, see Authentication.

Just-in-time user creation and dynamic privilege assignment

Starting from 8.9.0.cl, the /tspublic/v1/session/auth/token endpoint supports just-in-time provisioning of users. If the user specified in the API request does not exist in the ThoughtSpot system, you can set the autocreate property to true to add the user to ThoughtSpot and assign the user to groups.

Advanced style customization Beta

ThoughtSpot now allows you to override style specifications of the embedded UI pages and elements with custom CSS. Custom CSS provides granular control over the design elements and lets you modify the properties of these elements to match the look and feel of your host application.

To help users visualize and preview the CSS overrides, the Visual Embed playground will include the Apply custom styles checkbox, which allows you to explore the variables available for customization.

For more information, see Customize styles and layout and Customize CSS using SDK.

Visual Embed SDK version 1.17.0

For information about the new features and enhancements introduced in Visual Embed SDK version 1.17.0, see Visual Embed changelog.

REST API

For information about REST API v1 enhancements, see REST API changelog.

Version 8.8.0.cl🔗

Custom tile size for visualizations on a Liveboard (New Liveboard experience only)

ThoughtSpot users can now customize the tile size of a visualization on a Liveboard. In the earlier versions, ThoughtSpot allowed resizing visualizations using predefined layout options available in the More menu the more options menu. With custom tile size, users can now change the size of a visualization just by clicking and dragging the tile to the desired size.

This feature is in beta and disabled by default on all Thoughtspot instances. To enable this feature on your instance, contact ThoughtSpot Support.

Visual Embed SDK version 1.16.0

For information about the new features and enhancements introduced in Visual Embed SDK version 1.16.0, see Visual Embed changelog.

REST API v1

For information about REST API v1 enhancements, see REST API changelog.

Bug fixes and improvements

Bug fixes and new improvements in embedded user experience.
For more information, see Fixed issues.

Version 8.7.0.cl🔗

Liveboard tabs

The new Liveboard experienceBeta now supports organizing visualizations in tabs. Users with edit access to a Liveboard can add, edit, and move visualizations to tabs on a Liveboard. On embedded ThoughtSpot instances, developers can set a specific tab as an active tab using the Visual Embed SDK.

This feature is available only on deployments that have the new Liveboard experience enabled. For more information, see Customize Liveboard tabs.

Important
The new Liveboard experience is in BETA on embedded ThoughtSpot instances. This feature is turned off by default on embedded ThoughtSpot instances.
Visual Embed SDK version 1.15.0

For information about the new features and enhancements in the Visual Embed SDK version 1.15.0, see Visual Embed changelog.

REST API v1

For information about REST API v1 enhancements, see REST API changelog.

REST API v2 Beta

The REST API v2 Beta feature will be deprecated in 8.10.0.cl and replaced with the new v2.0 API endpoints. For more information, see Deprecation announcements.

Version 8.6.0.cl🔗

Liveboard new experience Beta

The new Liveboard experience is now available on embedded ThoughtSpot instances. In addition to the existing Liveboard features, the new experience introduces several notable changes to the Liveboard page:

Liveboard editing

To edit a Liveboard, users must switch to the edit mode by clicking the Edit button on the Liveboard page. The edit mode allows you to edit the Liveboard title and description text, apply filters, copy the Liveboard, modify the layout of the visualization tiles, delete a visualization, and so on.

Liveboard filters
  • The Liveboard filter configuration options are available on a single modal.

  • When a user creates a copy of a Liveboard, the filters applied to its visualizations are also copied.

Other features and enhancements
  • The Add filters action is placed in the primary menu bar and can be viewed only when a Liveboard is in edit mode. Only users with edit access to the Liveboard can apply filters.

  • The Undo, Redo, and Reset actions for visualizations.

  • The Liveboard Info action label in the More the more options menu menu is renamed to Show Liveboard details.

  • The Schedule action is placed in the More the more options menu menu.

  • Improved visualization Explore experience.

Deprecated features

The following features are not available with the new Liveboard experience:

  • The Copy embed link and Copy link menu actions in the More the more options menu menu of a Liveboard

  • The edit title icon on visualization tiles

  • The Share button on visualizations

For more information about the new Liveboard experience, see New Liveboard experience.

New Liveboard experience rollout on embedded instances🔗

The new Liveboard experience is currently available in BETA on embedded ThoughtSpot instances. The new liveboard experience will be rolled out on embedded instances in phases:

In ThoughtSpot Cloud 8.6.0.cl

The new Liveboard experience is turned off by default on embedded ThoughtSpot instances. If you are using the Visual Embed SDK to embed ThoughtSpot, you can set the liveboardV2 parameter in the SDK package to true and enable the new experience globally for all users on your instance.

ThoughtSpot users with administrator privileges can also turn on the new Liveboard experience at the cluster level.

In later releases

The new Liveboard Experience will be turned on by default for all embed application users. To switch to the classic experience, you can set the liveboardV2 parameter to false in the SDK, or change the Liveboard experience preference in the Admin tab of the ThoughtSpot UI.

Note
The Liveboard experience setting in the SDK takes precedence over the cluster-level settings in the Admin tab.

Actions and Events in the SDK🔗

If you have enabled the new Liveboard experience on your instance, you can use the Action and Event enumeration members available in the SDK package to customize an embedded object and improve interactivity.

For example, to disable the Delete action for a visualization object on the Liveboard, you can use the Action.Remove enum. Similarly, you can trigger events such as VizPointClick on visualizations in an embedded Liveboard.

Visual Embed SDK version 1.14.0

For information about the new features and enhancements in the Visual Embed SDK version 1.14.0, see Visual Embed changelog.

REST API

For information about REST API enhancements, see REST API changelog.

Version 8.5.0.cl🔗

Search Assist support for embedded instances

Your application users can now access sample search walkthrough lessons created using Search Assist on embedded ThoughtSpot instances. If the Search Assist feature is enabled in the SDK, and the Search Assist lessons are created on the Worksheet, users can view sample search questions and follow the actions in the walkthrough to get answers.

For more information, see Enable Search Assist.

Visual Embed SDK 1.13.0

For information about the new features and enhancements in the Visual Embed SDK version 1.13.0, see Visual Embed changelog.

ThoughtSpot UI

The new Data workspace is Generally Available (GA) in 8.5.0.cl on ThoughtSpot instances. For more information about the new Data tab, SpotApps, and other related features, see ThoughtSpot product documentation.

Important
While some customizable actions from the Visual Embed SDK will be honored from within an embedded instance of the new Data workspace page, full support of this page in embedded ThoughtSpot instances is planned for a future release. If you are actively embedding and customizing the Data tab for your application and wish to retain the legacy Data tab, contact ThoughtSpot Support.

Version 8.4.0.cl🔗

Link customization

This release allows query parameters in the Liveboard, saved Answer, and visualization URLs that are customized for an embedded ThoughtSpot instance. For example, you can customize the Unsubscribe link sent in email notifications for KPI charts by adding {ts-query-params} to the visualization URL, and thus allow users to unsubscribe from KPI threshold alerts at any time.

For more information, see Customize links.

Visual Embed SDK 1.12.0

The Visual Embed SDK version 1.12.0 introduces new events. For more information, see Visual Embed changelog.

REST API v2 Beta

NEW ENDPOINTS

This release introduces the following new REST API v2 Beta endpoints:

  • Data

    • GET /tspublic/rest/v2/data/answer/querysql

    • GET /tspublic/rest/v2/data/liveboard/querysql

  • Admin

    • PUT /tspublic/rest/v2/admin/assignauthor

BREAKING CHANGES

  • The method names for the following endpoints will be changed in the SDK.

    • /tspublic/rest/v2/user/addgroup

    • /tspublic/rest/v2/user/removegroup

  • The /tspublic/rest/v2/admin/changeowner endpoint will be renamed as /tspublic/rest/v2/admin/changeauthor.

Version 8.3.0.cl🔗

Visual Embed SDK 1.11.0

The Visual Embed SDK version 1.11.0 introduces several new events for embedded components. For more information, see Visual Embed changelog.

REST API v2 Beta

NEW ENDPOINTS

The following REST API v2 Beta endpoints are now available:

  • Connection endpoints

    • GET /tspublic/rest/v2/connection/database

    • POST /tspublic/rest/v2/connection/table

    • POST /tspublic/rest/v2/connection/tablecoloumn

  • Report endpoint

    • POST /tspublic/rest/v2/report/liveboard

  • Security endpoints

    • POST /tspublic/rest/v2/security/share/tsobject

    • POST /tspublic/rest/v2/security/share/visualization

    • GET /tspublic/rest/v2/security/permission/tsobject

    • GET /tspublic/rest/v2/security/permission/principal

    • POST /tspublic/rest/v2/security/permission/tsobject/search

    • POST /tspublic/rest/v2/security/permission/principal/search

  • Custom action endpoints

    • GET /tspublic/rest/v2/customaction

    • POST /tspublic/rest/v2/customaction/create

    • PUT /tspublic/rest/v2/customaction/update

    • DELETE /tspublic/rest/v2/customaction/delete

    • POST /tspublic/rest/v2/customaction/search

    • GET /tspublic/rest/v2/customaction/association

    • DELETE /tspublic/rest/v2/customactions/association/delete

MODIFIED

  • The x-requested-by header is not mandatory for API requests to the REST API v2 Beta endpoints.

  • The createdBy attribute in the /tspublic/rest/v2/metadata/header/search API is renamed to author.

  • The attributes with the boolean data type in the API endpoints are changed to string data type. If a boolean attribute was set as true in your existing setup, the value will be changed to "true".

BREAKING CHANGES

  • Note the change in HTTP request method for the following REST API v2 Beta endpoints:

    • PUT /tspublic/rest/v2/metadata/tag/assign

    • PUT /tspublic/rest/v2/metadata/tag/unassign

    • PUT /tspublic/rest/v2/metadata/favorite/assign

    • PUT /tspublic/rest/v2/metadata/favorite/unassign

    • PUT /tspublic/rest/v2/metadata/homeliveboard/assign

    • PUT /tspublic/rest/v2/metadata/homeliveboard/unassign

  • In the REST API SDK Beta, the classes corresponding to enumerations used for string fields such as the type field in metadata API, are renamed. If you are using the REST API SDK in your environments, make sure the class names are updated.

REMOVED

The ownedBy attribute is removed from the /tspublic/rest/v2/metadata/header/search API endpoint.

Version 8.2.0.cl🔗

Visual Embed SDK 1.10.x

The Visual Embed SDK version 1.10.x introduces new attributes and bug fixes. For more information, see Visual Embed changelog.

REST API v1

New endpoints for data connection queries. For more information, see REST API v1 changelog.

REST API v2 Beta

Starting from 8.2.0.cl release, the REST API Playground and SDK Beta feature is enabled by default on ThoughtSpot instances.

The 8.2.0.cl release also introduces the following features:

Endpoint URL path

The REST API v2 Beta endpoint URL path is changed from /api/rest/v2 to /tspublic/rest/v2/. For example, the GET /api/rest/v2/connection endpoint is now available as GET /tspublic/rest/v2/connection.

Trusted authentication

If trusted authentication is enabled on your instance, you can now obtain a login token to authenticate to ThoughtSpot and authorize your API requests.

For more information, see REST API v2 authentication.

SDK for .NET clients

ThoughtSpot provides the .NET SDK to allow developers to interact with REST APIs from .NET applications. You can download the SDK from NuGet Package Manager and install it using the NuGet GUI. For more information, see REST API SDK and client libraries.

New API endpoints
  • GET /tspublic/rest/v2/admin/configuration

  • GET /tspublic/rest/v2/admin/configuration/overrides

  • PUT /tspublic/rest/v2/admin/configuration/update

  • PUT /tspublic/rest/v2/admin/resetpassword

  • PUT /tspublic/rest/v2/admin/syncprincipal

  • PUT /tspublic/rest/v2/admin/changeowner

  • PUT /tspublic/rest/v2/user/changepassword

  • POST /tspublic/rest/v2/data/search

  • POST /tspublic/rest/v2/data/answer

  • POST /tspublic/rest/v2/data/liveboard

  • POST /tspublic/rest/v2/report/answer

  • GET /tspublic/rest/v2/logs/events

For more information, see REST API v2 Reference.

Version 8.1.0.cl🔗

Visual Embed SDK version 1.9.x

The Visual Embed SDK version 1.9.x introduces new action enumerations, events, and attributes. For more information, see Visual Embed Changelog.

REST API v2 Beta

The following REST API v2 endpoints are now available on instances on which the REST API v2 Playground and SDK feature is enabled.

  • GET /api/rest/v2/connection

  • POST /api/rest/v2/connection/create

  • PUT /api/rest/v2/connection/update

  • DELETE /api/rest/v2/connection/delete

  • PUT /api/rest/v2/connection/addtable

  • PUT /api/rest/v2/connection/removetable

  • POST /api/rest/v2/connection/search

  • DELETE /api/rest/v2/metadata/delete

  • GET /api/rest/v2/metadata/header

The REST API v2 Playground and SDK is a limited availability feature and is in beta.

For more information, see REST API v2 and REST API v2 Reference.

Version 8.0.0.cl🔗

Visual Embed SDK version 1.8.x

BREAKING CHANGE

Auto login

The autoLogin attribute is now set as false by default. This attribute is used in the init method to automatically re-login a user when a user session expires.

NEW FEATURE

Authentication

The init method now returns an authPromise that resolves when the authentication is completed.

Embed application

NEW FEATURE

OpenID Connect authentication

ThoughtSpot now supports OpenID Connect (OIDC) authentication framework on embedded instances. Your application users can now authenticate to an authorization server at your OpenID provider and access embedded ThoughtSpot content using their SSO credentials.

For more information, see OpenID Connect authentication.

REMOVED

Follow button

If you have embedded the full ThoughtSpot application, you will notice that the Follow button on the Liveboards page is removed. You can now schedule email notifications using the Schedule feature and follow Liveboard updates.

Visual Embed SDK 1.7.0

NEW FEATURE

OIDC AuthType

The SDK supports the OIDC authType in init calls. If you want your application users to authenticate to an OpenID provider and use their SSO credentials to access the embedded ThoughtSpot content, you can enable the OIDC authentication type in the SDK.

For more information, see Authentication and security attributes.

NEW FEATURE

Embed events

The SDK includes the following new event:

  • RouteChange

For more information, see Events reference.

REST API Playground and SDK Beta

NEW FEATURE

REST API Playground and SDK

ThoughtSpot introduces the v2 Beta version of REST API endpoints and an interactive Playground to explore the API request and response workflows.

The API Playground offers several distinct features, such as an interactive code panel, a catalog of resource-oriented endpoint URLs, language-specific SDK and client libraries, code samples, and API reference documentation.

You can use any standards-compliant HTTP client or use the Playground to make an API call. If you want to construct your queries and process API responses programmatically, you can download the SDK and client libraries in the programming language of your choice and integrate them with your applications.

The REST API Playground and SDK is a limited availability feature and is in beta. To preview this feature, visit ThoughtSpot Live Playground. To enable this feature on your ThoughtSpot instance, contact ThoughtSpot Support.

For more information, see REST API v2.

Version ts8.nov.cl🔗

Developer portal

CHANGE NOTICE

Pinboards are now Liveboards!

Effective from the ThoughtSpot 8 November Cloud release, ThoughtSpot pinboards are rebranded as Liveboards and optimized for live analytics in cloud deployments. Along with granular insights, Liveboards offer interactive data analytics experience with enhanced capabilities.

As part of rebranding, we have made some terminology changes in the ThoughtSpot UI and Developer portal. We are in the process of rolling out terminology changes across all ThoughtSpot interfaces, platforms, and information artifacts. During this period, your environment may show some instances of pinboard based on the rebranding rollout stage. In some cases, we may even continue to use the legacy terminology for backward compatibility, and to ensure that your existing integrations work seamlessly. For more information, see Terminology changes.

Custom actions

NEW FEATURE

Custom action association to user groups

ThoughtSpot now allows you to restrict a custom action’s availability to specific user groups. Developers can associate a custom action to one or several user groups in the Developer portal and allow only authorized users to view and access the custom action on a Worksheet, Answer, or visualization.

For more information, see Custom actions and Configure a custom URL action.

User access

NEW FEATURE

ThoughtSpot now supports restricting embed user access to the non-embedded ThoughtSpot application instance. By default, all embedded ThoughtSpot users can navigate to and log in to the non-embedded ThoughtSpot application instance. If you want to allow only users with administrator or developer privileges to access the non-embedded ThoughtSpot application instance, contact ThoughtSpot Support.

Visual Embed SDK version 1.6.x

NEW FEATURE

Visible actions

You can now configure a set of ThoughtSpot UI actions as visible actions and display these actions in the embedded UI. If your embedded instance requires only a few actions, you can use the visibleActions API to show only these actions in the embedded ThoughtSpot UI.

For more information, see Show or hide UI actions.

MODIFIED

Terminology changes

The SDK library and object parameter names are modified to rebrand pinboards as Liveboards. For a complete list of changes, see Terminology changes.

NEW FEATURE

Embed events

The SDK supports the following new events:

  • DialogOpen

  • DialogClose

For more information, see Events reference.

REST API

NEW FEATURE

POST /tspublic/v1/session/login/token

This API allows you to send the login token and user information in the request body. For more information, see the REST API reference page.

MODIFIED

The /tspublic/v1/connection/create and /tspublic/v1/connection/update endpoints now allow configuring and modifying a connection without importing tables.

For more information, see Data connection APIs.

MODIFIED

You can now filter metadata objects by author GUIDs using the authorguid attribute in the /tspublic/v1/metadata/list endpoint.

For more information, see Get a list of metadata objects.

ThoughtSpot application UI

To make it easier for users to find new insights, the Search data functionality is moved from the search bar toggle on the Home page to the Search data button in the main navigation bar.

Note that if you are embedding the full application without the navigation bar, your application users may not be able to access the Search data button. If you must include the Search bar toggle on the Home page, contact ThoughtSpot Support to restore this feature on your cluster.

Search toggle

Search data button

Version ts7.oct.cl🔗

Custom actions

MODIFIED

Custom actions feature availability

Starting from ThoughtSpot 7 Cloud October release, you do not require a separate license to create or manage custom actions. The Custom action feature is unlocked on all clusters that have a valid ThoughtSpot Enterprise Cloud service subscription. ThoughtSpot Cloud service users with Developer or Admin privileges can access the Custom actions feature in the Develop tab.

REMOVED

The Only allow in context menu checkbox

The Only allow in context menu checkbox in the custom action creation dialog is removed from the UI. This checkbox was available in previous releases to allow developers to set a custom action to appear only in the contextual menu on pinboard visualizations, charts, or tables.

If you have created custom actions with the Only allow in context menu setting enabled on your instance, note these custom action workflow changes:

  • If you have a Global custom action with the Only allow in context menu setting enabled, the configuration setting is not preserved and the action is placed in the More the more options menu menu instead of the contextual menu.

    You can modify the position of this action by using the Edit option in the Custom actions panel on a visualization or search results page.

  • If you have a Local custom action with the Only allow in context menu setting enabled and the action is already assigned to a Worksheet, visualization, chart, or table, the configuration setting is preserved and the custom action shows up in the contextual menu.

  • If you have a Local custom action with the Only allow in context menu setting enabled, but it is not assigned to a Worksheet, visualization, chart, or table, the action will not be available as a menu item or button. You must add the action to a visualization, chart, or table, and configure its position as required. For more information, see Add a custom action to a visualization and Add custom actions to a Worksheet.

Visual Embed SDK version 1.5.0

The ThoughtSpot 7 Cloud October release introduces the Visual Embed SDK version 1.5.0, which includes the following new features and enhancements.

NEW FEATURE

Render embedded objects in queue

The SDK now supports rendering embedded objects in a queue. If you have multiple embedded objects, you can enable the queueMultiRenders parameter to queue your embedded objects and render them one after another. This feature helps in decreasing the load on the web browsers and improving your application loading experience. By default, this attribute is set to false.

NEW FEATURE

Liveboard embed

The pinboardEmbed package includes the defaultHeight attribute that sets a minimum height for embedded objects on a pinboard page and the corresponding visualization pages that a user can navigate to.

For more information, see Embed a pinboard.

NEW FEATURE

Embed events

The SDK EmbedEvent library includes the following new events:

  • VizPointDoubleClick

  • Drilldown

  • SetVisibleVizs

For more information, see Events reference.

REST APIs

The ThoughtSpot 7 Cloud October release includes the following new REST API endpoints. For more information about these APIs, see REST API Reference.

  • POST /tspublic/v1/group/{groupid}/users

  • GET /tspublic/v1/group/{groupid}/users

  • DELETE /tspublic/v1/group/{groupid}/users

  • PUT /tspublic/v1/user/email

  • POST /tspublic/v1/user/{userid}/groups

  • GET /tspublic/v1/user/{userid}/groups

  • PUT /tspublic/v1/user/{userid}/groups

  • DELETE /tspublic/v1/user/{userid}/groups

Version ts7.sep.cl🔗

Licensing

NEW FEATURE

New ThoughtSpot license for embedded analytics

ThoughtSpot introduces the ThoughtSpot Embedded Edition license that grants access to Developer portal, Playground, customization workflows, Visual Embed SDK, and REST APIs. If you have a ThoughtSpot Enterprise Cloud Service subscription and you want to avail the benefits of ThoughtSpot Embedded analytics, you can now request for a license upgrade.

The new licensing model introduces several notable changes in the ThoughtSpot Developer portal:

  • On clusters that do not have the ThoughtSpot Embedded Edition license, the ThoughtSpot Developer Portal displays a locked icon next to the customization menu actions. When you click the locked icon, the UI prompts you to sign up for a free trial or upgrade your license.

  • The ThoughtSpot Enterprise Cloud service subscribers can either start a 30-day free trial or initiate a license upgrade from the UI.

  • Free trial users can initiate a license upgrade request by clicking Upgrade Now at any time during the evaluation period, or when the trial expires.

  • If you click Upgrade or Upgrade Now, ThoughtSpot opens the Live Chat Support widget. You can start a conversation with the Sales personnel to initiate the license upgrade.

For more information about the licensing model and upgrade process, see Get started with embedded analytics.

Developer portal enhancements

NEW FEATURE

Developer Playground enhancements

  • The Full app Playground page includes the Hide profile and help checkbox to provide a preview of the disableHelpAndProfile function that can hide the Help and Profile icons in the ThoughtSpot navigation bar.

  • The Full Height checkbox in Pinboard Playground provides a preview of the fullHeight attribute that can dynamically resize the embedded pinboard frame according to the height of the pinboard.

For more information, see Developer Playground.

Visual Embed SDK version 1.4.0

The ThoughtSpot 7 Cloud September release introduces the Visual Embed SDK version 1.4.0, which includes the following new features and enhancements.

NEW FEATURE

Prefetch API

The prefetch API fetches static resources from a given URL before your application loads. Web browsers can then cache the prefetched resources locally and serve them from a user’s local disk. You can use this API to load the embedded objects faster and improve your application response time.

For more information, see Prefetch static resources.

NEW FEATURE

In-app page navigation

The navigateToPage method in the SDK lets you provide quick and direct access to a specific pinboard, saved Answer, or an application page. You can add a custom menu action or button in your application UI that calls the navigateToPage method and leads your users to the page specified in the path parameter.

For more information, see Add a custom action for in-app navigation.

NEW FEATURE

Full application embedding

The appEmbed SDK package includes the following new attributes:

  • The disableProfileAndHelp attribute to show or hide the Help (?) and the user profile menu in the navigation bar of your embedded app.

  • The hideObjects attribute to hide specific objects from a user’s page view.

For more information, see Embed full application.

NEW FEATURE

Search embed

The searchEmbed package includes the forceTable attribute that sets tabular view as the default format for presenting search data. You can use set this attribute to true to force search results to appear in the table view.

For more information, see Embed ThoughtSpot search.

REMOVED

The searchQuery parameter is no longer supported and is removed from the searchEmbed SDK package.

NEW FEATURE

Embed events
The SDK EmbedEvent library includes the following events:

  • QueryChanged

  • AuthExpire

For more information, see Subscribe to Events.

REST APIs

The ThoughtSpot 7 Cloud September release includes the following new endpoints and modifications to the REST APIs. For more information, see REST API Reference.

New APIs
  • POST /tspublic/v1/connection/create

  • POST /tspublic/v1/connection/update

  • POST /tspublic/v1/connection/export

  • POST /tspublic/v1/connection/delete

  • POST /tspublic/v1/metadata/unassigntag

  • GET /tspublic/v1/metadata/list

  • GET /tspublic/v1/security/metadata/permissions

  • GET /tspublic/v1/security/metadata/{id}/permissions

  • GET /tspublic/v1/security/effectivepermissionbulk

  • GET /tspublic/v1/session/info

  • POST /tspublic/v1/user/activate

  • POST /tspublic/v1/user/inactivate

  • POST /tspublic/v1/user/session/invalidate

  • POST /tspublic/v1/user/resetpassword

  • PUT /tspublic/v1/group/{groupid}/users

  • POST /tspublic/v1/group/{groupid}/groups

  • PUT /tspublic/v1/group/{groupid}/groups

  • GET /tspublic/v1/group/{groupid}/groups

  • POST /tspublic/v1/group/addmemberships

  • POST /tspublic/v1/group/removememberships

  • DELETE /tspublic/v1/group/{groupid}/groups

Modified APIs
  • POST /tspublic/v1/metadata/assigntag

Version ts7.aug.cl🔗

Custom actions

NEW FEATURE

Custom actions for worksheets

The Worksheet pages now include a Custom actions tab that shows the custom actions created in the Developer portal. ThoughtSpot users can add these actions to a Worksheet and place them as primary actions or menu items in the new visualizations built from that Worksheet.

This feature is available to all ThoughtSpot users who have edit privileges to a Worksheet.

For more information, see Add custom actions to a Worksheet.

NEW FEATURE

Query parameters for URL-based custom actions

The Developer portal now allows you to add arbitrary key-value pairs as query parameters for a URL action. If a URL endpoint requires specific information, such as the database details or data object attributes, you can add a key-value pair of these attributes when creating a custom action. When the custom action workflow is triggered, these attributes are passed as query parameters in GET requests to get the data payload from ThoughtSpot.

For more information, see Configure a custom URL action.

Visual Embed SDK version 1.3.1

The ThoughtSpot 7 Cloud August release supports Visual Embed SDK version 1.3.1, which includes the following features and enhancements.

NEW FEATURE

searchOptions

The searchEmbed SDK package introduces the searchOptions parameter for setting search tokens. The searchOptions parameter includes the following attributes:

  • searchTokenString

    A TML query string to define search tokens.

  • executeSearch

    When set to true, it executes search and shows the search results.

For more information, see Embed ThoughtSpot search.

DEPRECATED

searchQuery

The searchQuery parameter in the searchEmbed SDK package is deprecated in the Visual Embed SDK version 1.3.1. Instead, you can use the searchOptions parameter to define the search token string.

For more information about searchOptions, see Embed ThoughtSpot search.

NEW FEATURE

autoLogin

The SDK now supports logging in users automatically after a user session has expired.

For more information, see Embed user authentication.

NEW FEATURE

shouldEncodeUrlQueryParams

You can now convert query parameters in the ThoughtSpot generated URLs to base64-encoded format. You can enable this attribute to secure your cluster from cross-site scripting attacks.

BREAKING CHANGE

Data structure changes in custom action response payloads

  • The data structure passed in the custom action response for search now shows as payload.data.embedAnswerData instead of payload.data.columnsAndData.

  • The Answer payload for custom actions includes the following metadata:

    • reportBookmetadata

      Includes visualization metadata attributes such as description, object header metadata, author details, timestamp of the Answer creation, and modification.

    • user data

      Includes user information such as username, GUID of the user, and email address.

To view a sample response payload, see Custom action response payload.

NEW FEATURE

preventPinboardFilterRemoval

The pinboardEmbed SDK package now includes the preventPinboardFilterRemoval attribute. You can use this attribute to disable the filter removal action and thus prevent users from removing the filter chips added on a pinboard page.

For more information, see Embed a pinboard and Embed a visualization.

NEW FEATURE

suppressNoCookieAccessAlert

You can now set custom alerts for noCookieAccess events. By default, the SDK triggers a noCookieAccess event and generates an alert when a user’s browser blocks third-party cookies. The suppressNoCookieAccessAlert allows you to disable this alert.

NEW FEATURE

Support for fetching callback custom action payload in batches

The Visual Embed SDK now supports processing data in batches for callback custom action responses. The callback custom action event in the SDK package supports defining batchSize and offset values to paginate the Answer payload and send the records in batches.

For more information, see Callback custom action workflow.

REST APIs

The ThoughtSpot 7 Cloud August release introduces several new APIs to manage users, user groups, cluster configuration, object dependencies, and so on.

For a complete list of APIs, see REST API Reference.

Version ts7.jun.cl🔗

Custom actions

NEW FEATURE

Global and local custom actions

The ThoughtSpot developer portal now supports configuring a custom action as a global or local action. This feature allows you to determine and control the placement of custom actions in the ThoughtSpot UI. Developers can now choose to create a custom action that will appear on all visualizations, or a specific custom action that can be added to a visualization by a ThoughtSpot user. The custom actions panel in the visualization page allows ThoughtSpot users to view the available custom actions and add an action to any visualization.

For example, if you want an action that triggers a callback into your parent app, which would then post its data to Slack, you might want to add a custom action globally to all visualizations. Similarly, if you want to send the data obtained from a specific visualization to a URL, you can associate a custom action locally to that visualization.

NEW FEATURE

Authentication schemes for custom actions

You can now apply an authentication scheme for a custom action that triggers a data payload to a specific URL target. If an action requires your users to authenticate to send data to a URL, you can specify the authentication method and authorization attributes when creating a custom action in the Developer portal. ThoughtSpot will use this information to send the required attributes in the Authorization headers to the URL endpoint configured in the custom action.

NEW FEATURE

Custom action position settings

ThoughtSpot users with edit privileges can now define or modify the position of a custom action on visualization pages. When a developer creates a custom action in the Developer portal, ThoughtSpot adds a menu item to the More the more options menu menu by default. ThoughtSpot users can change this to a context menu action or a primary action at any time.

If your application instance requires an action that sends only a single row of data from charts or tables, developers can configure a custom action and restrict it to only the contextual menu. If this setting is enabled on a custom action, ThoughtSpot users cannot modify this action on a visualization page.

Custom link format for embedded instances

ThoughtSpot generates links to access objects, such as pinboards, visualizations, and answers, when a user shares an object with another user or follows a pinboard to receive periodic notifications. If you have embedded ThoughtSpot in your application, you might want to generate these links in the format that preserves your host application context.

For embedded instances, ThoughtSpot now allows you to customize the format of these links in the Developer portal. The Link Settings page in the Developer portal allows you to customize the link format for various resource URLs and the unsubscribe link sent in email notifications.

For more information, see Customize links.

REST APIs

The ThoughtSpot 7 Cloud June release includes several new and modified APIs:

New APIs
  • POST /tspublic/v1/security/share

    Use this API to share ThoughtSpot objects with another user or user group. For more information, see Share objects with another user.

  • POST /tspublic/v1/security/shareviz

    Use this API to share a specific ThoughtSpot visualization with another user or user group. For more information, see Share a visualization with another user or user group.

  • GET /tspublic/v1/session/login/token

    Use this API to get a login token for a ThoughtSpot user when trusted authentication is enabled. For more information, see Authenticate and log in a user.

  • POST /tspublic/v1/metadata/assigntag

    Use this API to programmatically assign a tag to a ThoughtSpot object such as a pinboard, Answer, table, or Worksheet. For more information, see Assign tags to metadata objects.

  • POST /tspublic/v1/metadata/details

    Use this API to query metadata details for a specific data object such as a pinboard, Answer, or a Worksheet. For more information, see Get metadata details.

  • POST /tspublic/v1/metadata/markunmarkfavoritefor

    Use this API to add pinboards and answers to a user’s favorites list. For more information, see Set objects as favorites.

  • DELETE /tspublic/v1/metadata/markunmarkfavoritefor

    Use this API to remove an object from a user’s favorites list. For more information, see Remove objects from favorites.

  • POST /tspublic/v1/session/homepinboard

    Use this API to set a pinboard as the home pinboard for a user account. For more information, see Set a pinboard as a home pinboard.

  • GET /tspublic/v1/session/homepinboard

    Use this API to get the GUID of the pinboard set as a home pinboard. For more information, see Get details of the home pinboard.

  • DELETE /tspublic/v1/session/homepinboard

    Use this API to remove the home pinboard. For more information, see Remove a home pinboard.

Other API enhancements

The POST /tspublic/v1/user/updatepreference API now includes the optional username parameter to allow API users to specify the username of the ThoughtSpot user whose profile is being modified. For more information, see Update a user profile.

Version ts7.may.cl🔗

Custom actions in the context menu

You can now add a custom action to the contextual menu to send data or initiate an action from an embedded visualization. The Customization > Actions page in the Develop tab allows you to add a custom action to the contextual menu for visualizations in the Answers or Pinboards page.

Note
This feature is available only if the New Answer experience is enabled on your ThoughtSpot instance.

For more information, see Add custom actions.

Visual Embed SDK version 1.2.0

NEW FEATURE

SAML authentication

The Visual Embed SDK packages now include the noRedirect attribute as an optional parameter for the SSO AuthType. If you want to display the SAML authentication workflow in a pop-up window, instead of refreshing the application web page to direct users to the SAML login page, you can set the noRedirect attribute to true.

For more information, see the instructions for embedding ThoughtSpot pages, search, pinboard, and visualizations.

NEW FEATURE

Visual Embed SDK notification when third-party cookies are disabled

When a user accesses the embedded application from a web browser that has third-party cookies disabled, the Visual Embed SDK emits the NoCookieAccess event to notify the developer. Cookies are disabled by default in Safari. Users can enable third-party cookies in Safari’s Preferences setting page or use another web browser. To know how to enable this setting by default on Safari for a ThoughtSpot embedded instance, contact ThoughtSpot Support.

NEW FEATURE

Pinboard actions
The More menu the more options menu in the embedded Pinboard page now shows the following actions for pinboard and visualizations.

Pinboard
  • Save

  • Make a copy

  • Add filters

  • Configure filters

  • Present

  • Download as PDF

  • Pinboard info

  • Manage schedules

Note
Users with edit permissions can view and access the Save, Add filters, Configure filters, and Manage schedules actions.

NEW FEATURE

Visualization actions

Visualizations on a pinboard:

  • Pin

  • Download

  • Edit

  • Present

  • Download as CSV

  • Download as XLSX

  • Download as PDF

Note
Users with edit permissions can view and access the Edit action. The Download as CSV, Download as XSLX, and Download as PDF actions are available for table visualizations. The Download action is available for chart visualizations.
Performance optimization

This release introduces the following performance improvements for ThoughtSpot embedded applications:

  • Faster loading of embedded objects and application pages.

  • Faster loading of preview results in the Playground.

REST APIs

The ThoughtSpot 7 Cloud May release introduces the following REST APIs:

  • POST /tspublic/v1/user/updatepreference

    You can use this API to programmatically update a ThoughtSpot user’s profile settings such as the email address, locale preference, notification settings, and the preference for revisiting the onboarding experience. For more information, see User API.

  • GET /tspublic/v1/metadata/listas

    You can use this API to get a list of object headers for a ThoughtSpot user or user group. For more information, see Metadata API.