Action IDs in the SDK

Action IDs in the SDK

ThoughtSpot application components such as Liveboards, Answers, visualizations, Search and Spotter interface, and application pages support several actions and menu commands for user-initiated operations. To allow developers to customize the menu options and feature availability for their embedded application users, Visual Embed SDK provides action IDs for the actions in the ThoughtSpot application interface. Developers can use these action IDs in the visibleActions, disabledActions, or hiddenActions arrays to show, disable, or hide specific actions in the embedded view.

The availability of these actions may vary based on user privileges and the SDK library used for embedding. For information about the action IDs available for embed components, browse through the lists in the following sections.

Liveboard🔗

The actions associated with the Liveboards are available in the Liveboard header and the More options menu the more options menu. These actions are also available on the Liveboards page in full application embed.

Action string in SDKRequired SDK libraryAction label in the UI

Action.AddToFavorites

LiveboardEmbed
AppEmbed

The Favorites (star) icon on a Liveboard page.
Allows adding a Liveboard to the user’s favorites list.

Action.AIHighlights

LiveboardEmbed
AppEmbed

The AI highlights button on a Liveboard page.
Displays quick insights on how top metrics changed in your Liveboard.
To enable AI Highlights, ensure that the KPI anomaly detection feature is enabled on your instance.

Action.Share

LiveboardEmbed
AppEmbed

Share
Allows sharing a Liveboard with another user or group.

Action.Edit

LiveboardEmbed
AppEmbed

Edit
Allows editing the contents of a Liveboard. Available only if you have edit privileges to the object.

Action.RequestAccess

LiveboardEmbed
AppEmbed

The Request access action for view-only Liveboards. Allows sending a request to the Liveboard owner to obtain edit permissions.

Action.AddFilter

LiveboardEmbed
AppEmbed

Add filters
Adds filters to visualizations on a Liveboard.

Action.ConfigureFilter

LiveboardEmbed
AppEmbed

The filter configuration options in the Add Filters modal.
Applies filters and allows configuring filters applied to a visualization on a Liveboard.

Action.AddParameter

SearchBarEmbed
AppEmbed

The Add Parameters option in the top panel of the Liveboard
Allows adding parameters to a Liveboard.

Action.AddTab

LiveboardEmbed
AppEmbed

The Add Tab action on a Liveboard.
Allows adding a new tab to a Liveboard view.

Action.ChangeFilterVisibilityInTab

LiveboardEmbed
AppEmbed

Action ID to disable or hide the filter visibility on Liveboard tabs. Applicable if the filter visibility on tabs feature is enabled on your instance.
See also, hideIrrelevantChipsInLiveboardTabs.

Action.DisableChipReorder

LiveboardEmbed
SearchEmbed AppEmbed

Action ID for disabling filter chip reordering on a Liveboard.

Action.Save

LiveboardEmbed
AppEmbed

Save
Saves Liveboard modifications.

Action.MakeACopy

LiveboardEmbed
AppEmbed

Make a copy
Creates a copy of the Liveboard.

Action.DownloadAsPdf

LiveboardEmbed
AppEmbed

Download as PDF
Downloads the Liveboard as a PDF file.

Action.Present

LiveboardEmbed
AppEmbed

Present
Presents a fullscreen Liveboard in the slideshow mode.

Action.Schedule Action.Subscription

LiveboardEmbed
AppEmbed

Schedule
Allows scheduling Liveboard notifications.

Action.SchedulesList

LiveboardEmbed
AppEmbed

Manage schedules
Allows you to manage scheduled Liveboard jobs. Saves Liveboard modifications.

Action.LiveboardInfo

LiveboardEmbed
AppEmbed

Show Liveboard details
Displays information about the Liveboard.

Action.RenameModalTitleDescription

LiveboardEmbed
AppEmbed

The Rename menu action on Liveboards. Allows editing the name of the Liveboard.

Action.RequestVerification

LiveboardEmbed
AppEmbed

The Request verification menu action on Liveboards. Initiates a request for Liveboard verification.

Action.VerifiedLiveboard

LiveboardEmbed
AppEmbed

The Liveboard verified banner text.
Indicates the Liveboard is verified. See also, showLiveboardVerifiedBadge.

Action.PersonalisedViewsDropdown

LiveboardEmbed
AppEmbed

The Liveboard personalized views drop-down.
Available if personalized views are saved on the Liveboard. Allows switching between the saved personalized views of a Liveboard.

Action.MarkAsVerified

