User-Item Interactions

Add Rating

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

post/{databaseId}/ratings/

Request

  • Base URL
    http://Based on the region of your database (see https://docs.recombee.com/regions).
  • URL
    http://Based on the region of your database (see https://docs.recombee.com/regions)./{databaseId}/ratings/
  • Auth
    none declared

Path parameters

databaseIdstring required

ID of your database.

Request body

userIdstring required

User who submitted the rating

itemIdstring required

Rated item

ratingnumber double required

Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.

cascadeCreateboolean

Sets whether the given user/item should be created if not present in the database.

recommIdstring

If this rating is based on a recommendation request, recommId is the id of the clicked recommendation.

additionalDataobject

Additional data associated with the interaction. The expected structure is defined for specific use cases and will be provided by the Recombee Support team when applicable.

Response

Successful operation.

Changes

No recorded changes to this operation across all 3 revisions of this API.