Skip to Content
This documentation is provided with the HEAT environment and is relevant for this HEAT instance only.

json-filter

The json-filter transform reads the latest JSON payload from a single parent, evaluates a JMESPath expression, and submits the filtered result as JSON output.

When to use it

Use immediately before dashboard, dashboard-v2, or other JSON consumers when you need to scope records (for example by session user id) without rewriting the upstream payload.

Limitations

  • One parent only; takes the first payload in the input map.
  • Input must be valid JSON; parse or JMESPath errors fail the node.
  • Does not build $heat-dataservice or layout; pair with tabular-to-dataservice or system-arbex-js for Next payloads.

Configuration

PropertyRequiredDescription
expressionyesJMESPath expression applied to the parsed JSON root

Example

Input:

[ { "userId": "u1", "score": 10 }, { "userId": "u2", "score": 15 } ]

Expression: [?userId=='u1']

Session-scoped variables such as $SESSION.* may be supported where the runtime expands them in expressions.