GenericAnalyticsActions

The generic analytics action creators.

Loader Function

loadGenericAnalyticsActions

Returns possible generic analytics action creators.

Parameters

  • engine: SearchEngine

    The headless engine.

Returns GenericAnalyticsActionCreators: The generic analytics action creators.

GenericAnalyticsActionCreators

logClickEvent

Creates a click analytics event.

Parameters

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

logCustomEvent

Creates a custom analytics event.

Parameters

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

logSearchEvent

Creates a search analytics event.

Parameters

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

LogCustomEventActionCreatorPayload

Properties

  • evt: string

    The event cause identifier of the custom action

  • type: string

    The event type identifier of the custom action

  • meta?: Record<string, unknown>

    The event metadata.

LogSearchEventActionCreatorPayload

Properties

  • evt: string

    The identifier of the search action (e.g., interfaceLoad).

  • meta?: Record<string, unknown>

    The event metadata.

What's Next for Me?