Recombee AddDetailView icon

Recombee AddDetailView

Records when a user views an item. This is used to track user interest and build viewing history. Detail views are crucial for understanding user behavior and improving recommendation accuracy

Overview

This node records when a user views an item, capturing detail view events that are essential for tracking user interest and building viewing history. Such data is crucial for understanding user behavior and improving the accuracy of recommendation systems.

Common scenarios where this node is beneficial include:

  • E-commerce platforms tracking which products users have viewed to personalize recommendations.
  • Content websites monitoring article or video views to suggest related content.
  • Any application aiming to enhance user experience by analyzing detailed user-item interactions.

For example, when a user views a product page, this node can log that event with the user ID, item ID, and optionally associate it with a recommendation ID or timestamp. This information helps the recommendation engine learn user preferences over time.

Properties

Name Meaning
User ID The ID of the user who viewed the item.
Item ID The ID of the item that was viewed.
Cascade Create Whether to create the item if it does not exist in the database (true/false).
Timestamp Optional timestamp of when the view occurred. If not provided, the current time will be used.
Max Retries Number of times to retry failed batch requests. Useful for handling temporary network issues or rate limits.
Recommendation ID Optional recommendation ID. If provided, the detail view will be associated with the specified recommendation.

Output

The node outputs an array of JSON objects, each representing the result of recording a detail view event. Each output object contains:

  • success: Boolean indicating whether the operation succeeded.
  • On success: The original input parameters plus additional data returned from the API.
  • On failure: An error message describing what went wrong.

If multiple items are processed, results are batched and returned accordingly.

The node does not output binary data.

Dependencies

  • Requires an external recommendation service API client.
  • Needs credentials including database ID, private token, and region to authenticate API requests.
  • The node batches up to 100 detail view requests per API call.
  • Supports configurable timeout and retry logic for robustness against transient failures.

Troubleshooting

  • Common Issues:

    • Network errors or API rate limits causing request failures.
    • Invalid user or item IDs leading to API errors.
    • Missing or incorrect credentials preventing authentication.
  • Error Messages:

    • Errors returned from the API are surfaced in the output with details.
    • If "Continue on Fail" is disabled, the node execution stops on the first error.
    • Retry attempts are made automatically based on the configured max retries.
  • Resolutions:

    • Verify all required properties are correctly set.
    • Ensure valid and active API credentials are configured.
    • Increase max retries if facing intermittent network issues.
    • Use "Continue on Fail" option to allow partial success in batch operations.

Links and References

Discussion