THIS IS ARCHIVED DOCUMENTATION

SearchAnalyticsActions (Deprecated)

The search analytics action creators.

See Dispatch Actions.

Loader Function

loadSearchAnalyticsActions

Returns possible search analytics action creators.

Parameters

  • engine: SearchEngine

    The headless engine.

Returns SearchAnalyticsActionCreators: The search analytics action creators.

SearchAnalyticsActionCreators

logCategoryFacetBreadcrumb

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

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logClearBreadcrumbs

The event to log when clearing breadcrumbs.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logCloseSmartSnippetFeedbackModal

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logCollapseSmartSnippet

The event to log when a smart snipped is collapsed.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logCollapseSmartSnippetSuggestion

The event to log when a smart snippet suggestion, or related question, is collapsed.

Parameters

  • payload: QuestionAnsweringDocumentIdActionCreatorPayload | QuestionAnsweringUniqueIdentifierActionCreatorPayload

    The action creation payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logDateFacetBreadcrumb

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

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logDidYouMeanClick

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logDislikeSmartSnippet

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logExpandSmartSnippet

The event to log when a smart snipped is expanded.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logExpandSmartSnippetSuggestion

The event to log when a query suggestion is selected.

Parameters

  • payload: QuestionAnsweringDocumentIdActionCreatorPayload | QuestionAnsweringUniqueIdentifierActionCreatorPayload

    The action creator payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logFacetBreadcrumb

The event to log when a facet breadcrumb is deselected.

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logFacetClearAll

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

Parameters

  • facetId: string

    The facet id.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logFacetDeselect

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

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logFacetSelect

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

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logFacetShowLess

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

Parameters

  • facetId: string

    The facet id.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logFacetShowMore

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

Parameters

  • facetId: string

    The facet id.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logFacetUpdateSort

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

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logInterfaceChange

The event to log when a tab is selected.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logInterfaceLoad

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logLikeSmartSnippet

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logNavigateBackward

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logNavigateForward

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logNoResultsBack

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logNumericFacetBreadcrumb

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

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: 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: OmniboxSuggestionMetadata

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logOpenSmartSnippetFeedbackModal

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logPageNext

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logPageNumber

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logPagePrevious

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logPagerResize

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logQuerySuggestionClick

The event to log when a query suggestion is selected.

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logResultsSort

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logSearchboxSubmit

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

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: 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 AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logSmartSnippetDetailedFeedback

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 AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logSmartSnippetFeedback

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

Parameters

  • feedback: 'does_not_answer' | 'partially_answers' | 'was_not_a_question'

    The generic feedback that the end user wishes to send.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Custom; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logStaticFilterClearAll

The event to log when all selected values of a static filter are deselected.

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logStaticFilterDeselect

The event to log when a static filter value is deselected.

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

logStaticFilterSelect

The event to log when a static filter value is selected.

Parameters

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkAnalyticsOptions<StateNeededBySearchAnalyticsProvider>>: A dispatchable action.

DateFacetValue

Properties

  • end: string

    The ending value for the date range, formatted as YYYY/MM/DD@HH:mm:ss or the Relative date format "period-amount-unit"

  • endInclusive: boolean

    Whether or not the end value is included in the range.

  • numberOfResults: number

    The number of results that have the facet value.

  • start: string

    The starting value for the date range, formatted as YYYY/MM/DD@HH:mm:ss or the Relative date format "period-amount-unit"

  • state: 'idle' | 'selected'

    The state of the facet value, indicating whether it is filtering results (selected) or not (idle).

LogCategoryFacetBreadcrumbActionCreatorPayload

Properties

  • categoryFacetId: string

    The category facet id.

  • categoryFacetPath: string[]

    The category facet selected path.

LogDateFacetBreadcrumbActionCreatorPayload

Properties

  • facetId: string

    The facet id of the date facet corresponding to the breadcrumb.

  • selection: DateFacetValue

    The date facet value deselected using the breadcrumb.

LogFacetBreadcrumbActionCreatorPayload

Properties

  • facetId: string

    The facet id associated with the breadcrumb.

  • facetValue: string

    The facet value displayed in the breadcrumb.

LogFacetDeselectActionCreatorPayload

Properties

  • facetId: string

    The facet id.

  • facetValue: string

    The facet value that was deselected.

LogFacetSelectActionCreatorPayload

Properties

  • facetId: string

    The facet id.

  • facetValue: string

    The facet value that was selected.

LogFacetUpdateSortActionCreatorPayload

Properties

  • criterion: FacetSortCriterion | RangeFacetSortCriterion

    The updated sort criterion.

  • facetId: string

    The facet id.

LogNumericFacetBreadcrumbActionCreatorPayload

Properties

  • facetId: string

    The facet id of the numeric facet corresponding to the breadcrumb.

  • selection: NumericFacetValue

    The numeric facet value deselected using the breadcrumb.

LogQuerySuggestionClickActionCreatorPayload

Properties

  • id: string

    The search box id.

  • suggestion: string

    The selected query suggestion.

LogStaticFilterClearAllActionCreatorPayload

Properties

  • staticFilterId: string

    The static filter id.

LogStaticFilterToggleValueActionCreatorPayload

Properties

NumericFacetValue

Properties

  • end: number

    The ending value for the numeric range.

  • endInclusive: boolean

    Whether or not the end value is included in the range.

  • numberOfResults: number

    The number of results that have the facet value.

  • start: number

    The starting value for the numeric range.

  • state: 'idle' | 'selected'

    The state of the facet value, indicating whether it is filtering results (selected) or not (idle).

StaticFilterValueMetadata

Properties

  • caption: string

    The caption displayed to the user.

  • expression: string

    The query expression.