Monitoring your API
Explore API requests, responses and violations.A window into your API
Open up your browser and point it at http://localhost:9091, (or which ever port you have configured ) and you should see the wiretap monitor.
![The main components of wiretap outlined Screenshot of wiretap monitor with areas outlined](https://pb33f.io/wiretap/monitor/monitor-outline.webp)
Transaction area
Select a transaction from the list to view the request, response and any violations that may have been fired.
![The main components of wiretap outlined Screenshot of wiretap monitor with areas outlined](https://pb33f.io/wiretap/monitor/api-transactions.webp)
indicates that a global delay was applied to the transaction. indicates the round-trip time of the transaction. indicates the transaction is part of a chain. indicates the transaction was compliant with the API specification. indicates the transaction was not compliant with the API specification.
Explorer area
Once an API transaction has been selected, the request, response, violations and chains (if available) can be navigated to using the tabs.
![View headers, body, query params, cookies and more via the API transaction explorer Screenshot of monitor UI with the API explorer highlighted](https://pb33f.io/wiretap/monitor/api-explorer.webp)
Filtering by HTTP Method
Click on the
![Filter API transactions by HTTP method Screenshot of monitor UI with the API filter highlighted](https://pb33f.io/wiretap/monitor/filters-chains.webp)
Filtering by keyword
Type in the word(s) you wish to filter by and then hit enter/return. The transactions will auto-update.
![Filter API transactions by keyword(s) Screenshot of monitor UI with a keyword entered](https://pb33f.io/wiretap/monitor/filter-keyword.webp)
Creating request chains
A request chain is a series of API calls that are related to one another by the use of a keyword.
For example, if the word bookId
is added as a chain keyword, then all HTTP transactions that have a property, either via a query
parameter or a header, or a JSON body, that contains the key bookId
will be added to the chain.
Chains are formed where the value
of the property is matched across the transactions.
So a chain will be formed if the following transactions are found:
- GET /books?bookId=abc123
- GET /transactions?bookId=abc123
- POST /books { “bookId”: “abc123” }
Any transaction that has a different value for the bookId
property will form a new chain.
wiretap
currently only supports query parameters. Full support for body/header params and properties is coming soon.![Defining chains by using chain keywords Screenshot of monitor UI with a keyword entered](https://pb33f.io/wiretap/monitor/filter-chain-word.webp)
Viewing request chains
If a transaction is part of a chain, the
When clicking on the transaction, a ‘Chains’ tab should appear in the explorer area. Click on this tab to view the request that the transaction is part of.
![Viewing an API transaction request chain Screenshot of monitor UI showing a request chain](https://pb33f.io/wiretap/monitor/view-chain.webp)
Changing settings
Click on the
Global delay
Set a value greater than 0
to stick a global delay to all responses. This is useful for testing how your application handles slow responses.
Resetting the monitor
Loads of junk in your UI? want to clear it all out? Hit the Reset State button to start fresh.
Downloading the Session
Want a ready to go JSON report of the API capture session? Hit the Download Session Data button to download a JSON file of the session.
![Viewing an API transaction request chain Screenshot of monitor UI showing a request chain](https://pb33f.io/wiretap/monitor/settings.webp)