LiveboardEmbed
AppEmbed

The Approve action visible to Liveboard verifiers.
Marks the Liveboard as approved.

Action.SyncToSlack

LiveboardEmbed
AppEmbed

The Sync to Slack action on Liveboard visualizations. Allows sending data to third-party apps Slack.

Action.SyncToTeams

LiveboardEmbed
AppEmbed

The Sync to Teams action on Liveboard visualizations. Allows sending data to third-party apps Team.

Action.TML

LiveboardEmbed
AppEmbed

Action ID for the Parent TML action The parent action TML must be included to access TML-related options within the cascading menu.

Action.ExportTML

AppEmbed
LiveboardEmbed

Export TML
Exports the TML representation of a Liveboard object from ThoughtSpot. The parent action TML must be included to access TML-related options within the cascading menu.

Action.UpdateTML

LiveboardEmbed
AppEmbed

Update Liveboard
Allows importing the TML representation of a Liveboard object to ThoughtSpot. The parent action TML must be included to access TML-related options within the cascading menu.

Action.EditTML

LiveboardEmbed
AppEmbed

Edit TML
Allows editing the ThoughtSpot Modelling Language (TML) representation of a Liveboard object loaded on the ThoughtSpot server. The parent action TML must be included to access TML-related options within the cascading menu.

Visualizations on a Liveboard🔗

The visualizations pinned to a Liveboard have the following types of actions:

  • More menu the more options menu actions

  • Contextual menu actions

  • Actions for editing chart and table properties in a visualization. For more information on these actions, see Answers.

More (…​) options menu🔗

The following actions are available for ThoughtSpot visualizations More menu the more options menu:

Action string in SDKRequired SDK libraryAction label in the UI

Action.AskAi

LiveboardEmbed
AppEmbed

The Spotter button on a visualization. Available if Spotter is enabled on your instance. Allow users to initiate a conversation with Spotter.

Action.Explore

LiveboardEmbed
AppEmbed

Explore
Allows users to explore a visualization.

Action.CreateMonitor

LiveboardEmbed
AppEmbed

Alert icon
Allows you to schedule threshold-based alerts for KPI charts.

Action.Pin

LiveboardEmbed
AppEmbed

Pin
Pins a visualization to a Liveboard.

Action.Download

LiveboardEmbed
AppEmbed

Download
The Download menu action to download a visualization as a CSV, PNG, PDF, or XLSX file.
If you are using Visual Embed SDK version 1.21.0 or later, note the following behavior:

  • To disable or hide download actions, you can use Action.Download in the disabledActions and hiddenActions arrays respectively.

  • If using visibleActions to show or hide actions on a visualization or Answer, include the following action enumerations along with Action.Download in the array:

    • Action.DownloadAsCsv

    • Action.DownloadAsXlsx

    • Action.DownloadAsPng

Action.DownloadAsCsv

LiveboardEmbed
AppEmbed

Download > CSV
Downloads the answer data in the CSV file format.

Action.DownloadAsXLSX

LiveboardEmbed
AppEmbed

Download > XLSX
Downloads the answer data in the XLSX file.

Action.DownloadAsPng

LiveboardEmbed
AppEmbed

Download > PNG
Downloads the chart as a PNG file. Available only for charts.

Action.CopyLink

LiveboardEmbed
AppEmbed

Copy link
Displays a link that you can copy and use for embedding a visualization object.

Action.ToggleSize

LiveboardEmbed
AppEmbed

The Resize icons in the More actions menu.
Allows resizing a visualization on a Liveboard.

Action.SyncToSheets

LiveboardEmbed
AppEmbed

The Sync to sheets action in the More actions menu.
Allows creating a sync to send data to the Google Sheets app.

Action.SyncToOtherApps

LiveboardEmbed
AppEmbed

The Sync to other apps action in the More actions menu.
Allows creating a sync to send data to external business apps such as Slack, Salesforce, and Microsoft Teams.

Action.ManagePipelines

LiveboardEmbed
AppEmbed

The Manage pipelines action in the More actions menu.
Allows managing data sync pipelines to external business apps set as sync destinations in ThoughtSpot.

Action.AnswerDelete

LiveboardEmbed
AppEmbed

Delete
Deletes the visualization from the Liveboard.

Contextual menu🔗

The following actions are available in the contextual menu of visualizations on a Liveboard. These actions are visible when a user right-clicks on a chart or table.

Action string in SDKRequired SDK libraryAction label in the UI

Action.CrossFilter

