Register event

Register event is a One-to-one API method to save all the user interactions to be used for the training on your deep learning recommendation model.

Is used to register all interactions (events) for every user on your eCommerce o application in order to improve the recommendation system. This method needs the user session id and the API identifier for the event manager.

Using the sidebar go to One-to-one section and select your trained model.

Follow this steps:

1. Go to Events API tab.

2. Create a Real-time event manager.

3. Use the form to configure your Register event calls.

4. Test your API call.

Now you can test the Register event method. With this method you can save all the user interactions (impression, click, add to cart, purchase).

How to use the API?

On API: Register event box you can configure how will be your API request.

This is the URL to make the POST request: https://yourcommunify.com/api/onetoone/recommendation/registerEvent

Input fields

• account_id: Your account id. This field is mandatory.

• private_api_key: Your private API key. This field is mandatory.

• ssid: The API SSID key. This field is mandatory.

• api_id: The API identifier for the event manager. This field is mandatory.

• reference_product_id: The product that has been interacted by the user. This field is mandatory.

• reference_user_id: The customer reference id. This field is not mandatory, you can work with unlogged users.

• session_id: The user session identifier. This field is mandatory.

• event_type: The event type. This field is required. Only this events are available:

  • Impression

  • Click

  • Add to cart

  • Purchase

Log in to your account to get the account_id, private_api_key and the SSID values.

API response

{

"status": "ok",

"data": true

}