Real-time monitoring API for tunnel bandwidth, TCP/UDP flow counts, packet drops, QoS shaper metrics, DSCP traffic, traffic class throughput, and interface bandwidth. Poll faster than every 3 seconds to avoid data gaps.
Common Use Cases:
- Build monitoring scripts that poll this API at configurable polling intervals
- Set up threshold-based alerting when packet drops exceed a defined threshold
- Track packet drop reason codes to identify specific network issues
- Monitor consecutive polling intervals to trigger alerts on persistent problems
- Create real-time dashboards with input parameters for EdgeConnect appliance metrics
Statistics Types:
| Type | name | filter | Description |
|---|---|---|---|
| tunnel | tunnel name, 'pass-through', or 'pass-through-unshaped' | not used | Returns per-tunnel tx/rx bytes, packets, and MOS scores for voice quality monitoring on overlay tunnels. |
| trafficType | '0' (optimized) or '3' (all-traffic) | not used | Returns aggregate bandwidth metrics across all optimized WAN-accelerated traffic or all traffic types combined. |
| dscp | '0' to '63' | required | Returns per-DSCP marking statistics to monitor QoS policy effectiveness and traffic classification by differentiated services code point. |
| trafficClass | '0' to '9' | required | Returns per-traffic-class throughput and packet counts to verify business intent traffic prioritization (class 0 is highest priority). |
| flow | '0' (TCP accel), '1' (TCP unaccel), '2' (non-TCP) | required (use '3' for all traffic) | Returns flow metrics: CREATED (flows created/sec), DELETED (flows deleted/sec), EXISTING (active flows), MAX (peak flows), plus byte/packet counters. |
| shaper | '0' to '9' (traffic class) | 0=outbound, 1=inbound | Returns QoS shaper queue depth, throughput, and shaped traffic metrics per traffic class for outbound or inbound direction. |
| drops | '' (empty string) | not used | Returns packet drop counters with reason codes to identify congestion, policy drops, or interface errors across the appliance. |
| interface | interface name (e.g., 'wan0') | required | Returns per-interface tx/rx bytes, packets, and error counters for physical and logical interfaces like wan0, lan0, or bvi0. |
Internal Drop Reason Codes (for type=drops):
The response keys are numeric reason codes (1-399). The complete code-to-description mapping is available in the x-drop-reason-codes extension on the RealTimeStatsResponse schema. Common categories include:
| Code Range | Category |
|---|---|
| 1-27 | LAN Rx/Tx errors (pass-through, packet length, tunnel, policy, checksum, queue full, buffer) |
| 28-57 | WAN Rx/Tx errors (tunnel, TPH, frame, queue full, checksum, flow state, SYN, buffer) |
| 58-77 | NAT, MTU, FEC, fragmentation errors |
| 78-88 | QoS drops (packet expired, tunnel down, bad flow, enqueue full - egress/ingress) |
| 89-101 | Packet/stream encode/decode/transform errors |
| 102-113 | FRED/FMST flow errors |
| 114-135 | IPsec and TCP errors |
| 136-140 | ZCI and kernel errors |
| 141-165 | License, control packets, NAT, overlay errors |
| 166-177 | Routing errors (no route, TTL, bridge, VXLAN, FEC framing) |
| 178-189 | QoS flow errors, security policy drops |
| 190-213 | ICMP, tunnel, bridge port, VRF errors |
| 214-260 | Local packet errors, hash collisions, multicast, WTX encap |
| 261-293 | Zone/VRF, IDS/IPS, segmentation, IPSec queue errors |
| 294-339 | ZCI internal errors, datapath overflow, FPOC fragment errors |
| 340-399 | FPOC cleanup, DDOS, VXLAN, tracert, OTO, IDS inline, bridge/switch errors |
To get the live code mapping from a specific appliance, call stats/drops/meta/info via the appliance proxy API.
Filter Values (string): '0'=optimized_traffic, '1'=pass_through_shaped, '2'=pass_through_unshaped, '3'=all_traffic
Response Format: {'metric': [[timestamp, value], ...]} with up to 3 data points.
Authorization: READ or READ_WRITE role.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||