QueryBasedWidgetInteractionTypeInfo is a union datatype based for query based widget interaction. Use DashboardLinkInteraction, or CustomLinkInteraction, or SearchLinkInteraction, or UpdateParametersInteraction and its parameters. Below are the tables for each datatype:

Table: DashboardLinkInteraction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 24, 2024
arguments[DictionaryEntryType]yes Long-TermThe dictionary entry arguments for the dashboard link. See DictionaryEntryType.
dashboardReferenceDashboardLinkInteractionDashboardReferenceyes Long-TermThe dashboard link for an interaction. See DashboardLinkInteractionDashboardReference.
openInNewTabbooleanyes Long-TermWhether to open in a new tab.
useWidgetTimeWindowbooleanyes Long-TermWhether to use the TimeWindow widget.

Table: CustomLinkInteraction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 24, 2024
openInNewTabbooleanyes Long-TermWhether to open custom link in a new tab.
urlEncodeArgsbooleanyes Long-TermWhether to encode arguments from the URL.
urlTemplatestringyes Long-TermThe URL template to use.

Table: SearchLinkInteraction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: May 27, 2025
arguments[DictionaryEntryType]yes Long-TermThe arguments of the search link interaction. See DictionaryEntryType.
openInNewTabbooleanyes Long-TermWhether to open the interaction in a new tab.
queryStringstringyes Long-TermThe query string.
repoOrViewNameRepoOrViewName  Long-TermThe name of the repository or view. RepoOrViewName is a scalar.
useWidgetTimeWindowbooleanyes Long-TermWhether to use a time window widget.

Table: UpdateParametersInteraction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 7, 2024
arguments[DictionaryEntryType]yes Long-TermThe arguments to update for the interaction. See DictionaryEntryType.
useWidgetTimeWindowbooleanyes Long-TermWhether to use a Time Window widget.