OptionalanalyticsOptionalanonymousWhether 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
OptionaldeviceThe name of the device that the end user is using. It should be explicitly configured in the context of a native mobile app.
OptionaldocumentSpecifies the URL of the current page or component.
OptionalenabledWhether to enable usage analytics tracking.
OptionaloriginSets 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"
OptionaloriginThe origin level 2 usage analytics event metadata whose value should typically be the identifier of the tab from which the usage analytics event originates (e.g., All).
OptionaloriginThe 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 (e.g., https://connect.coveo.com/s/).
OptionalproxyThe base URL to use to proxy Coveo analytics requests (e.g., https://example.com/analytics).
This is an advanced option that you should only set if you need to proxy Coveo analytics requests through your own server. In most cases, you should not set this option.
OptionalruntimeThe Coveo analytics runtime to use, see https://github.com/coveo/coveo.analytics.js for more info.
Optional InternalsourceSpecifies the frameworks and version used around Headless (e.g. @coveo/atomic).
OptionaltrackingThe unique identifier of the tracking target.
OptionaluserSpecifies the user display name for the usage analytics logs.
The analytics client to use.
legacy: The legacy analytics client, i.e., the Coveo Analytics.js library.next: The next analytics client, i.e., the Coveo Event Protocol with the Relay library.