Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Actions31

Item → List Batch Ingestions

AI-generated

Overview

This node operation lists batch ingestions for items in the Fredhopper Product Discovery system. It allows users to retrieve information about batch ingestion processes filtered by tenant, environment, optional lookback duration, and status. This is useful for monitoring and managing batch ingestion workflows in product catalogs.

Use Case Examples

  1. A user wants to see all batch ingestions for a specific tenant and environment to monitor ingestion statuses.
  2. A user filters batch ingestions to only show those that are currently running or failed to troubleshoot ingestion issues.

Properties

Name Meaning
Tenant The tenant identifier for which to list batch ingestions.
Environment The environment within the tenant to filter the batch ingestions.
FHR Validation Flag to enable or disable Fredhopper validation (not directly used in this operation but part of the resource properties).
Lookback Duration Optional duration to look back for filtering ingestions, e.g., '7d' for 7 days or '24h' for 24 hours.
Status Filter ingestions by their status such as pending, running, completed, or failed.

Output

JSON

  • ``
    • id - The unique identifier of the batch ingestion.
    • status - The current status of the batch ingestion.
    • created - Timestamp when the batch ingestion was created.
    • updated - Timestamp when the batch ingestion was last updated.
    • tenant - Tenant associated with the batch ingestion.
    • environment - Environment associated with the batch ingestion.
    • details - Additional details or metadata about the batch ingestion.

Dependencies

  • Fredhopper Product Discovery API
  • An API key credential for authentication

Troubleshooting

  • Authentication failure due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Invalid tenant or environment parameters may result in no data returned or errors. Verify these inputs are correct.
  • Incorrect format for lookback duration (should be a string like '7d' or '24h') may cause the API to reject the request.
  • Filtering by status requires valid status values; using unsupported values may cause errors.

Links

Discussion