LiveboardEmbed
AppEmbed

Filter action in the contextual menu on a visualization.
Applies filters across visualizations for brushing and linking data on a Liveboard.

Action.RemoveCrossFilter

LiveboardEmbed
AppEmbed

Remove filter option contextual menu on a visualization.
Removes the cross-filters applied on a visualization.

Action.DrillDown

LiveboardEmbed
AppEmbed

Drill down
Allows drilling down on a data point in the visualization to get granular details.

Action.AnswerChartSwitcher

LiveboardEmbed
AppEmbed

Chart switching toggle
Allows switching to the table or chart mode when editing a visualization.

Action.EditTitle

LiveboardEmbed
AppEmbed

The visualization title edit icon.
Updates the title of the visualization.

Action.MoveToTab

LiveboardEmbed
AppEmbed

The Move to tab action on a Liveboard in the edit mode. Allows moving a visualization to a different tab.

Action.SpotIQAnalyze

LiveboardEmbed
AppEmbed

SpotIQ analyze
Allows you to run SpotIQ analyses.

Action.ShowUnderlyingData

LiveboardEmbed
AppEmbed

Show underlying data
Displays detailed information and raw data for a given visualization.

Spotter🔗

The following action IDs are available for the Spotter component:

Action string in SDKRequired SDK libraryAction label in the UI

Action.PreviewDataSpotter

ConversationEmbed
AppEmbed

Preview data action on the Spotter conversation panel. Shows the underlying data used for Spotter queries.

Action.ResetSpotterChat

ConversationEmbed
AppEmbed

Preview data action on the Spotter conversation panel. Shows the underlying data used for Spotter queries.

Action.EditPreviousPrompt

ConversationEmbed
AppEmbed

The edit icon on the Spotter prompt panel. Allows editing the prompt sent to Spotter.

Action.DeletePreviousPrompt

ConversationEmbed
AppEmbed

The delete icon on the Spotter prompt panel. Allows deleting the prompt sent to Spotter.

Action.SpotterFeedback

ConversationEmbed
AppEmbed

The Spotter feedback widget in the generated Answer. Allows sending feedback about the response received from Spotter.

For information about the action IDs available for Answers generated from Spotter (ConversationEmbed), see Answers.

Answers🔗

The following actions are available on saved Answers and the Answers generated by passing a Natural Language Search query, search tokens on the Search Data page, or from a conversation with Spotter.

Action string in SDKRequired SDK libraryAction label in the UI

Action.ChooseDataSources

ConversationEmbed
SageEmbed
SearchEmbed
SearchBarEmbed
AppEmbed

The Choose sources option in the Search page and Spotter conversation panel.
Allows selecting data sources to query data.

Action.AddFormula

ConversationEmbed
SageEmbed
SearchEmbed
SearchBarEmbed
AppEmbed

Create formula option on the data panel of an Answer page
Allows adding formulas to a search query.

Action.AddParameter

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Add Parameters option in the data panel on a Search page
Allows adding parameters to an Answer.

Action.AnswerChartSwitcher

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Chart toggle icon
Allows switching to the table or chart mode.

Action.Edit

ConversationEmbed
AppEmbed

Edit action on charts and tables generated from a Spotter query. Opens a table or chart in the edit mode.

Action.Pin

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Pin action on the visualization generated from a Spotter query. Allows adding a visualization generated from Spotter to a Liveboard.

Action.Save

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Save action on the visualization generated from a Spotter query Saves the visualization generated from Spotter.

Action.SageAnswerFeedback

SageEmbed
AppEmbed

The feedback widget on the Answers generated from a Natural Language Search query.
Allows sending feedback about the AI-generated Answer.

Action.EditSageAnswer

SageEmbed
AppEmbed

Edit action for AI-generated Answer.

Action.ModifySageAnswer

SageEmbed
AppEmbed

The Fix the Answer option that appears after a user submits negative feedback on the Answer generated from a Natural Language Search query.
Allows users to fix the Answer in the Search Data page to provide feedback.

Action.SpotIQAnalyze

SearchEmbed
AppEmbed

SpotIQ analyze
Allows generating SpotIQ analyses. Available as a primary button and contextual menu action.

Action.Share

SearchEmbed
SageEmbed
AppEmbed

Share
Allows you to share an Answer with another user or group.

Action.QueryDetailsButtons

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

The Query visualizer and Query SQL buttons in Query details on the Answer page

  • The Query visualizer button displays the tables and filters used in a search query.

  • The Query SQL button displays the SQL statements used in a search query to fetch data.

