Filter

​

Overview

• Including only objects whose field value matches the filter list
• Excluding objects whose field value matches the filter list
• Filtering by string, number, or boolean values

​

Command Type

​

Parameters

​

Usage Examples

​

Include Only Specific Statuses

{
  "command": "filter",
  "params": {
    "key": "status",
    "filter": ["active", "pending"],
    "include": true
  }
}

​

Exclude Specific IDs

{
  "command": "filter",
  "params": {
    "key": "id",
    "filter": [101, 202, 303],
    "include": false
  }
}

​

Filter by Boolean Flag

{
  "command": "filter",
  "params": {
    "key": "isVisible",
    "filter": [true],
    "include": true
  }
}

​

Common Use Cases

• Status Filtering: Keep only records in specific states (e.g. active, live)
• ID Exclusion: Remove known irrelevant or blacklisted IDs
• Feature Flagging: Filter based on boolean feature flags in the data

​

Related Commands

• Distinct - Remove duplicates after filtering
• Json Path - Extract specific fields from filtered results
• Key Mapping - Remap fields after filtering