Navigation

Group By Component

Learn how the Group By node groups JSON records into arrays by a selected field in your pipeline; numeric operations such as sum or average require a script.

Last updated:

The Group By Component groups records from a JSON array by a shared field value, collecting all matching records into a named array. It's essential for reorganising and summarising large datasets by category.

Note: The current implementation groups records into arrays. Numeric aggregations (Sum, Average, Min/Max) are not yet supported — use the Script Component if you need custom aggregation logic.

⚙️ Configuration

  1. Group Key: The field whose value is used to form groups (e.g., category, status).

The output is an object where each key is a unique value of the group field, and each value is an array of the matching records.

💡 Example

Grouping a list of orders by status produces an object like:

{
  "pending":   [{ ... }, { ... }],
  "shipped":   [{ ... }],
  "delivered": [{ ... }, { ... }, { ... }]
}

📊 Visualization

Grouped data is perfect for feeding into Charts. Bar charts and Pie charts work best with aggregated outputs.