Skip to content

top_application_families

Overview

API to get reports for Top Application Families (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_application_families : Operations related to top_application_families

Paths

Get operation for top_application_families

GET /top_application_families

Description

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

Responses

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

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

application_family

The application family

Type : string

incoming_traffic

Incoming traffic

Type : number

outgoing_traffic

Outgoing traffic

Type : number

region_name

The region name

Type : string

top_application_families_delete_success_schema

Name Schema
top_application_families
optional
top_application_families

top_application_families

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

top_application_families_post_success_schema

Name Schema
top_application_families
optional
top_application_families

top_application_families

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

top_application_families_put_success_schema

Name Schema
top_application_families
optional
top_application_families

top_application_families

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

top_application_families_response_schema

Type : < top_application_families_response_schema > array

top_application_families_response_schema

Name Schema
application_family
optional
application_family
incoming_traffic
optional
incoming_traffic
outgoing_traffic
optional
outgoing_traffic
region_name
optional
region_name
total_traffic
optional
total_traffic

total_traffic

Total traffic

Type : number