API Diagnosis

APXY can analyze historical traffic to produce health reports for API endpoints, and execute live batch requests to test multiple endpoints at once.

Web UI

After you run diagnosis or batch commands, review the resulting traffic in the Capture group and compare patterns in the Analyze views.

CLI

Full flags and behavior for apxy tools request diagnose and apxy tools request batch are documented in CLI Reference → Tools.

Quick example:


apxy tools request diagnose --file endpoints.json --format markdown

Endpoint file format

Both commands accept a JSON array of endpoint definitions:


[
  {
    "url": "https://api.example.com/v1/users",
    "method": "GET",
    "expected_status": 200,
    "description": "User listing API"
  },
  {
    "url": "https://api.example.com/v1/auth/token",
    "method": "POST",
    "headers": {"Content-Type": "application/json"},
    "body": "{\"grant_type\":\"client_credentials\"}",
    "expected_status": 200,
    "timeout_ms": 5000,
    "description": "Auth token endpoint"
  }
]

Field	Type	Required	Description
`url`	string	yes	Endpoint URL
`method`	string	no	HTTP method (default: GET)
`headers`	object	no	Request headers
`body`	string	no	Request body
`expected_status`	int	no	Expected HTTP status
`description`	string	no	Human-readable description
`timeout_ms`	int	no	Per-request timeout

Use Cases

Debug a broken screen

A screen in your app is broken — extract the API endpoints it calls, save them to endpoints.json, and run apxy tools request diagnose (see Tools reference for output formats). The report shows which endpoint is healthy, degraded, or failing.

Smoke test after deployment

Run apxy tools request batch with --compare-history against your critical endpoints file to execute live requests and compare with recent captured traffic (see Tools reference).