Recombee DeleteViewPortion icon

Recombee DeleteViewPortion

Deletes the viewed portion of an item (for example a video or article) by a user (at a session id).

Overview

This node deletes the viewed portion of an item (such as a video or article) for a specific user within a given session. It is useful in scenarios where you want to remove or reset the tracking of how much of an item a user has consumed, for example, if a user wants to restart watching a video from the beginning or if you need to clear partial view data for analytics or recommendation recalculations.

Practical examples:

  • A streaming service resetting the watch progress of a movie or episode for a user.
  • An online learning platform clearing the partially read status of a course module.
  • Content platforms removing partial consumption data when content is updated or removed.

Properties

Name Meaning
User ID The ID of the user whose viewed portion data will be deleted.
Item ID The ID of the item (e.g., video, article) for which the viewed portion will be deleted.
Session ID The ID of the session associated with the viewed portion to delete.
Recommendation ID Optional. If provided, associates the deletion with a specific recommendation ID.
Max Retries Number of times to retry failed batch requests, useful for handling temporary network issues or rate limits.

Output

The node outputs an array of JSON objects, each representing the result of a delete operation for a viewed portion. Each output object contains:

  • success: Boolean indicating whether the deletion was successful.
  • error: Present only if the deletion failed, containing error details.
  • Input parameters (userId, itemId, sessionId, etc.) to identify the request.
  • userData: Additional data returned by the API on success.

If the node is configured to continue on failure, errors are included in the output per item; otherwise, execution stops on the first error.

No binary data is output by this node.

Dependencies

  • Requires an API key credential for authentication with the external Recombee service.
  • Uses the Recombee API client library to communicate with the Recombee recommendation engine.
  • Node configuration must include valid credentials with database ID, private token, and region.
  • Supports a configurable timeout for API requests (defaulting to 10 seconds if not set).

Troubleshooting

  • Network or Rate Limit Errors: The node retries failed batch requests up to the configured "Max Retries" count. Increase this value if you experience frequent transient failures.
  • Invalid Credentials: Ensure that the API key and other credential details are correct and have sufficient permissions.
  • Missing Required Parameters: The node requires User ID, Item ID, and Session ID. Omitting these will cause errors.
  • Batch Size Limits: The node batches delete requests in groups of 100. Very large inputs may require adjusting or splitting input data.
  • Error Handling: If "Continue On Fail" is disabled, the node will stop on the first error. Enable it to process all items and collect individual errors.

Links and References

Discussion