ConfigurationActions (Search Engine)

This is for:

Developer

The configuration action creators.

Loader Function

loadConfigurationActions

Loads the configuration reducer and returns possible action creators.

Parameters

  • engine: CoreEngine | CoreEngineNext

    The headless engine.

Returns ConfigurationActionCreators: The configuration action creators.

ConfigurationActionCreators

disableAnalytics

Disables analytics tracking.

Returns PayloadAction: A dispatchable action.

enableAnalytics

Enables analytics tracking.

Returns PayloadAction: A dispatchable action.

setOriginLevel2

Sets originLevel2 for analytics tracking.

Parameters

Returns PayloadAction<SetOriginLevel2ActionCreatorPayload>: A dispatchable action.

setOriginLevel3

Sets originLevel3 for analytics tracking.

Parameters

Returns PayloadAction<SetOriginLevel3ActionCreatorPayload>: A dispatchable action.

updateAnalyticsConfiguration

Updates the analytics configuration.

Parameters

Returns PayloadAction<UpdateAnalyticsConfigurationActionCreatorPayload>: A dispatchable action.

updateBasicConfiguration

Updates the global headless engine configuration.

Parameters

Returns PayloadAction<UpdateBasicConfigurationActionCreatorPayload>: A dispatchable action.

SetOriginLevel2ActionCreatorPayload

Properties

  • originLevel2: string

    The origin level 2 usage analytics event metadata whose value should typically be the identifier of the tab (e.g., All).

SetOriginLevel3ActionCreatorPayload

Properties

  • originLevel3: string

    The origin level 3 usage analytics event metadata whose value should typically be the URL of the page that linked to the search interface (e.g., https://connect.coveo.com/s/).

UpdateAnalyticsConfigurationActionCreatorPayload

Properties

UpdateBasicConfigurationActionCreatorPayload

Properties

  • accessToken?: string

    The access token to use to authenticate requests against the Coveo Cloud endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo Cloud organization.

  • environment?: PlatformCombination['env']

    The environment in which the organization is hosted.

    The dev and stg environments are only available internally for Coveo employees (e.g., Professional Services).

  • organizationId?: string

    The unique identifier of the target Coveo Cloud organization (e.g., mycoveocloudorganizationg8tp8wu3)