Interface SearchAnalyticsActionCreators

The search analytics action creators.

interface SearchAnalyticsActionCreators {
    logCategoryFacetBreadcrumb(payload: LogCategoryFacetBreadcrumbActionCreatorPayload): LegacySearchAction;
    logClearBreadcrumbs(): LegacySearchAction;
    logCloseSmartSnippetFeedbackModal(): CustomAction;
    logCollapseSmartSnippet(): CustomAction;
    logCollapseSmartSnippetSuggestion(payload: QuestionAnsweringUniqueIdentifierActionCreatorPayload): CustomAction;
    logDateFacetBreadcrumb(payload: LogDateFacetBreadcrumbActionCreatorPayload): LegacySearchAction;
    logDidYouMeanClick(): LegacySearchAction;
    logDislikeSmartSnippet(): CustomAction;
    logExpandSmartSnippet(): CustomAction;
    logExpandSmartSnippetSuggestion(payload: QuestionAnsweringUniqueIdentifierActionCreatorPayload): CustomAction;
    logFacetBreadcrumb(payload: LogFacetBreadcrumbActionCreatorPayload): LegacySearchAction;
    logFacetClearAll(facetId: string): LegacySearchAction;
    logFacetDeselect(payload: LogFacetDeselectActionCreatorPayload): LegacySearchAction;
    logFacetExclude(payload: LogFacetSelectActionCreatorPayload): LegacySearchAction;
    logFacetSelect(payload: LogFacetSelectActionCreatorPayload): LegacySearchAction;
    logFacetShowLess(facetId: string): LegacySearchAction;
    logFacetShowMore(facetId: string): LegacySearchAction;
    logFacetUnexclude(payload: LogFacetDeselectActionCreatorPayload): LegacySearchAction;
    logFacetUpdateSort(payload: LogFacetUpdateSortActionCreatorPayload): LegacySearchAction;
    logInterfaceChange(): LegacySearchAction;
    logInterfaceLoad(): LegacySearchAction;
    logLikeSmartSnippet(): CustomAction;
    logNavigateBackward(): LegacySearchAction;
    logNavigateForward(): LegacySearchAction;
    logNoResultsBack(): LegacySearchAction;
    logNotifyTrigger(): LegacySearchAction;
    logNumericFacetBreadcrumb(payload: LogNumericFacetBreadcrumbActionCreatorPayload): LegacySearchAction;
    logOmniboxFromLink(metadata: OmniboxSuggestionsMetadata): LegacySearchAction;
    logOpenSmartSnippetFeedbackModal(): CustomAction;
    logPageNext(): LegacySearchAction;
    logPageNumber(): LegacySearchAction;
    logPagePrevious(): LegacySearchAction;
    logPagerResize(): LegacySearchAction;
    logQuerySuggestionClick(payload: LogQuerySuggestionClickActionCreatorPayload): LegacySearchAction;
    logResultsSort(): LegacySearchAction;
    logSearchboxSubmit(): LegacySearchAction;
    logSearchFromLink(): LegacySearchAction;
    logSmartSnippetDetailedFeedback(details: string): CustomAction;
    logSmartSnippetFeedback(feedback: SmartSnippetFeedback): CustomAction;
    logStaticFilterClearAll(payload: LogStaticFilterClearAllActionCreatorPayload): LegacySearchAction;
    logStaticFilterDeselect(payload: LogStaticFilterToggleValueActionCreatorPayload): LegacySearchAction;
    logStaticFilterSelect(payload: LogStaticFilterToggleValueActionCreatorPayload): LegacySearchAction;
    logTriggerExecute(): LegacySearchAction;
    logTriggerQuery(): LegacySearchAction;
    logTriggerRedirect(): LegacySearchAction;
    logUndoTriggerQuery(payload: LogUndoTriggerQueryActionCreatorPayload): LegacySearchAction;
}

Methods

  • The event to log when a search interface loads for the first time, for a user who selected a query suggestion from a standalone search box.

    Parameters

    • metadata: OmniboxSuggestionsMetadata

      The metadata of the clicked query suggestion that triggered the redirect.

    Returns LegacySearchAction

    A dispatchable action.

  • The event to log when a user provides detailed feedback about why the smart snippet answer wasn't relevant.

    Parameters

    • details: string

      A personalized message from the end user about the relevance of the answer.

    Returns CustomAction

    A dispatchable action.