Skip to content

Response Format

The tool returns a structured, machine- and human-readable result with box-drawing formatting, pass/fail indicators, and a summary.

Passing (with assertions)

All assertions matched:

┌──────────────────────────────────────────────┐
│ Api Test Result                              │
└──────────────────────────────────────────────┘

API Name        : create-user
Method          : POST
URL             : https://api.example.com/v1/users
Status Code     : 201
Response Time   : 142.35 ms
Overall Result  : Passed

Assertions
--------------------------------------------------
✓ status_code
✓ response_field_exist

Summary
--------------------------------------------------
Total Assertions : 2
Passed           : 2
Failed           : 0

Failing (assertion mismatch)

One or more assertions did not match:

┌──────────────────────────────────────────────┐
│ Api Test Result                              │
└──────────────────────────────────────────────┘

API Name        : create-user
Method          : POST
URL             : https://api.example.com/v1/users
Status Code     : 500
Response Time   : 89.12 ms
Overall Result  : Failed

Assertions
--------------------------------------------------
✗ status_code

Summary
--------------------------------------------------
Total Assertions : 1
Passed           : 0
Failed           : 1

Network / runtime error

When the request cannot be completed due to a connection error or timeout:

┌──────────────────────────────────────────────┐
│ Api Test Result                              │
└──────────────────────────────────────────────┘

API Name        : check-service
Method          : GET
URL             : https://api.internal.example.com/v1/status
Overall Result  : Failed

Error
--------------------------------------------------
ConnectError: [Errno 8] nodename nor servname provided, or not known

Understanding the output

Field Description
API Name The name you provided for the test
Method HTTP method used (GET, POST, etc.)
URL Full resolved URL of the request
Status Code HTTP status code returned by the server
Response Time Time taken for the request in milliseconds
Overall Result Passed if all assertions pass, Failed otherwise
Assertions Individual assertion results with ✓ (pass) or ✗ (fail)
Summary Aggregate counts of total, passed, and failed assertions