Recombee ListItemViewPortions icon

Recombee ListItemViewPortions

Lists the viewed portions of an item (for example a video or article).

Overview

This node interacts with the Recombee API to list the viewed portions of a specific item, such as a video or article. It retrieves detailed data about which parts of an item users have viewed, enabling insights into user engagement and content consumption patterns.

Common scenarios where this node is beneficial include:

  • Analyzing how much of a video or article users typically watch or read.
  • Personalizing recommendations based on partially consumed content.
  • Monitoring content performance by tracking user interaction depth.

For example, a media platform could use this node to fetch viewing portions of a video to understand drop-off points, or a news website might analyze which sections of an article are most frequently read.

Properties

Name Meaning
Item ID The unique identifier of the item (e.g., video or article) for which to list view portions.
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 corresponding to an input item. Each output object contains:

  • success: A boolean indicating whether the request for that item succeeded.
  • itemId: The ID of the item queried.
  • userData: If successful, this field contains the detailed data about the viewed portions returned by the Recombee API.
  • error: If the request failed, this field contains the error message explaining the failure.

If multiple items are processed in batch, the node handles them accordingly and returns results per item.

Dependencies

  • Requires an API key credential for authenticating with the Recombee service.
  • Needs configuration of the Recombee database ID, private token, and region via credentials.
  • Uses the official Recombee API client library (recombee-api-client).

Troubleshooting

  • Network or Rate Limit Errors: The node retries failed batch requests up to the configured "Max Retries" count. If failures persist beyond retries, errors are thrown unless the node is set to continue on fail.
  • Invalid Item ID: Providing an incorrect or non-existent item ID will result in an error from the Recombee API.
  • Credential Issues: Missing or invalid API credentials will cause authentication failures.
  • Timeouts: The node uses a timeout value from credentials; if the API is slow or unresponsive, consider increasing this timeout.

To resolve common errors:

  • Verify the correctness of the Item ID.
  • Ensure valid and complete Recombee API credentials are provided.
  • Adjust "Max Retries" to handle transient network issues.
  • Enable "Continue On Fail" if partial success is acceptable.

Links and References

Discussion