Action.Download

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Download
The Download action to download the Answer data

If you are using Visual Embed SDK version 1.21.0 or later to embed Liveboard, Search, or full app experience, note the following behavior:

  • To disable or hide download actions, you can use Action.Download in the disabledActions and hiddenActions arrays respectively.

  • If you are using the visibleActions array to show or hide actions on a visualization or Answer, include the following action enumerations along with Action.Download in the array:

    • Action.DownloadAsCsv

    • Action.DownloadAsPdf

    • Action.DownloadAsXlsx

    • Action.DownloadAsPng

Action.DownloadAsCsv

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Download > CSV
Downloads the answer data in the CSV file format.

Action.DownloadAsXLSX

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Download > XLSX
Downloads the answer data in the XLSX file format.

Action.DownloadAsPdf

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Download > PDF
Downloads the answer data as a PDF file. Available only for tables.

Action.DownloadAsPng

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Download > PNG
Downloads the chart as a PNG file. Available only for charts.

Action.ShowUnderlyingData

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Show underlying data
Displays detailed information and raw data for a given visualization. Available as a menu action in the More menu the more options menu and the contextual menu.

Action.AnswerDelete

AppEmbed

Delete
Deletes the answer.

Action.SyncToSheets

SageEmbed
SearchEmbed
AppEmbed

The Sync to sheets action in the More actions menu.
Allows creating a sync to send data to the Google Sheets app.

Action.SyncToOtherApps

SageEmbed
SearchEmbed
AppEmbed

The Sync to other apps action in the More actions menu.
Allows creating a sync to send data to external business apps such as Slack, Salesforce, and Microsoft Teams.

Action.ManagePipelines

SageEmbed
SearchEmbed
AppEmbed

The Manage pipelines action in the More actions menu.
Allows managing data sync pipelines to external business apps set as sync destinations in ThoughtSpot.

Action.ExportTML

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Export TML
Exports the TML representation of an answer from ThoughtSpot.

Action.EditTML

AppEmbed

Edit TML
Allows editing the TML representation of the answer object. This action is available on the saved answers page.

Action.ImportTML

AppEmbed

Import TML
Allows importing the TML representation of an answer into ThoughtSpot. This action is available on the saved answers page.

Action.UpdateTML

AppEmbed

Update TML
Publishes the modified TML representation of an answer.

Contextual menu🔗

The following actions are available in the contextual menu of an Answer:

Action string in SDKRequired SDK libraryAction label in the UI

Action.DrillExclude

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Exclude
Allows you to exclude a specific data point when drilling down on an Answer.

Action.DrillInclude

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Include
Allows you to include a specific data point during drill down on an Answer.

Action.DrillDown

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Drill down
Allows you to drill down the data for additional details and granular information. Available as a contextual menu action.

Action.CopyToClipboard

ConversationEmbed
SageEmbed
SearchEmbed
AppEmbed

Copy to clipboard
Copies the selected data point. Available as a contextual menu action for table data.

Axis and column customization menu🔗

The SDK provides the following Action enumerations for the contextual menu actions available in the X and Y axis of a chart and column headers of a table on the Answer page.

Action string in SDKRequired SDK libraryAction label in the UI

Action.AxisMenuAggregate

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Aggregate option in the chart axis or the table column customization menu. Provides aggregation options to analyze the data on a chart or table.

Action.AxisMenuConditionalFormat

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Conditional formatting menu option
Allows adding rules for conditional formatting of data points on a chart or table.

Action.AxisMenuEdit

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Edit action in the axis customization menu.
Allows editing the axis name, position, minimum and maximum values and format a column.

Action.AxisMenuFilter

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Filter action in the chart axis or table column customization menu.
Allows adding, editing, or removing filters.

Action.AxisMenuGroup

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Group option in the chart axis or table column customization menu.
Allows grouping data points if the axes use the same unit of measurement and a similar scale.

Action.AxisMenuNumberFormat

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Number format option to customize the format of the data labels on a chart or table.

Action.AxisMenuPosition

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Position option in axis customization menu.
Allows changing the position of the axis to the left or right side of the chart.

Action.AxisMenuRemove

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Remove in the chart axis or table column customization menu.
Removes the data labels from a chart or the column of a table visualization.

Action.AxisMenuRename

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Rename option in the chart axis or table column customization menu.
Renames axis label on a chart or the column header on a table

