Skip to main content
Parse commands enable you to extract and parse data from various formats including JSON, HTML, XML, and other structured data formats. These commands are essential for transforming raw data into usable structured formats.

​
Overview

Parse commands provide functionality for:
  • Extracting data using JSONPath queries
  • Parsing JSON structures
  • Transforming data formats
  • Extracting specific fields from complex data structures
  • Mapping data between different structures

​
Available Commands

JSON Parse

Parse JSON data into structured objects

Json Path

Extract data using JSONPath expressions

​
Common Use Cases

  • API Response Parsing: Extract specific fields from API responses
  • Data Transformation: Transform data structures for downstream processing
  • Field Extraction: Extract specific values from nested JSON structures
  • Data Mapping: Map data between different formats
  • Response Processing: Process and structure HTTP response data

​
JSONPath Syntax

JSONPath commands use JSONPath expressions to query JSON data. Common patterns include:
PatternDescriptionExample
$Root element$
$.fieldAccess field at root$.data
$[*]All array elements$.items[*]
$[0]First array element$.items[0]
$[-1]Last array element$.items[-1]
$.field[*].subfieldNested array access$.data.items[*].id
$..fieldRecursive search for field$..name

​
Common JSONPath Patterns

Extract all IDs: 
$.items[*].id
Get first item: 
$[0]
Nested access: 
$.data.events[*].id
Recursive search: 
$..name

​
Command Parameters

Parse commands typically support the following parameters:
ParameterTypeDescriptionRequired
sourcestringSource data to parseYes
jsonPathstringJSONPath expression for extractionYes (for Json Path)
keystringKey name for extracted dataYes
inputstringInput data referenceYes

​
Variable Support

Parse commands support variable interpolation in source data and JSONPath expressions: 
{
  "command": "json-path",
  "params": {
    "jsonPath": "$.data.items[*].title",
    "input": "@{PREVIOUS_OUTPUT}",
    "key": "extracted_titles"
  }
}

​
Best Practices

  • Test JSONPath Queries: Use the Test panel to validate JSONPath syntax
  • Verify Source Data Structure: Check actual data structure before writing queries
  • Use Descriptive Keys: Use clear, descriptive key names for extracted data
  • Handle Missing Data: Account for missing fields or null values
  • Start Simple: Begin with simple queries and build complexity gradually

​
Troubleshooting

​
JSONPath Queries Not Working

If JSONPath queries return no results:
  1. Verify Source Data: Check the actual structure of source data using the Test panel
  2. Test Syntax: Validate JSONPath syntax matches the data structure
  3. Check Source Selection: Ensure the correct source is selected
  4. Review Query Examples: Start with simpler queries and build complexity

​
Common Issues

  • Incorrect JSONPath Syntax: Verify syntax matches JSONPath specification
  • Data Structure Mismatch: Ensure query matches actual data structure
  • Missing Fields: Handle cases where expected fields may not exist
  • Null Values: Account for null or undefined values in data