Skip to content

sites

API to get reports for sites (bandwidth is in Kbps and data is in KB)

Read/write properties

Read only properties

wan_2_lan_data<Double>

The WAN to LAN data received.

lan_2_wan_data<Double>

The LAN to WAN data sent.

wan_2_lan_packets<Integer>

The WAN to LAN packets for all packet types.

lan_2_wan_control_packets<Integer>

The LAN to WAN control packets.

lan_2_wan_realtime_packets<Integer>

The LAN to WAN real-time packets.

lan_2_wan_available_bandwidth<Double>

The LAN to WAN available Bandwidth.

wan_2_lan_permitted_bandwidth<Double>

The WAN to LAN Permitted Bandwidth.

wan_2_lan_bandwidth<Double>

The WAN to LAN Bandwidth for all packet types.

lan_2_wan_bulk_bandwidth_packets<Integer>

The LAN to WAN bulk Bandwidth packets.

lan_2_wan_realtime_bandwidth<Double>

The LAN to WAN real-time Bandwidth.

lan_2_wan_interactive_packets<Integer>

The LAN to WAN interactive packets.

site_name<String>

The site name.

lan_2_wan_control_bandwidth<Double>

The LAN to WAN control Bandwidth.

lan_2_wan_bandwidth<Double>

The LAN to WAN Bandwidth for all packet types.

wan_2_lan_available_bandwidth<Double>

The WAN to LAN available Bandwidth.

total_permitted_bandwidth<Double>

The total permitted bandwidth.

region_name<String>

The region name.

lan_2_wan_permitted_bandwidth<Double>

The LAN to WAN permitted Bandwidth.

total_available_bandwidth<Double>

The total available bandwidth.

total_data<Double>

The total data.

total_bandwidth<Double>

The total bandwidth.

lan_2_wan_interactive_bandwidth<Double>

The LAN to WAN interactive Bandwidth.

lan_2_wan_bulk_packets<Integer>

The LAN to WAN bulk packets.

data_coverage<Double>

The amount in percent of the selected time for which there is data.

lan_2_wan_packets<Integer>

The LAN to WAN packets for all packet types.

Operations

get (all)

URL: http://<MGMT-IP>/sdwan_center/nitro/v1/reports/sites

Description: Use this operation to get a report for sites. The response payload also contains the meta_data block.

HTTP Method: GET

Response Payload: JSON

{"sites":[{
      "wan_2_lan_data":<Double_value>,
      "lan_2_wan_data":<Double_value>,
      "wan_2_lan_packets":<Integer_value>,
      "lan_2_wan_control_packets":<Integer_value>,
      "lan_2_wan_realtime_packets":<Integer_value>,
      "lan_2_wan_available_bandwidth":<Double_value>,
      "wan_2_lan_permitted_bandwidth":<Double_value>,
      "wan_2_lan_bandwidth":<Double_value>,
      "lan_2_wan_bulk_bandwidth_packets":<Integer_value>,
      "lan_2_wan_realtime_bandwidth":<Double_value>,
      "lan_2_wan_interactive_packets":<Integer_value>,
      "site_name":<String_value>,
      "lan_2_wan_control_bandwidth":<Double_value>,
      "lan_2_wan_bandwidth":<Double_value>,
      "wan_2_lan_available_bandwidth":<Double_value>,
      "total_permitted_bandwidth":<Double_value>,
      "region_name":<String_value>,
      "lan_2_wan_permitted_bandwidth":<Double_value>,
      "total_available_bandwidth":<Double_value>,
      "total_data":<Double_value>,
      "total_bandwidth":<Double_value>,
      "lan_2_wan_interactive_bandwidth":<Double_value>,
      "lan_2_wan_bulk_packets":<Integer_value>,
      "data_coverage":<Double_value>,
      "lan_2_wan_packets":<Integer_value>}]}
Was this article helpful?