Poll a session's counters

GET /api/v1/admin/sessions/{id}/traffic prm_report_sessions

The lightweight counter snapshot behind a live traffic graph. It is a snapshot, not a rate — derive throughput from the difference between two polls and the difference between their sampled_at stamps.

update_time is when the NAS last reported, and sampled_at is when this server read it. They differ by up to one accounting interval, so two polls closer together than that interval return identical counters and a throughput of zero. That is the NAS being quiet, not the subscriber.

At a glance

Authentication: Staff token or session
Requires permission: prm_report_sessions Sessions report

Parameters

Parameter	Description
`id`required path · integer	Session id.

Request

curl -X GET "$BASE/api/v1/admin/sessions/{id}/traffic" \
  -H "Authorization: Bearer $XR_TOKEN"

Response 200 OK

{
  "data": {
    "id": 8821904,
    "session_time": 6900,
    "input_octets": 412000000,
    "output_octets": 5100000000,
    "update_time": "2026-09-20 09:06:02",
    "sampled_at": "2026-09-20 09:08:31"
  }
}

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us