Skip to content

hdx

Overview

API to get reports for HDX (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 : Operations related to hdx

Paths

Get operation for hdx

GET /hdx

Description

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

Responses

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

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

hdx_delete_success_schema

Name Schema
hdx
optional
hdx

hdx

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

hdx_post_success_schema

Name Schema
hdx
optional
hdx

hdx

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

hdx_put_success_schema

Name Schema
hdx
optional
hdx

hdx

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

hdx_response_schema

Type : < hdx_response_schema > array

hdx_response_schema

Name Schema
qoe_index
optional
qoe_index
region_name
optional
region_name
sessions
optional
sessions
site_name
optional
site_name
tcp_flows
optional
tcp_flows
udp_flows
optional
udp_flows
users
optional
users

qoe_index

Quality of experience index

Type : integer

region_name

The region name

Type : string

sessions

Sessions

Type : integer

site_name

The site name

Type : string

tcp_flows

TCP Flows

Type : integer

udp_flows

UDP Flows

Type : integer

users

Users

Type : integer