Visual Embed SDK

Initialize the SDK and authenticate users. Call init with an EmbedConfig object before you embed any ThoughtSpot component. This category also includes the enumerations for the authentication type, status, and log level, and the event emitter that init returns.

Embed the full ThoughtSpot application with AppEmbed and configure it with AppViewConfig. This category also includes the enumerations for the options of the full application: the pages to show, the versions of the home page, list page, and primary navigation bar, and the home page modules, left navigation items, and search bar modes.

Embed a Liveboard with LiveboardEmbed and configure it with LiveboardViewConfig. This category also includes the interfaces for the filters, Parameters, and data source overrides that you apply when a Liveboard loads.

Embed the ThoughtSpot Search page with SearchEmbed, or only the search bar with SearchBarEmbed, and configure them with SearchViewConfig and SearchBarViewConfig. This category also includes the options for the data source panel and the data panel on the Search page.

Classes and configuration types for embedding Spotter, the ThoughtSpot AI analytics experience. Use SpotterEmbed for the Spotter interface and SpotterAgentEmbed for chatbots and other conversational interfaces. This category also includes the interfaces for customizing the chat, the sidebar, conversation sharing, and starter prompts.

Types that all embed components use: the iframe settings (FrameParams), the element in which a component renders (DOMSelector), and the groups of ThoughtSpot APIs that you can intercept (InterceptedApiType).

Events and callbacks for communication between your app and an embedded component. Use EmbedEvent to listen to the events that the embedded application emits, HostEvent to trigger actions in the embedded application, and AnswerService to work with Answers. This category also includes the types that these events and AnswerService use.

Types for the data that you send to, or receive from, the embedded application: the payloads that trigger accepts for host events, and the request and response shapes of UI passthrough events. This category also includes the Liveboard filter, parameter, group, and tab types that these payloads use.

Action IDs and custom action types. Use the Action IDs to show, hide, or disable the menu actions of an embedded component, and CustomAction to add your own code-based actions. On the Action page, you can filter the actions by embed type.

Enumerations and an interface for customizing how charts and tables render in embedded visualizations, such as conditional formatting, data labels, legend position, and table theme and density.

Interfaces for customizing the look and feel of embedded ThoughtSpot content, such as CSS variables and custom CSS rules. Set them in the customizations property of EmbedConfig.

Filters and parameters that you apply to embedded content when it loads: the RuntimeFilter and RuntimeParameter interfaces, the RuntimeFilterOp operators that you use in runtime filters, and the types that set the level at which a filter or parameter applies.

Error codes, severity levels, and event types for handling the errors that embedded components emit.

Functions that you call directly, without an embed component: log out, prefetch static resources, reload the embedded frame, call ThoughtSpot APIs with an authenticated request (tokenizedFetch), get session and initialization information, import and export TML (executeTML and exportTML), create a Liveboard from Answers (createLiveboardWithAnswers), get an Answer from a natural language query (getAnswerFromQuery), convert a captured filter state (convertFilterChangedToUpdateFiltersPayload), and automatically render the ThoughtSpot MCP app frames on a page (startAutoMCPFrameRenderer). This category also includes the types that these functions use.