Zwall
Talk to an Engineer
Talk to an Engineer
Documentation
Docs Home › API › Traffic

Traffic

API: traffic views

SharedStatus: SUPPORTED as Manager-stored traffic views, not a PPS productAudience: Manager administrator

Admin: AdminAuth() + RoleAuth("admin").

No published packets-per-second SLA. Virtual-interface traffic: Virtualization. Dashboard widget: Dashboard.

GET /api/v1/traffic/realtime

GET /api/v1/traffic/history

GET /api/v1/traffic/summary

GET /api/v1/traffic/timeseries

GET /api/v1/traffic/stats

GET /api/v1/traffic/daily

GET /api/v1/traffic/data-stats

Purpose. Traffic widgets for the console (realtime snapshot, history, summary, timeseries, stats, daily, data-stats).

Authentication. Admin.

Parameters. Query windows may exist on individual handlers (hours, limit, interface name). API_SCHEMA_DOCUMENTATION_BLOCKED for the exact query set — TrafficHandler uses ad-hoc c.Query + gin.H buckets.

Request. Empty.

Example request.

curl -sS https://manager.example.com:8443/api/v1/traffic/summary \
  -H "Authorization: Bearer TOKEN"

Response (200). JSON object/array of counters. API_SCHEMA_DOCUMENTATION_BLOCKED — handler ambiguity: TrafficHandler builds gin.H / []map[string]interface{} rather than a stable exported DTO.

Errors. Known: 400 invalid query numbers; 500 repository failures ({"error":"..."}).

Edition. SHARED.

Security. Admin-only. Not a public telemetry API.

GET /api/v1/metrics/packet_rate

Purpose. Packet-rate widget (MetricsHandler.GetPacketRate).

Authentication. Admin.

Audience. Treat as Agent-facing where the handler requires Agent JWT.

Response. API_SCHEMA_DOCUMENTATION_BLOCKED — gin.H around SystemNetworkStats / interface stats. Do not publish as a certified PPS number.

Edition. SHARED implementation.