top_sites¶
Overview¶
API to get reports for Top 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¶
- top_sites : Operations related to top_sites
Paths¶
Get operation for top_sites¶
GET /top_sites
Description¶
Use this operation to get a report for Top sites. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | top_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¶
- top_sites
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
incoming_traffic¶
Incoming traffic
Type : number
outgoing_traffic¶
Outgoing traffic
Type : number
region_name¶
The region name
Type : string
site_name¶
The site name
Type : string
top_sites_delete_success_schema¶
| Name | Schema |
|---|---|
| top_sites optional |
top_sites |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
top_sites_post_success_schema¶
| Name | Schema |
|---|---|
| top_sites optional |
top_sites |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
top_sites_put_success_schema¶
| Name | Schema |
|---|---|
| top_sites optional |
top_sites |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
top_sites_response_schema¶
Type : < top_sites_response_schema > array
| Name | Schema |
|---|---|
| incoming_traffic optional |
incoming_traffic |
| outgoing_traffic optional |
outgoing_traffic |
| region_name optional |
region_name |
| site_name optional |
site_name |
| total_traffic optional |
total_traffic |
total_traffic¶
Total traffic
Type : number