hdx_summary¶
Overview¶
API to get reports for HDX Summary(bandwidth is in Kbps and data is in KB)
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP
Tags¶
- hdx_summary : Operations related to hdx_summary
Paths¶
Get operation for hdx_summary¶
GET /hdx_summary
Description¶
Use this operation to get a report for HDX Summary. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | hdx_summary_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¶
- hdx_summary
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
bytes_from_client¶
Bytes from client
Type : integer
bytes_from_server¶
Bytes from Server
Type : integer
client_ip¶
Client IP Address of the user
Type : string
hdx_channel_available¶
HDX channel availability
Type : enum (Yes, No)
hdx_summary_delete_success_schema¶
| Name | Schema |
|---|---|
| hdx_summary optional |
hdx_summary |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
hdx_summary_post_success_schema¶
| Name | Schema |
|---|---|
| hdx_summary optional |
hdx_summary |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
hdx_summary_put_success_schema¶
| Name | Schema |
|---|---|
| hdx_summary optional |
hdx_summary |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
hdx_summary_response_schema¶
Type : < hdx_summary_response_schema > array
| Name | Schema |
|---|---|
| bytes_from_client optional |
bytes_from_client |
| bytes_from_server optional |
bytes_from_server |
| client_ip optional |
client_ip |
| hdx_channel_available optional |
hdx_channel_available |
| msi_count optional |
msi_count |
| region_name optional |
region_name |
| ssi_count optional |
ssi_count |
| user_name optional |
user_name |
msi_count¶
Multi Stream ICA session count
Type : integer
region_name¶
The region name
Type : string
ssi_count¶
Single Stream ICA session count
Type : integer
user_name¶
Name of the user who initiated HDX sessions
Type : string