Skip to content

sites_stats

Overview

API to get sites information

Version information

Version : v2

URI scheme

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

Tags

  • sites_stats : Operations related to sites_stats

Paths

Get operation for sites_stats

GET /sites_stats

Description

Use this operation to get sites statistics.

Responses

HTTP Code Description Schema
200 API Successfully executed sites_stats_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_stats

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

lan_to_wan

LAN to WAN stats.

Type : < lan_to_wan > array

lan_to_wan

Name Description Schema
bytes_dropped
optional
read-only
Bytes dropped number
bytes_sent
optional
read-only
Bytes sent number
kbps_dropped
optional
read-only
Kilobytes dropped per second number
kbps_sent
optional
read-only
Kilobytes sent per second number
packets_dropped
optional
read-only
Packets dropped integer
packets_dropped_per_sec
optional
read-only
Packets dropped per second number
packets_sent
optional
read-only
Packets sent integer
packets_sent_per_sec
optional
read-only
Packets sent per second number
service
optional
read-only
Service name string

passthrough

Passthrough stats.

Type : < passthrough > array

passthrough

Name Description Schema
bytes_dropped
optional
read-only
Bytes dropped number
bytes_received
optional
read-only
Bytes received number
bytes_sent
optional
read-only
Bytes sent number
kbps_dropped
optional
read-only
Kilobytes dropped per second number
kbps_received
optional
read-only
Kilobytes received per second number
kbps_sent
optional
read-only
Kilobytes sent per second number
packets_dropped
optional
read-only
Packets dropped integer
packets_dropped_per_sec
optional
read-only
Packets dropped per second number
packets_received
optional
read-only
Packets received integer
packets_received_per_sec
optional
read-only
Packets received per second number
packets_sent
optional
read-only
Packets sent integer
packets_sent_per_sec
optional
read-only
Packets sent per second number

sites_stats_delete_success_schema

Name Schema
sites_stats
optional
sites_stats

sites_stats

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

sites_stats_post_success_schema

Name Schema
sites_stats
optional
sites_stats

sites_stats

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

sites_stats_put_success_schema

Name Schema
sites_stats
optional
sites_stats

sites_stats

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

sites_stats_response_schema

Type : < sites_stats_response_schema > array

sites_stats_response_schema

Name Schema
lan_to_wan
optional
lan_to_wan
passthrough
optional
passthrough
wan_to_lan
optional
wan_to_lan

wan_to_lan

WAN to LAN stats.

Type : < wan_to_lan > array

wan_to_lan

Name Description Schema
bytes_dropped
optional
read-only
Bytes dropped number
bytes_received
optional
read-only
Bytes received number
kbps_dropped
optional
read-only
Kilobytes dropped per second number
kbps_received
optional
read-only
Kilobytes received per second number
packets_dropped
optional
read-only
Packets dropped integer
packets_dropped_per_sec
optional
read-only
Packets dropped per second number
packets_received
optional
read-only
Packets received integer
packets_received_per_sec
optional
read-only
Packets received per second number
service
optional
read-only
Service name string