Documentation
The local dashboard
Read-only, loopback-only, and gone when the application closes.
1. How it works
- The server binds to 127.0.0.1 on port 5000; it is not reachable from the network, and there is no authentication because there is nothing to authenticate.
- Only GET requests are answered.
- The page polls once a second; there is no server-sent event stream in this build.
- Static assets for the page are compiled into the executable - nothing is fetched from the Internet.
- The dashboard needs a licence: it is available from the trial edition upwards, not in the free tier.
2. Endpoints
- /api/status
- Service and session status.
- /api/frames?n=
- The most recent frames. The count is clamped to 1..1000 and defaults to 200.
- /api/traffic?n=
- Recent throughput samples, clamped the same way.
- /api/protocols
- A summary of the protocol plugins in the running session.
- /api/languages
- The interface languages available on this machine.
- /api/lang/<locale>
- The language pack for the dashboard itself.
3. When it is useful
The dashboard is for watching a machine you can reach with a browser, and for grabbing the current state of a capture without touching the application window. It is not a remote monitoring product: if you need frames on another machine, forward them instead.

