List live sessions

GET /api/v1/admin/sessions prm_report_sessions

Sessions with no stop time, paginated with the standard list parameters. A non-admin caller sees only sessions belonging to their own manager subtree, injected server-side.

user_id is null for a session this instance cannot tie to a subscriber row, such as an anonymous voucher or an orphan left by a NAS restart. status and usage are absent on those too. Do not assume every live session has an owner.

At a glance

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

Parameters

Parameter	Description
`q` query · string	Searches username, first and last name, framed IP, device MAC and NAS name.
`filter[nas_id]` query · integer	Sessions on one registered NAS.
`filter[kind]` query · enum	subscriber, guest, voucher or unknown.
`filter[has_ip]` query · boolean	Sessions that were assigned a framed IP.
`filter[duration_band]` query · string	Duration bucket. The value "stale" means no accounting update for longer than the tenant's idle window, which is the practical definition of a ghost session.
`filter[expired]` query · boolean	Sessions whose owner's subscription has run out but who are still connected.

Request

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

Response 200 OK

{
  "data": [
    {
      "id": 8821904,
      "acct_session_id": "81b0c4e2",
      "username": "ahmed",
      "user_id": 4711,
      "kind": "subscriber",
      "nas_ip": "10.20.0.1",
      "nas_id": 3,
      "nas_name": "cairo-edge-1",
      "vendor": "mikrotik",
      "framed_ip": "10.64.12.51",
      "calling_station_id": "AA:BB:CC:DD:EE:FF",
      "start_time": "2026-09-20 07:11:02",
      "update_time": "2026-09-20 09:06:02",
      "session_time": 6900,
      "input_octets": 412000000,
      "output_octets": 5100000000,
      "profile_name": "Home 20M",
      "usage": { "percent": 55.0, "dimension": "data" }
    }
  ],
  "meta": { "page": 1, "page_size": 50, "total": 318, "has_next": true }
}

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