Metrics

Metrics are calculated in time slices. Every metric will have fields start_time and end_time to indicate the bounds of the time slice. There can be multiple metric entries for a single time slice, one for each page_type and version for example. This way you can get detailed insights into how each module and version is performing. To gain access to your metrics, please refer to the Metrics API page.

General metrics

Name Description

pageviews

Aggregates view events across all known pages.

item_interactions

Aggregates item_interaction events. Item interactions typically represent a higher engagement than a click: e.g. a like, a share, …​

add_to_carts

Aggregates add_to_cart events across all pages and page-types.

purchased_items

Aggregates purchases of individual items.

batch_opens

Aggregates batch open events across all integration types.

revenue

Aggregates the total price of purchases.

Integration metrics

name description

clicks

Aggregates click_on_recommendation event across all integration types. Froomle typically receives click_on_recommendation events for both recommendations served by Froomle as well as any recommendations served by other providers.

requests

Aggregates all requests across all integration types. Clients are requested to supply request IDs also for recommendations which Froomle did not serve, such that clicks can be attributed to a specific request.

recommendation_sets

Aggregates recommendations generated by Froomle, distinct on request_id. This number is different from the number of requests as it contains only recommendations served by Froomle.

impressions_sets

Aggregates all impressions across all integration types, distinct on request_id. Clients are requested to supply impressions also for recommendations which Froomle did not serve, such that clicks can be attributed to a specific impressed recommendation.

batch_clicks

Aggregates batch_click_on_recommendation event across all integrations and environments.

batch_requests

Aggregates all batch requests across all integration types and environments. Clients are requested to supply request IDs also for recommendations which Froomle did not serve, such that clicks can be attributed to a specific request.

batch_recommendation_sets

Aggregates batch recommendations generated by Froomle, distinct on request_id. This number is different from the number of requests as it contains only recommendations served by Froomle.

batch_impressions_sets

Aggregates all batch impressions across all integration types and environments, distinct on request_id. Clients are requested to supply impressions also for batch recommendations which Froomle did not serve, such that clicks can be attributed to a specific impressed batch recommendation.

Attribution metrics

name description

attributed_purchased_items

Aggregates a purchase with an item that was recommended which occurred within <window> time of a click on a Froomle recommendation.

attributed_revenue

Aggregates the price of a purchase with an item that was recommended which occurred within <window> time of a click on a Froomle recommendation.

attributed_item_interactions

Aggregates an interaction with an item that was recommended which occurred within <window> time of a click on a Froomle recommendation.