Visual Embed SDK

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, the Search bar, Search page, Liveboards, and visualizations.

  • Render the entire ThoughtSpot app 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.

Visual Embed SDK APIs

The Visual Embed SDK includes the following packages and JavaScript libraries:

SearchBarEmbed

Use SearchBarEmbed to embed the ThoughtSpot Search bar and get search results as raw data.

SearchEmbed

Use SearchEmbed to embed the ThoughtSpot Search functionality and retrieve search data from a data source or saved Answer.

LiveboardEmbed

Use LiveboardEmbed to embed a full Liveboard with multiple visualizations, or a specific visualization on a Liveboard.

AppEmbed

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

How to embed ThoughtSpot content

For information about how to embed ThoughtSpot in your app, see Visual Embed SDK.