Action.AxisMenuSort

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Sort option to sort the data in the ascending or descending order on a chart or table.

Action.AxisMenuTextWrapping

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Text wrapping option on a table visualization.
Wraps or clips column text on a table.

Action.AxisMenuTimeBucket

SageEmbed
AppEmbed
SearchEmbed
LiveboardEmbed

Time bucket option in the chart axis or table column customization menu.
Allows defining time metric for date comparison.

Full app embed🔗

Liveboards page🔗

The following actions are available on the Liveboards page in the full app embedded view:

Action string in SDKRequired SDK libraryAction label in the UI

Action.Share

AppEmbed

Share
Allows sharing a Liveboard with another user or group.

Action.Remove

AppEmbed

Delete
Allows deleting a Liveboard.

Action.CreateLiveboard

AppEmbed

The Create Liveboard action on the Liveboards page. Allows users to create a Liveboard.

Action.ManageTags

AppEmbed

The Manage Tags action on the Liveboards page.

Action.ExportTML

AppEmbed

Export TML
Exports the TML representation of a Liveboard object from ThoughtSpot.

Search page🔗

The following actions are available on the Search page in the full app embedded view:

Action string in SDKRequired SDK libraryAction label in the UI

Action.AddDataPanelObjects

AppEmbed

The Add Data Panel Objects action on the data panel v2. Allows to show action menu to add different objects (such as formulas, Parameters) in data panel new experience.

Action.CollapseDataPanel

AppEmbed

The Collapse data panel icon on the Search page. Collapses the data panel view.

Action.AddFormula

AppEmbed

The Add Formula action allows adding formulas to an Answer.

Action.AddParameter

AppEmbed

The Add Parameter action allows adding Parameters to an Answer.

Action.AddColumnSet

AppEmbed

The Add Column Set action allows adding column sets to an Answer.

Action.AddQuerySet

AppEmbed

The Add Query Set action allows adding query sets to an Answer.

Answers page🔗

The following actions are available on the Answers page in the full app embedded view:

Action string in SDKRequired SDK libraryAction label in the UI

Action.Share

AppEmbed

Share
Allows sharing a saved Answer with another user or group.

Action.Remove

AppEmbed

Delete
Allows deleting an Answer.

Action.ManageTags

AppEmbed

The Manage Tags action on the Liveboards

Data Workspace page🔗

The following actions are available on the Data page in the full app embedded view.

Action string in SDKRequired SDK libraryAction label in the UI

Action.Share

AppEmbed

Share action on the Data > Home page.
Allows sharing a Worksheet, Table, or View with another user or group.

Action.Remove

AppEmbed

Delete action on the Data > Home and Data > Connections pages
Allows deleting a Worksheet, Table, or View.

Action.ExportTML

AppEmbed

Export TML action on the Data > Home page
Allows exporting a Worksheet, Table, or View as a TML file.

Action.EditTML

AppEmbed

Edit TML action on the Data > Home page
Opens the TML Editor that allows you to modify the TML file of Worksheet, Table, or View.

Action.ImportTML

AppEmbed

The Import TML menu action imports the TML representation of ThoughtSpot objects.

Home (New Homepage experience)🔗

The following actions are available on the Home page in the full app embedded view.

Action string in SDKRequired SDK libraryAction label in the UI

Action.AddToWatchlist

AppEmbed

The Add KPI to Watchlist action on Home page watchlist.
Adds a KPI chart to the watchlist on the Home page.

Action.RemoveFromWatchlist

AppEmbed

The Remove from watchlist menu action on KPI watchlist. Removes a KPI chart from the watchlist on the Home page.

Action.OrganiseFavourites

AppEmbed

The Organize Favourites action on Homepage Favorites module.

Action.CopyLink

AppEmbed

Copy link
Allows users to copy a link from the Watchlist on the Homepage.

Action.DeleteScheduleHomepage

AppEmbed

The Delete action on the Liveboard Schedules page.
Deletes a Liveboard schedule.

Action.PauseScheduleHomepage

AppEmbed

The Pause action on the Liveboard Schedules page.
Pauses a scheduled Liveboard job.

Action.UnsubscribeScheduleHomepage

AppEmbed

Unsubscribe option for the alerts on the Monitor Subscriptions page.
Unsubscribes from alerts.

Action.ViewScheduleRunHomepage

AppEmbed

The View run history action Liveboard Schedules page. Allows viewing schedule run history.

Action.Share

AppEmbed

Share option for objects in the library
Allows sharing an object with another user.