@coveo/headless-react
    Preparing search index...

    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;
    }
    Index

    Methods

    logCategoryFacetBreadcrumb logClearBreadcrumbs logCloseSmartSnippetFeedbackModal logCollapseSmartSnippet logCollapseSmartSnippetSuggestion logDateFacetBreadcrumb logDidYouMeanClick logDislikeSmartSnippet logExpandSmartSnippet logExpandSmartSnippetSuggestion logFacetBreadcrumb logFacetClearAll logFacetDeselect logFacetExclude logFacetSelect logFacetShowLess logFacetShowMore logFacetUnexclude logFacetUpdateSort logInterfaceChange logInterfaceLoad logLikeSmartSnippet logNavigateBackward logNavigateForward logNoResultsBack logNotifyTrigger logNumericFacetBreadcrumb logOmniboxFromLink logOpenSmartSnippetFeedbackModal logPageNext logPageNumber logPagePrevious logPagerResize logQuerySuggestionClick logResultsSort logSearchboxSubmit logSearchFromLink logSmartSnippetDetailedFeedback logSmartSnippetFeedback logStaticFilterClearAll logStaticFilterDeselect logStaticFilterSelect logTriggerExecute logTriggerQuery logTriggerRedirect logUndoTriggerQuery

    Methods

    • The event to log when clearing breadcrumbs.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a user no longer wishes to provide feedback about why the smart snippet answer wasn't relevant.

      Returns CustomAction

      A dispatchable action.

    • The event to log when a smart snippet is collapsed.

      Returns CustomAction

      A dispatchable action.

    • The event to log when a user triggers a search by clicking on a did-you-mean suggestion.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a user provides negative feedback for a given smart snippet answer.

      Returns CustomAction

      A dispatchable action.

    • The event to log when a smart snippet is expanded.

      Returns CustomAction

      A dispatchable action.

    • The event to log when a facet breadcrumb is deselected.

      Parameters

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when all selected values in a facet are deselected.

      Parameters

      • facetId: string

        The facet id.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a selected facet value is deselected.

      Parameters

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when an idle facet value is excluded.

      Parameters

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when an idle facet value is selected.

      Parameters

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when shrinking a facet to show fewer values.

      Parameters

      • facetId: string

        The facet id.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when expanding a facet to show more values.

      Parameters

      • facetId: string

        The facet id.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a selected facet value is unexcluded.

      Parameters

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when the facet sort criterion is changed.

      Parameters

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a tab is selected.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a search interface loads for the first time.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a user provides positive feedback for a given smart snippet answer.

      Returns CustomAction

      A dispatchable action.

    • The event to log when going to the previous state of the search interface.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when going to the next state of the search interface.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when no results is shown and the end users cancel last action.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a user action triggers a notification set in the effective query pipeline on the search page.

      Returns LegacySearchAction

      A dispatchable action.

    • 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 wishes to provide feedback about why the smart snippet answer wasn't relevant.

      Returns CustomAction

      A dispatchable action.

    • The event to log when navigating to the next page of results.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when selecting a page in the pager.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when navigating to the previous page of results.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when changing the number of results per page.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when the results sort criterion is changed.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when performing a search using a search box.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a search interface loads for the first time, for a user who performed a search using a standalone search box.

      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.

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

      Parameters

      Returns CustomAction

      A dispatchable action.

    • The event to log when a user action executes a JavaScript function set in the effective query pipeline on the search page.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a user action triggers a new query set in the effective query pipeline on the search page.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a user action redirects them to a URL set in the effective query pipeline on the search page.

      Returns LegacySearchAction

      A dispatchable action.

    • The event to log when a user undoes a query set in the effective query pipeline on the search page.

      Parameters

      Returns LegacySearchAction

      A dispatchable action.

    Settings

    Member Visibility

    On This Page

    Methods
    logCategoryFacetBreadcrumblogClearBreadcrumbslogCloseSmartSnippetFeedbackModallogCollapseSmartSnippetlogCollapseSmartSnippetSuggestionlogDateFacetBreadcrumblogDidYouMeanClicklogDislikeSmartSnippetlogExpandSmartSnippetlogExpandSmartSnippetSuggestionlogFacetBreadcrumblogFacetClearAlllogFacetDeselectlogFacetExcludelogFacetSelectlogFacetShowLesslogFacetShowMorelogFacetUnexcludelogFacetUpdateSortlogInterfaceChangelogInterfaceLoadlogLikeSmartSnippetlogNavigateBackwardlogNavigateForwardlogNoResultsBacklogNotifyTriggerlogNumericFacetBreadcrumblogOmniboxFromLinklogOpenSmartSnippetFeedbackModallogPageNextlogPageNumberlogPagePreviouslogPagerResizelogQuerySuggestionClicklogResultsSortlogSearchboxSubmitlogSearchFromLinklogSmartSnippetDetailedFeedbacklogSmartSnippetFeedbacklogStaticFilterClearAlllogStaticFilterDeselectlogStaticFilterSelectlogTriggerExecutelogTriggerQuerylogTriggerRedirectlogUndoTriggerQuery