THIS IS ARCHIVED DOCUMENTATION

ConfigurationActions (Search Engine) (Deprecated)

The configuration action creators.

Loader Function

loadConfigurationActions

Loads the configuration reducer and returns possible action creators.

Parameters

  • engine: CoreEngine

    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 (for example, 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 (for example, https://connect.coveo.com/s/).

UpdateAnalyticsConfigurationActionCreatorPayload

Properties

  • anonymous?: boolean

    Whether analytics events should be logged anonymously. If set to true, the Usage Analytics Write API will not extract the name and userDisplayName, if present, from the search token

  • apiBaseUrl?: string

    The Usage Analytics API base URL to use (for example, https://platform.cloud.coveo.com/rest/ua).

  • enabled?: boolean

    Whether to enable usage analytics tracking.

  • originLevel2?: string

    The origin level 2 usage analytics event metadata whose value should typically be the identifier of the tab from which the usage analytics event originates (for example, All).

  • 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 that’s making the request (for example, https://connect.coveo.com/s/).

  • runtimeEnvironment?: IRuntimeEnvironment

    The Coveo analytics runtime to use, see https://github.com/coveo/coveo.analytics.js for more info.

UpdateBasicConfigurationActionCreatorPayload

Properties

  • accessToken?: string

    The access token to use to authenticate requests against Coveo 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 organization.

  • organizationId?: string

    The unique identifier of the target Coveo organization (for example, mycoveoorganizationg8tp8wu3)

  • platformUrl?: string

    The Plaform URL to use (for example, https://platform.cloud.coveo.com).