Skip to main content

Query and get monitor metrics (v2.6)

POST 

/sdwan/monitor/v2.6/api/monitor/metrics

SD-WAN Northbound Statistics API for querying monitoring metrics.

This API allows you to query various network metrics like bandwidth usage, latency, packet loss, and application performance data.

Filter Requirements by Metric -

Different metrics have different filter requirements. See each metric's description for specific requirements. Common patterns:

Metric CategoryRequired FiltersNotes
BandwidthUsage, TrafficVolume, FlowCountsNoneAll filters optional
LQM metrics (Latency, PacketLoss, Jitter, Mos)site, path OR waninterfaceSingle values only
PathCapacitysite, path, directionCannot use waninterface
App metrics (AudioMos, VideoMos)site, app, directionSingle values only
ConcurrentFlowssiteOnly one filter can have multiple values

Cross-Field Dependencies -

  • path requires site to be present
  • waninterface requires site to be present
  • element requires site to be present
  • anynet_link requires waninterface to be present

Mutual Exclusions -

  • path and path_type cannot be used together
  • filter.direction and view.individual=direction cannot be used together

Case Sensitivity -

Metric names are case-sensitive. For example, use ApplicationHealthscore (lowercase 's'), not ApplicationHealthScore.

Request

Responses

Successful Operation