User Stats

GET /v1/stats/users/{uuid}

Aggregate stats for the requested user — tunnel/endpoint counts, cumulative and current-period byte/request counters, and the account's effective limits. Pass your own user uuid (from GET /v1/user).

Account scope: for non-admin callers the figures are the account aggregate for your active account (not your individual user), subject to your role's permissions. Use switch account to see stats for a different account. Admins fetching a specific user get that user's per-user view.

For per-billing-cycle usage (with limits and exceeded flags), use /account/usage. This endpoint focuses on raw cumulative numbers, not quota tracking.

Path parameters

uuid string (uuid) Req
Your user uuid (the uuid of GET /v1/user). Any other user's uuid is a 404.

Deprecated: the legacy integer id is still accepted in the path until the sunset, answered with Deprecation and Sunset headers. Use the uuid.

Response (200 OK)

user_uuid string (uuid)?
The user of a per-user view. Omitted for the account aggregate.
plan string
Plan slug in effect.
tunnel_count int
Total tunnels.
endpoint_count int
Total endpoints currently owned.
active_tunnels int
Tunnels with at least one active agent.
total_bytes_in, total_bytes_out int64
Cumulative (lifetime) bytes in/out.
total_requests int64
Cumulative (lifetime) request count.
period_bytes_in, period_bytes_out int64
Bytes in/out for the current billing period.
period_requests int64
Request count for the current billing period.
max_endpoints, max_tunnels, max_connections int
Effective plan limits. -1 means unlimited (0 means none).
bandwidth_limit, request_limit int64
Effective per-period bandwidth/request limits. -1 means unlimited (0 means none).
last_updated string (RFC 3339)
When these figures were last refreshed.

Deprecated: until the sunset this response also carries the legacy integer id and *_id fields. Don't use them; read uuid and the *_uuid fields.

Errors

400 Bad Request
An integer id after the sunset (integer_id_unsupported).
401 Unauthorized
Missing auth.
404 Not Found
The uuid isn't yours (or doesn't exist). Another user's uuid reads exactly like an unknown one.
Request
curl "https://api.ngris.com/v1/stats/users/019a52c2-ca1e-78ba-ab5c-50362cc29134" \ -H "X-API-KEY: <your_api_key>"
Python
from ngris import Ngris client = Ngris(api_key="<your_api_key>") stats = client._get_raw("/stats/users/019a52c2-ca1e-78ba-ab5c-50362cc29134") print(f"{stats['endpoint_count']} endpoints, {stats['total_requests']:,} requests")
Response — 200 OK (abridged)
{ "plan": "pro", "tunnel_count": 6, "endpoint_count": 4, "active_tunnels": 2, "total_bytes_in": 61728394, "total_bytes_out": 61728395, "total_requests": 99876, "period_bytes_in": 5242880, "period_bytes_out": 5242881, "period_requests": 8123, "last_updated": "2026-04-29T13:00:00Z" }
Was this helpful?
On this page
User Stats
Was this helpful?