API Reference

Adds a new item of the given itemId to the items catalog.

Deletes an item of the given itemId from the catalog, including all of its interactions.

Gets a list of IDs of items currently present in the catalog.

Deletes all the items that pass a given filter.

Adding an item property is somewhat equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.

Deleting an item property is roughly equivalent to removing a column from the table of items.

Gets information about specified item property.

Gets the list of all the item properties in your database.

Sets/updates (some) property values of the given item. The properties (columns) must be previously created by Add Item Property.

Gets all the current property values of the given item.

Updates (some) property values of all the items that pass a given filter.

Adds a new user to the database.

Deletes a user of the given userId from the database, including all of their interactions.

Merges interactions (purchases, ratings, bookmarks, detail views, etc.) of two different users under a single user ID. The source user is deleted afterward.

Gets a list of IDs of users currently present in the catalog.

Adding a user property is somewhat equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.

Deleting a user property is roughly equivalent to removing a column from the table of users.

Gets information about specified user property.

Gets the list of all the user properties in your database.

Sets/updates (some) property values of the given user. The properties (columns) must be previously created by Add user property.

Gets all the current property values of the given user.

Adds a detail view of the given item made by the given user.

Deletes an existing detail view uniquely specified by (userId, itemId, and timestamp) or all the detail views with the given userId and itemId if timestamp is omitted.

Lists all the detail views of the given item ever made by different users.

Lists all the detail views of different items ever made by the given user.

Adds a purchase of the given item made by the given user.

Deletes an existing purchase uniquely specified by userId, itemId, and timestamp or all the purchases with the given userId and itemId if timestamp is omitted.

Lists all the ever-made purchases of the given item.

Lists all the purchases ever made by the given user.

Adds a rating of the given item made by the given user.

Deletes an existing rating specified by (userId, itemId, timestamp) from the database or all the ratings with the given userId and itemId if timestamp is omitted.

Lists all the ratings of an item ever submitted by different users.

Lists all the ratings ever submitted by the given user.

Adds a cart addition of the given item made by the given user.

Deletes an existing cart addition uniquely specified by userId, itemId, and timestamp or all the cart additions with the given userId and itemId if timestamp is omitted.

Lists all the ever-made cart additions of the given item.

Lists all the cart additions ever made by the given user.

Adds a bookmark of the given item made by the given user.

Deletes a bookmark uniquely specified by userId, itemId, and timestamp or all the bookmarks with the given userId and itemId if timestamp is omitted.

Lists all the ever-made bookmarks of the given item.

Lists all the bookmarks ever made by the given user.

Sets viewed portion of an item (for example a video or article) by a user (at a session). If you send a new request with the same (userId, itemId, sessionId), the portion gets updated.

Deletes an existing view portion specified by (userId, itemId, sessionId) from the database.

Lists all the view portions of an item ever submitted by different users.

Lists all the view portions ever submitted by the given user.

Based on the user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for the given user.

Recommends a set of items that are somehow related to one given item, optionally taking the target user into account.

Recommends Items that are the most relevant to a particular Segment from a context Segmentation.

Returns items that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (infinite scroll) or goes to the next page.

Recommends the top Segments from a Segmentation for a particular user, based on the user's past interactions.

Recommends Segments from a Segmentation that are the most relevant to a particular item.

Recommends Segments from a result Segmentation that are the most relevant to a particular Segment from a context Segmentation.

Returns Item Segments to be shown as the next recommendations when a user scrolls (e.g., within a carousel or feed of Item Segments such as brands, artists, topics, or categories).

Gets users similar to the given user, based on the user's past interactions (purchases, ratings, etc.) and values of properties.

Recommends users that are likely to be interested in the given item.

Composite Recommendation returns both a source entity (e.g., an Item or Item Segment) and a list of related recommendations in a single response.

It is ideal for use cases such as personalized homepage sections (Articles from <category>), Because You Watched <movie>, or Artists Related to Your Favorite Artist <artist>.

Personalized search. The results are based on the provided searchQuery and also on the user's past interactions (purchases, ratings, etc.) with the items.

Personalized search that returns Segments from a Segmentation. The results are based on the provided searchQuery and also on the user's past interactions (purchases, ratings, etc.).

Adds a new synonym for the Search Items, so that the synonym is also used when the term appears in the search query.

Gives the list of synonyms defined in the database.

Deletes all synonyms defined in the database.

Deletes synonym of the given id. This synonym is no longer taken into account in the Search items.

Creates a new series in the database.

Deletes the series of the given seriesId from the database, without deleting the items themselves.

Gets the list of all the series currently present in the database.

Lists all the items present in the given series, sorted according to their time index values.

Inserts an existing item/series into a series of the given seriesId at a position determined by time.

Removes an existing series item from the series.

Creates a Segmentation that splits the items into segments based on values of a particular item property.

Updates a Property Based Segmentation

Creates a Segmentation that splits the items into segments using multiple ReQL filters.

Update an existing Segmentation.

Adds a new Segment, defined by a ReQL filter, into a Manual ReQL Segmentation.

Update definition of the Segment.

Delete a Segment from a Manual ReQL Segmentation.

Creates a Segmentation that splits the items into segments using a ReQL expression.

Update an existing Segmentation.

Return all existing items Segmentations.

Get existing Segmentation.

Delete existing Segmentation.

Batch processing allows you to submit an arbitrary sequence of requests within a single HTTPS request.

Get all Scenarios of the given database.

Completely and irreversibly erases all the data in the database, including items, users, series, properties, and interactions.