Interface AnalyticsConfiguration

The analytics configuration options.

interface AnalyticsConfiguration {
    analyticsClientMiddleware?: AnalyticsClientSendEventHook;
    analyticsMode?: "legacy" | "next";
    anonymous?: boolean;
    deviceId?: string;
    documentLocation?: string;
    enabled?: boolean;
    originContext?: string;
    originLevel2?: string;
    originLevel3?: string;
    proxyBaseUrl?: string;
    runtimeEnvironment?: IRuntimeEnvironment;
    source?: Partial<Record<"@coveo/atomic" | "@coveo/quantic", string>>;
    trackingId?: string;
    userDisplayName?: string;
}

Properties

analyticsClientMiddleware? analyticsMode? anonymous? deviceId? documentLocation? enabled? originContext? originLevel2? originLevel3? proxyBaseUrl? runtimeEnvironment? source? trackingId? userDisplayName?

Properties

OptionalanalyticsClientMiddleware

analyticsClientMiddleware?: AnalyticsClientSendEventHook

analyticsClientMiddleware allows to hook into an analytics event payload before it is sent to the Coveo platform.

OptionalanalyticsMode

analyticsMode?: "legacy" | "next"

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.

The default value is next.

Default

'next'

Optionalanonymous

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

OptionaldeviceId

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.

OptionaldocumentLocation

documentLocation?: string

Specifies the URL of the current page or component.

Optionalenabled

enabled?: boolean

Specifies if usage analytics tracking should be enabled.

By default, all analytics events will be logged.

OptionaloriginContext

originContext?: string

Sets the Origin Context dimension on the analytics events.

You can use this dimension to specify the context of your application. The possible values are "Search", "InternalSearch", and "CommunitySearch".

The default value is Search.

OptionaloriginLevel2

originLevel2?: string

Sets the value of the Origin Level 2 dimension on the analytics events.

Origin level 2 is a usage analytics event metadata whose value should typically be the name/identifier of the tab from which the usage analytics event originates.

In the context of product listing, the value should match the breadcrumb of the product listing page from which the usage analytics event originates (for example, canoes-kayaks/kayaks/sea-kayaks).

When logging a usage analytics event, originLevel2 should always be set to the same value as the corresponding tab (parameter) Search API query parameter so Coveo Machine Learning models function properly, and usage analytics reports and dashboards are coherent.

If left unspecified, this value will automatically try to resolve itself from the tab Search API query parameter.

OptionaloriginLevel3

originLevel3?: string

Origin level 3 is a 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.

When logging a Search usage analytics event, originLevel3 should always be set to the same value as the corresponding referrer Search API query parameter so usage analytics reports and dashboards are coherent.

This value is optional, and will automatically try to resolve itself from the referrer search parameter.

OptionalproxyBaseUrl

proxyBaseUrl?: string

The 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.

See Headless proxy: Analytics.

OptionalruntimeEnvironment

runtimeEnvironment?: IRuntimeEnvironment

Optional analytics runtime environment, this is needed for analytics to work correctly if you're running outside of a browser. See https://github.com/coveo/coveo.analytics.js for more info.

Optional Internalsource

source?: Partial<Record<"@coveo/atomic" | "@coveo/quantic", string>>

Specifies the frameworks and version used around Headless (e.g. @coveo/atomic).

OptionaltrackingId

trackingId?: string

The unique identifier of the tracking target.

OptionaluserDisplayName

userDisplayName?: string

Specifies the user display name for the usage analytics logs.

Settings

Member Visibility

On This Page

Properties