API reference

This section lists all the available API endpoints. These allow you to manage your item catalog, user interactions, configurations, metrics and retrieve recommendations.

API

Description

Items API

Customer pushes all updates to the catalog via Froomle’s Items API

POST

Add a new item

PUT

Add or update an item

DELETE

Remove an item

POST

Disable an item

POST

Enable the item, can be used to reenable a previously disabled item

Events API

Customer pushes all user events via Froomle’s Events API

POST

Log an event of any form

Recommendations API

Customer can retrieve recommendations for their users via Froomle’s Recommendations API

GET

Query the response cache, in case recommendations where fetched partially

POST

Request a set of recommendations

Search API

Batch Recommendations API

Customer can request a large amount of recommendations for their multiple users at once via Froomle’s Batch Recommendations API

Audience Targeting API

If you have a specific offering you want to present to the users that would be most interested in it, the Audience Targeting API has you covered!

GET

Query the response cache

POST

Request an audience for a promotion

Configurations API

Customer can optionally manage all of the configurations (filters, constraints etc.) via Froomle’s Configurations API.

GET

Retrieve all registered configurations

GET

Retrieve a configuration

POST

Add a new configuration

PUT

Update a configuration

DELETE

Delete a configuration

Metrics API

Customer can retrieve metrics concerning their recommendations via Froomle’s Metrics API

GET

Retrieve list of available metrics

GET

Retrieve data of specified metric

Users API

Customer can optionally manage user data via Froomle’s Users API.

DELETE

Delete user identity