| Visual Embed SDK | Embed without SDK | Legacy embedding method | |
|---|---|---|---|
When to use | The SDK Supports all embed and customization use cases. Use the SDK for embedding ThoughtSpot if your host platform allows custom Javascript. | Use this method only if your host platform doesn’t allow custom Javascript. This method involves embedding a ThoughtSpot component in an iFrame. | The legacy embedding method is available for only ThoughtSpot Software deployments. With this method, you can embed a ThoughtSpot page, object, or the full application using |
Feature availability | ThoughtSpot Cloud ts7.may.cl or later | ThoughtSpot Cloud ts7.may.cl or later | ThoughtSpot Software version 6.0 or later ThoughtSpot recommends using Visual Embed SDK and ThoughtSpot Embedded features from 8.4.1-sw onwards. |
Required user privilege |
|
|
|
Maintenance and support | Available | Available | Limited support |
Embedding overview
ThoughtSpot Embedded analytics offers a robust API framework with Visual Embed SDK and REST APIs to embed and customize ThoughtSpot components and automate deployments. You can explore these APIs and preview the coding experience in the interactive developer playgrounds.
Supported embedding methods🔗
ThoughtSpot supports embedding Search bar, Search page, Liveboard, visualizations, and the full ThoughtSpot experience in a web application, product, or portal.
Based on your embedding requirements and integration setup, you can use one of the following embedding methods:
-
Embed using Visual Embed SDK (Recommended)
-
Legacy embedding method with app.min.js (ThoughtSpot Software only)
To determine the method that best fits your embedding requirement, refer to the information in the following tables.
Feature comparison🔗
The following table lists the features available with each embed flavor:
| Feature category | Features | Visual Embed SDK | Embedding without SDK | Legacy embedding method |
|---|---|---|---|---|
Embed options | Search | ✓ | – | – |
Visualization | ✓ | ✓ | ✓ | |
Liveboard - Classic experience | ✓ | ✓ | ✓ | |
Liveboard - New experience | ✓ | ✓ | – | |
Full ThoughtSpot experience | ✓ | ✓ | ✓ | |
Authentication | SAML | ✓ | ✓ Inline authentication. For more information, see Embed without SDK. | ✓ |
OIDC | ✓ | – | – | |
Trusted authentication | ✓ | ✓ | ✓ | |
Basic authentication | ✓ | ✓ | ✓ | |
Auto-login on authentication expiry | ✓ | – | – | |
Custom Actions | URL actions | ✓ | ✓ | ✓ Available in only ThoughtSpot Software 7.0 or earlier versions |
Callback actions | ✓ | – | – | |
Granular control of embedded UI | Customization flags such as hiding data sources, search options configuration, setting a Liveboard to full height, and so on | ✓ | – | – |
Show or hide UI menu actions | ✓ | – | – | |
Style customization and rebranding of UI elements | ✓ | ✓ | ✓ | |
Link customization | ✓ | ✓ | ✓ | |
Events | Ability to trigger and handle embed lifecycle and host app events Interaction between host and embedded ThoughtSpot app | ✓ | – | – Legacy events only |
Runtime filters | Ability to pass filters as URL query parameters | ✓ | ✓ | ✓ |
React components | Ability to embed ThoughtSpot components in a React app | ✓ | – | – |
Embed using REST APIs🔗
ThoughtSpot REST API framework supports data APIs, using which you can embed an answer, Liveboard, or a specific visualization from a Liveboard. You can use these APIs with or without the SDK to embed ThoughtSpot content in your app.
For more information, see the following pages: