import {
SpotterEmbed,
SpotterExperienceVersion,
AuthType,
init,
} from '@thoughtspot/visual-embed-sdk';
init({
thoughtSpotHost: 'https://your-thoughtspot-host',
authType: AuthType.None,
});
const spotterEmbed = new SpotterEmbed(document.getElementById('ts-embed'), {
frameParams: {
height: '100%',
width: '100%',
},
worksheetId: 'your-worksheet-id',
spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
//... other configuration attributes
});
spotterEmbed.render();
Embed the new Spotter experience
ThoughtSpot introduces a new Spotter experience where Spotter opens in a side panel on a Liveboard and uses the entire board, including its charts, tabs, groups, note tiles, and applied filters, as conversation context. The Spotter home page also moves to the new experience, and conversations are saved with the Liveboard so users can return to them later.
The new experience is disabled by default. You can enable it using the spotterExperienceVersion attribute in full application, Liveboard, or Spotter embedding.
Before you begin🔗
Ensure you have the following setup:
-
Your ThoughtSpot instance must be running 26.11.0.cl or later, with the new experience enabled at the instance or Org level. A ThoughtSpot administrator enables it from Admin > ThoughtSpot AI > Choose Spotter 3 Liveboard experience > Liveboard side panel (New). The setting can be applied to the whole instance or to a single Org.
-
Your host application domain is added to ThoughtSpot CSP and CORS allowlists.
-
Your embedding application project has Visual Embed SDK v1.53.0 or later. Some of the controls described on this page need a later SDK version. The required version is noted for each control.
Enabling the new Spotter experience🔗
To enable the new Spotter experience in your embed, set the spotterExperienceVersion property to SpotterExperienceVersion.SPOTTER_2026_11 in your embed configuration. The property is available in SpotterEmbed, LiveboardEmbed, and AppEmbed, and the SpotterExperienceVersion enum is exported from the SDK.
|
Note
|
If you set |
- Spotter embed
- Liveboard embed
import {
LiveboardEmbed,
SpotterExperienceVersion,
AuthType,
init,
} from '@thoughtspot/visual-embed-sdk';
init({
thoughtSpotHost: 'https://your-thoughtspot-host', // Replace with your ThoughtSpot URL
authType: AuthType.None,
});
const liveboardEmbed = new LiveboardEmbed(document.getElementById('ts-embed'), {
frameParams: {
height: '100%',
width: '100%',
},
liveboardId: 'your-Liveboard-id', // Replace with your Liveboard ID
spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
//... other configuration attributes
});
liveboardEmbed.render();
- Full application embed
import {
AppEmbed,
Page,
SpotterExperienceVersion,
AuthType,
init,
} from '@thoughtspot/visual-embed-sdk';
init({
thoughtSpotHost: 'https://your-thoughtspot-host', // Replace with your ThoughtSpot URL
authType: AuthType.None,
});
const appEmbed = new AppEmbed(document.getElementById('ts-embed'), {
frameParams: {
height: '100%',
width: '100%',
},
pageId: Page.Home,
spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
//... other configuration attributes
});
appEmbed.render();
Spotter on Liveboards in embedded apps🔗
When the new experience is enabled, you’ll see the following behavior:
-
Spotter opens in a side panel next to the Liveboard, and the board stays usable while the panel is open. The board resizes to make room for the panel.
-
Spotter reads every tab, group, chart, and insight on the Liveboard, so users can ask about one chart, several selected tiles, or the whole board.
-
Answers respect the filters applied to the Liveboard. Users do not need to restate filter context in their questions.
-
The Spotter button on a chart opens the Spotter panel and adds the chart to it as a reference to set context, instead of opening a pop-up for that one chart. Users can select several charts, groups, and note tiles as context.
-
Spotter can use a note tile, such as a tile with quarterly targets, as context next to the data.
-
On a Liveboard, Spotter uses only the data models behind that Liveboard. Make sure Spotter is enabled on those models.
-
Conversations are saved with the Liveboard, and users can continue them later.
-
When the Liveboard is switched to edit mode, the Spotter panel closes. To control who can enter edit mode in your embed, see SDK controls for the new experience.
-
The panel opens automatically when the Liveboard loads. To change this, see SDK controls for the new experience.
const liveboardEmbed = new LiveboardEmbed(document.getElementById('ts-embed'), {
liveboardId: 'your-liveboard-id',
spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11,
//... other configuration attributes
});
Spotter panel visibility🔗
If the panel is missing from a Liveboard embed, check these conditions:
-
You are embedding a single visualization instead of the full Liveboard.
-
The user doesn’t have permission to use Spotter.
-
The Liveboard doesn’t contain any visualization.
-
None of the Liveboard’s visualizations are based on a data model that has Spotter enabled.
-
The Spotter button is hidden or turned off with
Action.SpotterOnLiveboard.
Comparison with the standard Spotter experience🔗
The following table compares Spotter on Liveboards (the new experience) with the standard Spotter experience, which includes the Spotter classic, Spotter 2, and Spotter 3 experiences. It summarizes the differences that matter most to embed developers, including the capabilities that aren’t available yet in the new experience. Responses and charts, code-based analysis, and data and permissions work the same in both experiences.
| Area | Standard Spotter experience (including Spotter classic, Spotter 2, and Spotter 3) | Spotter on Liveboards (new experience) |
|---|---|---|
Where users ask a question | Spotter home page, and a pop-up for one chart on a Liveboard. | Spotter home page, and a side panel on the whole Liveboard. |
Context on a Liveboard | The selected chart. | The entire Liveboard, including its tabs, groups, charts, note tiles, and applied filters. |
Embed property | Default. The | The |
Data model selection | Configurable with the automatic data model selection setting. | Automatic data model selection is on by default. New conversations on the Spotter home page search all data models the user can access, and users can still pick a specific model. On a Liveboard, the selection is limited to the underlying data models used to generate its visualizations. |
Chat history | Controlled by the Enable chat history setting at the instance level and | Chat history on by default. Retention is 6 hours, 30, 90, or 180 days. Currently, there is no option available in the SDK to turn off chat history in the new experience. To turn chat history off, contact your ThoughtSpot administrator. |
Spotter conversations on a Liveboard | Not saved with the Liveboard. | Saved with the Liveboard. |
Clarifying questions | Not available. | Available. When Spotter is unsure what a question means, it asks a clarifying question with options to choose from. |
Deep analysis | Available. | Not available. Spotter decides the depth of analysis from the question. |
Monitoring | Spotter conversations Liveboard. | Usage metrics Liveboard and an all chats list, available to administrators only. |
Existing conversations | Saved in the standard Spotter experience. | Copied to the new experience in the background, with their original dates and IDs, so deep links from your host application keep working. Conversations added in the new experience are not copied to the standard Spotter experience. |
CSV file upload | Available in Spotter 2 and Spotter 3. | Available. Users can upload a CSV file and analyze it alongside the Liveboard data in the same conversation. |
Data model instructions and data preview | Shown in the Spotter view. | Not shown in the Spotter view. Users can still view them on the data model. |
Connectors, personal memory, agent instructions, and custom calendars | Available. | Available. Each connector stays off until an administrator, or a user with the Can manage Spotter privilege, turns it on. |
Edit and drill down on answers | Available. | Not available. |
Sharing conversations and shared links | Available. | Not available. The |
Searching conversations in the Spotter panel | Available. | Available. |
Scheduling questions | Available. | Not available. |
Report generation (PDF) and benchmarks | Available. | Not available. |
Spotter Analysts | Available on the Spotter home page. | Not available in the Spotter panel on a Liveboard. |
Mobile and Slack app | Supported. | Not supported. They continue to use the standard Spotter experience. |
SDK controls for the new experience🔗
The following Visual Embed SDK options are available in embeds that use the new experience:
-
spotterChatConfig.openSpotterOnLiveboardByDefault: Controls whether the Spotter panel opens automatically when the Liveboard loads. The default value istrue. Set it tofalseto load the Liveboard with the panel closed. Supported inLiveboardEmbedandAppEmbedfrom v1.53.0 onwards.const liveboardEmbed = new LiveboardEmbed(document.getElementById('ts-embed'), { liveboardId: 'your-liveboard-id', spotterExperienceVersion: SpotterExperienceVersion.SPOTTER_2026_11, spotterChatConfig: { openSpotterOnLiveboardByDefault: false, }, }); -
Action.SpotterOnLiveboard: Controls the Spotter button in the Liveboard header. Add it tohiddenActionsto remove the Spotter panel completely. Add it todisabledActionsto grey out the header button. Supported inLiveboardEmbedandAppEmbedfrom v1.53.0 onwards. -
Action.EditLiveboardandAction.EditVisualization: Hide or turn off the Edit option on a Liveboard or a visualization independently.Action.Editcontinues to control both. Because the Spotter panel closes when a Liveboard enters edit mode, you can use these actions to control when users leave Spotter. Supported inLiveboardEmbedandAppEmbedfrom v1.54.0 onwards. -
EmbedEvent.EditLiveboardandEmbedEvent.EditVisualization: Fire when a user selects Edit on a Liveboard or a visualization, alongsideEmbedEvent.Edit. Supported from v1.54.0 onwards. -
HostEvent.EditLiveboardandHostEvent.EditVisualization: Trigger Edit on one surface.EditVisualizationrequires avizId. Supported from v1.54.0 onwards.
Switching to the standard Spotter experience🔗
To switch to the standard experience at any time:
-
Remove the
spotterExperienceVersionproperty from your embed configuration and re-render the embed. -
If the new experience is enabled in your instance or Org, contact your administrators to turn it off and return to the standard Spotter experience.
Note that when you switch to the standard experience, conversations started in the new experience aren’t available in the standard Spotter experience, and shared links don’t move between experiences.