RErecombee
User-Item Interactions

Set View Portion

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.

post/{databaseId}/viewportions/

Request

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

Path parameters

databaseIdstring required

ID of your database.

Request body

userIdstring required

User who viewed a portion of the item

itemIdstring required

Viewed item

portionnumber double required

Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the actual viewed part of the item, no matter the seeking. For example, if the user seeked immediately to half of the item and then viewed 10% of the item, the portion should still be 0.1.

sessionIdstring

ID of the session in which the user viewed the item. Default is null (None, nil, NULL etc., depending on the language).

cascadeCreateboolean

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

recommIdstring

If this view portion 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.

autoPresentedboolean

Indicates whether the item was automatically presented to the user (e.g., in a swiping feed) or explicitly requested by the user (e.g., by clicking on a link). Defaults to false.

timeSpentnumber double

The duration (in seconds) that the user viewed the item. In update requests, this value may only increase and is required only if it has changed.

Response

Successful operation.

Changes

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