Retrieves the application statistics as a list of pairs: application name and statistic value. The statistic value can be a rate(bytes/second) or volume(bytes). To choose a statistic type you should use the parameter "dataType". The default type is volume. Here are the sample queries:
- /op/statisticsService/application/appVolume -- return top 15 application volumes in the past 1 hour
- /op/statisticsService/application/appVolume?siteId=1234
- /op/statisticsService/application/appVolume?deviceIp=192.168.1.1
- /op/statisticsService/application/appVolume?deviceIp=192.168.1.1&interfaceIndex=2
- /op/statisticsService/application/appVolume?dataType=rate
Since Product Version: 1.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/statisticsService/application/appVolume
Request Parameters
range
Integer
|
query
|
Optional
Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1 week), 336(2 week), 720 (1 month). The default ivalue s 1 which is the last 1 hour
|
startTime
Long
|
query
|
Optional
Specifies the time to start from. (See 'range' for more details)
|
endTime
Long
|
query
|
Optional
Specifies the time to check to. (See 'range' for more details)
|
trafficDirection
String
|
query
|
Optional
Traffic directions. The value could be All, In, Out. The defaul is All
|
siteId
Integer
|
query
|
Optional
Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.
|
clientIp
String
|
query
|
Optional
Client IP address
|
deviceIp
String
|
query
|
Optional
Device Ip address
|
interfaceIndex
Integer
|
query
|
Optional
To filter by interfaceIndex, the deviceIp needs to be provided
|
topN
Integer
|
query
|
Optional
The default value is 15
|
sortOrder
String
|
query
|
Optional
Values could be DESC/ASC, The default value is DESC
|
networkAwareType
String
|
query
|
Optional
Values could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned
|
dataType
String
|
query
|
Optional
Values could be rate(bytes/second) or volume(bytes), The default value is volume
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.56.58.149/webacs/api/v1/op/statisticsService/application/appVolume
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/statisticsService/application/appVolume" rootUrl="https://10.56.58.149/webacs/api/v1/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v1/op/statisticsService/application/appVolume.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/statisticsService\/application\/appVolume",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
"statisticsDTO" : {
"childStatistics" : "",
"statisticEntries" : {
"statisticEntry" : [{
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
},
{
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
}]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/statisticsService/application/appVolume
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
range
Integer
|
query
|
Optional
Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1 week), 336(2 week), 720 (1 month). The default ivalue s 1 which is the last 1 hour
|
startTime
Long
|
query
|
Optional
Specifies the time to start from. (See 'range' for more details)
|
endTime
Long
|
query
|
Optional
Specifies the time to check to. (See 'range' for more details)
|
trafficDirection
String
|
query
|
Optional
Traffic directions. The value could be All, In, Out. The defaul is All
|
siteId
Integer
|
query
|
Optional
Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.
|
clientIp
String
|
query
|
Optional
Client IP address
|
deviceIp
String
|
query
|
Optional
Device Ip address
|
interfaceIndex
Integer
|
query
|
Optional
To filter by interfaceIndex, the deviceIp needs to be provided
|
topN
Integer
|
query
|
Optional
The default value is 15
|
sortOrder
String
|
query
|
Optional
Values could be DESC/ASC, The default value is DESC
|
networkAwareType
String
|
query
|
Optional
Values could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned
|
dataType
String
|
query
|
Optional
Values could be rate(bytes/second) or volume(bytes), The default value is volume
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.56.58.149/webacs/api/v2/op/statisticsService/application/appVolume
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v2/op/statisticsService/application/appVolume" rootUrl="https://10.56.58.149/webacs/api/v2/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v2/op/statisticsService/application/appVolume.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v2/op/statisticsService/application/appVolume",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v2/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/statisticsService/application/appVolume
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
range
Integer
|
query
|
Optional
Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1 week), 336(2 week), 720 (1 month). The default ivalue s 1 which is the last 1 hour
|
startTime
Long
|
query
|
Optional
Specifies the time to start from. (See 'range' for more details)
|
endTime
Long
|
query
|
Optional
Specifies the time to check to. (See 'range' for more details)
|
trafficDirection
String
|
query
|
Optional
Traffic directions. The value could be All, In, Out. The defaul is All
|
siteId
Integer
|
query
|
Optional
Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.
|
clientIp
String
|
query
|
Optional
Client IP address
|
deviceIp
String
|
query
|
Optional
Device Ip address
|
interfaceIndex
Integer
|
query
|
Optional
To filter by interfaceIndex, the deviceIp needs to be provided
|
topN
Integer
|
query
|
Optional
The default value is 15
|
sortOrder
String
|
query
|
Optional
Values could be DESC/ASC, The default value is DESC
|
networkAwareType
String
|
query
|
Optional
Values could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned
|
dataType
String
|
query
|
Optional
Values could be rate(bytes/second) or volume(bytes), The default value is volume
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.56.58.149/webacs/api/v3/op/statisticsService/application/appVolume
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v3/op/statisticsService/application/appVolume" rootUrl="https://10.56.58.149/webacs/api/v3/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v3/op/statisticsService/application/appVolume.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v3/op/statisticsService/application/appVolume",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v3/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/statisticsService/application/appVolume
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
range
Integer
|
query
|
Optional
Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1 week), 336(2 week), 720 (1 month). The default ivalue s 1 which is the last 1 hour
|
startTime
Long
|
query
|
Optional
Specifies the time to start from. (See 'range' for more details)
|
endTime
Long
|
query
|
Optional
Specifies the time to check to. (See 'range' for more details)
|
trafficDirection
String
|
query
|
Optional
Traffic directions. The value could be All, In, Out. The defaul is All
|
siteId
Integer
|
query
|
Optional
Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.
|
clientIp
String
|
query
|
Optional
Client IP address
|
deviceIp
String
|
query
|
Optional
Device Ip address
|
interfaceIndex
Integer
|
query
|
Optional
To filter by interfaceIndex, the deviceIp needs to be provided
|
topN
Integer
|
query
|
Optional
The default value is 15
|
sortOrder
String
|
query
|
Optional
Values could be DESC/ASC, The default value is DESC
|
networkAwareType
String
|
query
|
Optional
Values could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned
|
dataType
String
|
query
|
Optional
Values could be rate(bytes/second) or volume(bytes), The default value is volume
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://10.56.58.149/webacs/api/v4/op/statisticsService/application/appVolume
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v4/op/statisticsService/application/appVolume" rootUrl="https://10.56.58.149/webacs/api/v4/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v4/op/statisticsService/application/appVolume.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v4/op/statisticsService/application/appVolume",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v4/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
} ]
}
}