Read near-real-time throughput
GET
/api/v1/admin/sessions/{id}/live-traffic
prm_users_live_traffic
Returns bits per second when the session's NAS has SNMP management credentials with an interface selector configured, by polling the device twice about a second apart. Without them it degrades to the accounting counters.
Check the source field before trusting the numbers. source "snmp" is a real measurement; source "interim" means there were no SNMP credentials, the device was unreachable, or the sampler is not wired — the counters are the last accounting values and bps is 0, and your client has to derive the rate from successive polls itself.
At a glance
- Authentication
- Staff token or session
- Requires permission
-
prm_users_live_trafficLive traffic / disconnect
Parameters
| Parameter | Description |
|---|---|
idrequired
path · integer
|
Session id. |