API Tree Path allows users to visually explore API responses and select exact fields for validation without writing paths or JSON expressions manually.
Why it matters
-
API responses are often large and deeply nested
-
Writing JSON paths manually is error-prone
-
Testers should focus on validation, not syntax
-
Supports structured navigation of nested objects and arrays
When to use it
-
When working with complex or nested API responses
-
When validating specific values inside large JSON payloads
-
When comparing API responses without manual path writing
-
When extracting values from repeated or array-based responses
Core concepts
-
API Tree – A structured view of the API response
-
Path Selection – Click-based field selection
-
Comparison Engine – Automatically compares selected values
-
Array Indexing – Supports numeric array paths like
[0],[1], etc. -
Wildcard Support – Advanced users can manually use
[*]to target all array elements
How it works
-
API is executed (Server or Smart Agent)
-
AXQA builds a structured tree from the response
-
User selects fields directly from the tree
-
Selected paths are used for validation and comparison
Working with arrays
-
When a response contains arrays, the tree generates indexed paths such as
items[0].price. -
Each index represents a specific element inside the array.
-
For dynamic validations across all elements, advanced users may manually replace numeric indexes with
[*]. -
Example:
users[0].email
can be manually converted to:users[*].email
How to use it
Step 1: Link an API to a test step
Select an Action API or Expected API in the test step.
Step 2: Preview API response tree
Run the API preview to load the response structure.
Step 3: Select fields visually
Click on any node in the tree to choose the exact field.
Step 4: Define comparison
Choose how the selected value should be validated (equals, range, regex, etc.).
Advanced path editing (optional)
-
Selected paths can be manually adjusted in the expected field input.
-
You may replace specific indexes (e.g.,
[0]) with[*]to validate across multiple elements. -
Wildcard paths are supported by the comparison engine even if not auto-generated by the tree.
Best practices
-
Use the tree preview before writing comparisons
-
Validate only relevant fields, not full responses
-
Combine tree paths with flexible comparison types
-
Use
[*]for dynamic or repeated array validations
Common mistakes
❌ Manually typing complex response paths
✔ Use the API Tree Path selector
❌ Comparing entire responses unnecessarily
✔ Select only the fields that matter
❌ Assuming array indexes are always stable
✔ Use [*] when validating dynamic lists
Security & permissions
-
Tree preview respects execution source rules
-
Internal APIs can be previewed via Smart Agent only
-
Response data is sanitized and size-limited
Related documentation
-
Comparison Types
-
Smart Agent Execution