Recombee ListUsersInstall

Overview

This node performs the "ListUsers" operation from the Recombee API, which retrieves user data from a Recombee database. It is designed to handle batch requests efficiently and supports retrying failed batches up to a specified number of times. This node is useful in scenarios where you want to fetch multiple users' information from Recombee for further processing, such as personalization, analytics, or integration with other systems.

Practical examples include:

• Fetching user profiles to enrich customer data in a CRM.
• Retrieving user details to generate personalized recommendations.
• Synchronizing user data between Recombee and another database.

Properties

Output

The node outputs an array of JSON objects, each representing the result of a user listing request. Each output item contains:

• success: A boolean indicating if the request succeeded.
• If successful:
  • The original input data fields.
  • userData: The user data returned by Recombee for that request.
• If failed:
  • error: The error message describing what went wrong.
  • The original input data fields (if available).

The output structure allows downstream nodes to handle both successful and failed requests gracefully. There is no binary data output.

Dependencies

• Requires an API key credential for authenticating with the Recombee service.
• Uses the Recombee API client library (recombee-api-client) to communicate with the Recombee database.
• Needs configuration of:
  • Recombee database ID
  • Private token for authentication
  • Database region
  • Optional API timeout setting (defaults to 10 seconds if not set)

Troubleshooting

• Common issues:

  • Authentication failures due to incorrect or missing API credentials.
  • Network timeouts or connectivity problems when contacting the Recombee API.
  • Batch request failures exceeding the maximum retry count.

• Error messages:

  • Errors returned from the Recombee API are surfaced in the output under the error field.
  • If the node is configured to stop on failure, it will throw an error immediately upon encountering a failed batch request.
  • To handle intermittent failures, increase the "Max Retries" property to allow more retry attempts.
  • Ensure that the API credentials and database identifiers are correctly configured in the node's credentials.

Links and References

• Recombee API Documentation
• Recombee Node.js Client Library