Skip to content

applications

Overview

API to get reports for Top Applications (bandwidth is in Kbps and data is in KB)

Version information

Version : v2

URI scheme

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

Tags

  • applications : Operations related to applications

Paths

Get operation for applications

GET /applications

Description

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

Responses

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

  • applications

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

aggregate_data

Aggregate data for application traffic

Type : number

aggregate_incoming_data

Aggregate Data for Incoming application traffi

Type : number

aggregate_outgoing_data

Aggregate Data for Outgoing application traffic

Type : number

application_name

The application name

Type : string

applications

Name Schema
operations
optional
operations

applications_delete_success_schema

Name Schema
applications
optional
applications

applications

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

applications_post_success_schema

Name Schema
applications
optional
applications

applications

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

applications_put_success_schema

Name Schema
applications
optional
applications

applications

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

applications_request_schema

Name Schema
applications
optional
applications

applications_response_schema

Type : < applications_response_schema > array

applications_response_schema

Name Schema
aggregate_data
optional
aggregate_data
aggregate_incoming_data
optional
aggregate_incoming_data
aggregate_outgoing_data
optional
aggregate_outgoing_data
application_name
optional
application_name
average_bandwidth
optional
average_bandwidth
average_incoming_bandwidth
optional
average_incoming_bandwidth
average_outgoing_bandwidth
optional
average_outgoing_bandwidth
operations
optional
operations
region_name
optional
region_name

average_bandwidth

Average bandwidth when the application is active

Type : string

average_incoming_bandwidth

Average bandwidth of incoming traffic when application is active

Type : string

average_outgoing_bandwidth

Average bandwidth of outgoing traffic when application is active

Type : string

operations

Type : string

region_name

Type : string