ConfigurationActions (Recommendation Engine)
ConfigurationActions (Recommendation Engine)
The configuration action creators.
See Dispatch Actions.
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
-
payload:
SetOriginLevel2ActionCreatorPayload
The action creator payload.
Returns PayloadAction<SetOriginLevel2ActionCreatorPayload>
: A dispatchable action.
setOriginLevel3
Sets originLevel3 for analytics tracking.
Parameters
-
payload:
SetOriginLevel3ActionCreatorPayload
The action creator payload.
Returns PayloadAction<SetOriginLevel3ActionCreatorPayload>
: A dispatchable action.
updateAnalyticsConfiguration
Updates the analytics configuration.
Parameters
-
payload:
UpdateAnalyticsConfigurationActionCreatorPayload
The action creator payload.
Returns PayloadAction<UpdateAnalyticsConfigurationActionCreatorPayload>
: A dispatchable action.
updateBasicConfiguration
Updates the global headless engine configuration.
Parameters
-
payload:
UpdateBasicConfigurationActionCreatorPayload
The action creator payload.
Returns PayloadAction<UpdateBasicConfigurationActionCreatorPayload>
: A dispatchable action.
Related Types
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
-
analyticsMode?:
'legacy' | 'next'
-
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
). -
deviceId?:
string
The name of the device that the end user is using. It should be explicitly configured in the context of a native mobile app.
-
documentLocation?:
string
Specifies the URL of the current page or component.
-
enabled?:
boolean
Whether to enable usage analytics tracking.
-
nextApiBaseUrl?:
string
The Usage Analytics API base URL to use (for example,
https://platform.cloud.coveo.com/rest/organizations/${organizationId}/events/v1
). -
originContext?:
string
Sets the Origin Context dimension on the analytic events.
You can use this dimension to specify the context of your application. Suggested values are "Search", "InternalSearch" and "CommunitySearch"
-
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.
-
trackingId?:
string
TBD
-
userDisplayName?:
string
Specifies the user display name for the usage analytics logs.
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.
-
organizationId?:
string
The unique identifier of the target Coveo Cloud organization (for example,
mycoveocloudorganizationg8tp8wu3
) -
platformUrl?:
string
The Platform URL to use (for example,
https://platform.cloud.coveo.com
).