Support Menu

Interface IChangeableAnalyticsDataObject

Interface IChangeableAnalyticsDataObject

The IChangeableAnalyticsDataObject interface describes the modifiable part of the object that all changeAnalyticsCustomData event handlers receive as an argument.

Index

Properties

language

language: string

The language of the search interface from which the usage analytics event originates.

By default, the framework populates this attribute with the currently loaded localization and culture file of the search interface from which the usage analytics event originates.

Note:

External code can modify the value of this attribute.

metaObject

The metadata to send along with the usage analytics event.

Note:

External code can modify existing values, or add new key-value pairs in this attribute.

originLevel1

originLevel1: string

The high-level origin of the usage analytics event.

For instance, this could be the name of the search hub, or a name that can uniquely identify the search page from which the usage analytics event originates.

Default value is default.

Note:

External code can modify the value of this attribute.

originLevel2

originLevel2: string

The mid-level origin of the usage analytics event.

By default, the framework populates this attribute with the data-id of the currently selected tab in the search interface from which the usage analytics event originates.

Note:

External code can modify the value of this attribute.

originLevel3

originLevel3: string

The low-level origin of the usage analytics event.

For instance, this could be the HTTP identifier of the page from which the usage analytics event originates.

Default value is the empty string.

Note:

External code can modify the value of this attribute.

Hierarchy

  • IChangeableAnalyticsDataObject