Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Item → Get Batch Ingestion Status

AI-generated

Overview

This node operation retrieves the status of a specific batch ingestion in the Fredhopper Product Discovery system. It is useful for monitoring the progress or result of a batch ingestion process, which is essential in scenarios where large sets of product data are being ingested and you need to track their processing status.

Use Case Examples

  1. Check the status of a batch ingestion by providing the tenant, environment, and ingestion ID to see if the ingestion is pending, running, completed, or failed.
  2. Monitor batch ingestion status to trigger subsequent workflows based on ingestion completion or failure.

Properties

Name Meaning
Tenant The tenant identifier for the Fredhopper environment where the batch ingestion is taking place.
Environment The environment within the tenant (e.g., production, staging) where the batch ingestion is monitored.
FHR Validation A boolean flag indicating whether Fredhopper validation should be applied during the operation.
Ingestion ID The unique identifier of the batch ingestion whose status is to be retrieved.

Output

JSON

  • status - The current status of the batch ingestion (e.g., pending, running, completed, failed).
  • details - Additional details or metadata about the batch ingestion status returned by the API.

Dependencies

  • Requires an API key credential for authentication to the Fredhopper Product Discovery API.

Troubleshooting

  • Ensure the provided ingestion ID is correct and exists in the specified tenant and environment.
  • Authentication errors may occur if the API credentials are invalid or expired; verify the API key credential.
  • Network or API endpoint issues may cause request failures; check connectivity and endpoint URLs.
  • If the ingestion ID is invalid or not found, the node may throw an error indicating the batch ingestion status could not be retrieved.

Discussion