| Visual Embed SDK | Embed without SDK | |
|---|---|---|
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. |
Feature availability | ThoughtSpot Cloud ts7.may.cl or later | ThoughtSpot Cloud ts7.may.cl or later |
Required user privilege |
|
|
Maintenance and support | Available | Available |
Embedding overview
Table of Contents
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)
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 |
|---|---|---|---|
Embed options | Search | ✓ | – |
Visualization | ✓ | ✓ | |
Liveboard | ✓ | ✓ | |
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 | ✓ | ✓ |
Callback actions | ✓ | – | |
Granular control of embedded UI | Customization flags such as hiding data sources, search options configuration, setting a Liveboard to full height, and more | ✓ | – |
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 | ✓ | – |
Runtime filters | Ability to pass filters as URL query parameters | ✓ | ✓ |
React components | Ability to embed ThoughtSpot components in a React app | ✓ | – |