Skip to content

sites

Overview

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

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP

Tags

  • sites : Operations related to sites

Paths

Get operation for sites

GET /sites

Description

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

Responses

HTTP Code Description Schema
200 API Successfully executed sites_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • sites

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

data_coverage

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

Type : number

lan_to_wan_available_bandwidth

The LAN to WAN available Bandwidth

Type : number

lan_to_wan_bandwidth

The LAN to WAN Bandwidth for all packet types

Type : number

lan_to_wan_bulk_bandwidth_packets

The LAN to WAN bulk Bandwidth packets

Type : integer

lan_to_wan_bulk_packets

The LAN to WAN bulk packets

Type : integer

lan_to_wan_control_bandwidth

The LAN to WAN control Bandwidth

Type : number

lan_to_wan_control_packets

The LAN to WAN control packets

Type : integer

lan_to_wan_data

The LAN to WAN data sent

Type : number

lan_to_wan_interactive_bandwidth

The LAN to WAN interactive Bandwidth

Type : number

lan_to_wan_interactive_packets

The LAN to WAN interactive packets

Type : integer

lan_to_wan_packets

The LAN to WAN packets for all packet types

Type : integer

lan_to_wan_permitted_bandwidth

The LAN to WAN permitted Bandwidth

Type : number

lan_to_wan_realtime_bandwidth

The LAN to WAN real-time Bandwidth

Type : number

lan_to_wan_realtime_packets

The LAN to WAN real-time packets

Type : integer

region_name

The region name

Type : string

site_name

The site name

Type : string

sites_delete_success_schema

Name Schema
sites
optional
sites

sites

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

sites_post_success_schema

Name Schema
sites
optional
sites

sites

Name Description Schema
message
optional
Example : "resource added succesfully" string

sites_put_success_schema

Name Schema
sites
optional
sites

sites

Name Description Schema
message
optional
Example : "resource modified succesfully" string

sites_response_schema

Type : < sites_response_schema > array

sites_response_schema

Name Schema
data_coverage
optional
data_coverage
lan_to_wan_available_bandwidth
optional
lan_to_wan_available_bandwidth
lan_to_wan_bandwidth
optional
lan_to_wan_bandwidth
lan_to_wan_bulk_bandwidth_packets
optional
lan_to_wan_bulk_bandwidth_packets
lan_to_wan_bulk_packets
optional
lan_to_wan_bulk_packets
lan_to_wan_control_bandwidth
optional
lan_to_wan_control_bandwidth
lan_to_wan_control_packets
optional
lan_to_wan_control_packets
lan_to_wan_data
optional
lan_to_wan_data
lan_to_wan_interactive_bandwidth
optional
lan_to_wan_interactive_bandwidth
lan_to_wan_interactive_packets
optional
lan_to_wan_interactive_packets
lan_to_wan_packets
optional
lan_to_wan_packets
lan_to_wan_permitted_bandwidth
optional
lan_to_wan_permitted_bandwidth
lan_to_wan_realtime_bandwidth
optional
lan_to_wan_realtime_bandwidth
lan_to_wan_realtime_packets
optional
lan_to_wan_realtime_packets
region_name
optional
region_name
site_name
optional
site_name
total_available_bandwidth
optional
total_available_bandwidth
total_bandwidth
optional
total_bandwidth
total_data
optional
total_data
total_permitted_bandwidth
optional
total_permitted_bandwidth
wan_to_lan_available_bandwidth
optional
wan_to_lan_available_bandwidth
wan_to_lan_bandwidth
optional
wan_to_lan_bandwidth
wan_to_lan_data
optional
wan_to_lan_data
wan_to_lan_packets
optional
wan_to_lan_packets
wan_to_lan_permitted_bandwidth
optional
wan_to_lan_permitted_bandwidth

total_available_bandwidth

The total available bandwidth

Type : number

total_bandwidth

The total bandwidth

Type : number

total_data

The total data

Type : number

total_permitted_bandwidth

The total permitted bandwidth

Type : number

wan_to_lan_available_bandwidth

The WAN to LAN available Bandwidth

Type : number

wan_to_lan_bandwidth

The WAN to LAN Bandwidth for all packet types

Type : number

wan_to_lan_data

The WAN to LAN data received

Type : number

wan_to_lan_packets

The WAN to LAN packets for all packet types

Type : integer

wan_to_lan_permitted_bandwidth

The WAN to LAN Permitted Bandwidth

Type : number