Parse Commands

​

Overview

• 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

​

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

​

Common JSONPath Patterns

$.items[*].id

$[0]

$.data.events[*].id

$..name

​

Command Parameters

​

Variable Support

{
  "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

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

​

Related Commands

• HTTP Commands - Fetch data to parse
• Object Mapper - Transform parsed data
• Validation Commands - Validate parsed data