User interactions

Preparation

This step connects Froomle with user interaction data, letting the recommendation engine learn from behavioral and engagement data. Examples of user interactions that lead to an event are when a user opens an article detail page, clicks on a recommendation or purchases a product or subscription. We give a brief overview of integration approaches and available events.

Main stakeholder

  • Customer data/tracking owner (supported by integration developers).

Results

  • Decision made on which events to send.

  • Event connectors selected.

  • Privacy concerns clarified.

Choose Event Integration Connectors

Events API

Usually events are communicated to Froomle using the Events API. This is a simple REST API that can be integrated both front-end or back-end depending on your needs. Where applicable, it is highly recommended to send events in reasonably sized batches, e.g., sending all simultaneous impression events in a single API call. Specifications of event structure and all available events are documented in Tracking events.

Publish events to Froomle PubSub

Froomle runs on the Google Cloud Platform. We allow you to publish events directly on our PubSub stream. To allow this we will follow the following steps:

Upload events using SFTP

For information that is not time-sensitive, you can use file dumps to the Froomle SFTP server, containing many separate entries to be processed at once. Some typical examples are e-mail opens or clicks, historic events or offline purchases. After reading our SFTP reference document, you should have a clear understanding of both how to communicate with the Froomle SFTP and what types of data are a good fit for file dumps. See Tracking events for delivery channels and best practices.

Decide which events to send

The following table lists all available event types in the Froomle specification, organized by priority and use case.

Priority Event Description

Must for go-live

detail_pageview

Sent when a user views a specific item’s detail page, essential for algorithm training.

click_on_recommendation

Tracks which (Froomle) recommendations are clicked, essential for performance optimization.

page_visit

Generic view event, not related to an item. Essential for analytics.

Should have

impression

Records that a user has seen a recommended item. Allows for more accurate performance optimization.

Could have

start_subscription

Tracks when a user converts to a paid or registered subscription tier.

item_interaction

For actions like "save to wishlist," "like," or "share" on a specific item.

Other available events

user_interaction

General interactions not tied to a specific catalog item.

cancel_subscription

Tracks churn events to help build better retention models.

checkpoint

A custom marker for reaching specific milestones in a user flow.

add_to_cart

Standard e-commerce event for adding items to the basket.

remove_from_cart

Tracks items removed from the basket for intent analysis.

Batch processing events

batch_open

Recorded when a user opens an email or message containing batch recommendations.

batch_click_on_recommendation

A click originating from a batch-delivered module (e.g., e-mail).

batch_impression

Confirms the user viewed a batch-delivered placement.

purchase

The final conversion event, linking a user to the items they actually bought.

For detailed specifications of each event’s fields and structure, see Tracking Events.

Next step

Continue with monitoring and QA.