Type alias UserEngagement

UserEngagement: Client & InteractionEvent & SearchResult & Source & {
    categoryId?: string;
    catalogObjectId?: string;
    catalogObjectType?: string;
    personalizationServiceProvider?: string;
    personalizationId?: string;
    personalizationContentId?: string;
    linkHref?: string;
    linkId?: string;
    linkRel?: string;
    linkTarget?: string;
    linkReferrerPolicy?: string;
    linkLabel?: string;
    buttonLabel?: string;
    buttonType?: string;
    buttonId?: string;
    recordId?: string;
}

An engagement of a user on a web site. This is a generic event (e.g., generic page views and button clicks) used when a specific event is not appropriate.

Type declaration

  • Optional categoryId?: string

    The category id of the catalog object (e.g., Product) associated with the event

  • Optional catalogObjectId?: string

    Unique identifier of the catalog object (e.g., Product) associated with the event

  • Optional catalogObjectType?: string

    Type of the catalog object associated to the cart item.

  • Optional personalizationServiceProvider?: string

    Identifier for the source system that provided the personalization information.

  • Optional personalizationId?: string

    The identifier, provided by the personalization service provider, of the specific personalization information associated with this event.

  • Optional personalizationContentId?: string

    The identifier, provided by the personalization service provider, of the specific content (e.g., product) associated with this event.

  • Optional linkHref?: string

    Html href attribute of an anchor element associated with the event. Applies to interactionName=anchor-click.

  • Optional linkId?: string

    Unique identifier of an anchor element associated with the event. Applies to interactionName=anchor-click.

  • Optional linkRel?: string

    Relative attribute of an anchor element associated with the event. Applies to interactionName=anchor-click.

  • Optional linkTarget?: string

    Target attribute of an anchor element associated with the event. Applies to interactionName=anchor-click.

  • Optional linkReferrerPolicy?: string

    Referrer policy attribute of an anchor element associated with the event. Applies to interactionName=anchor-click.

  • Optional linkLabel?: string

    Text inside the anchor element associated with the event. Applies to interactionName=anchor-click.

  • Optional buttonLabel?: string

    Text inside the button associated with the event. Applies to interactionName=button-click.

  • Optional buttonType?: string

    Type of the button associated with the event. Applies to interactionName=button-click.

  • Optional buttonId?: string

    Unique identifier of the button associated with the event. Applies to interactionName=button-click.

  • Optional recordId?: string

    Deprecated

Settings

Member Visibility

Theme