Events API

Events are at the heart of Froomle. They represent the actions the user takes on your website, which fuel our machine learning models. To stream these events to the Froomle platform you use your personal HTTP API at customer_token.froomle.com. This URL is followed by /api/environment/events. Your Froomle Solution Architect will decide on the values of customer_token and environment with you at kick-off of the project.

Back-end integration

When integrating Froomle into a back-end service, it is recommended to send events to the endpoint in batches. Implementing this is especially applicable during peaks of high traffic and will speed up the response time. The recommended amount of time between two batches is 500 milliseconds. Delays up to 1 second are acceptable. Delays up to 5 seconds have a potential negative influence on the quality of recommendations. Delays >1 minute have a guaranteed negative effect on the quality of recommendations.

Front-end integration

When integrating Froomle into a front-end service, the events have to be sent as they occur.

Operations:

Method Description

Communicate a batch of events to the Froomle platform