The ThoughtSpot Visual Embed SDK provides a JavaScript library for embedding ThoughtSpot search, visualizations, Liveboards, and the full application experience in an application, product, or web portal.

Note: Starting in December 2021, ThoughtSpot rebranded pinboards as Liveboards. For backward compatibility, we currently support internal processes and external methods that use the older naming convention.

The Visual Embed SDK provides a Javascript library to embed ThoughtSpot elements in your host application.

You can use the Visual Embed SDK for the following purposes:

• Embed specific components of the ThoughtSpot application; for example, search, Liveboards, and visualizations.

• Render full ThoughtSpot experience within the context of your host application.

SDK installation

The Visual Embed SDK is available as a Node Package Manager (NPM) package. You can access this package at https://www.npmjs.com/package/@thoughtspot/visual-embed-sdk. Before installing the SDK, make sure you have installed the NPM.

Visual Embed SDK APIs

The Visual Embed SDK includes the following embed modules:

• SearchEmbed
  Use the SearchEmbed component to embed the ThoughtSpot search functionality and retrieve search data from a specific data source or an existing saved answer.

• PinboardEmbed
  Use the PinboardEmbed component to embed a full Liveboard with multiple visualizations, or a specific visualization on a Liveboard.

• AppEmbed
  Use the AppEmbed component to embed the full ThoughtSpot application with or without the navigation bar.

How to embed ThoughtSpot content

For information about embedding ThoughtSpot using Visual Embed SDK, see the Visual Embed SDK.