Retrieves the traffic analysis of an application.
Resource URL
/webacs/api/v1/op/statisticsService/application/trafficAnalysis
Request Parameters
Long
|
startTime
required
|
Specifies the time to check the application traffic analysis from. (See 'range' for more details)
|
Long
|
endTime
required
|
Specifies the time to check the application traffic analysis to. (See 'range' for more details)
|
Integer
|
range
required
|
Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters.
|
Integer
|
type
required
|
Modify details of data returned. Set to 1 for simple details for dashlets, or 3 to include detailed statistics (mean/min/max/1st,2nd dev/etc.)
|
Integer
|
appId
optional
|
Use to filter on a specific application by ID. Defaults to 0 which implies no filtering.
|
String
|
pdsId
optional
|
Used to filter on a specific PDS by ID. Expected to be non-zero.
|
String
|
hostId
optional
|
Use to filter on a specific host by ID. If specified must not be 0.
|
String
|
nwAwareValue
optional
|
Use to filter on a specific CONNECTIONTYPE.
|
String
|
ssidValue
optional
|
Use to filter on a specifc SSID.
|
Response Parameters
A common response format is used across all statistics services of the Prime Infrastructure API. Please refer to the
statistics response format section for details and samples.
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://172.19.31.161/webacs/api/v1/op/statisticsService/application/trafficAnalysis?range=1
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://172.19.31.161/webacs/api/v1/op/statisticsService/application/statisticsService/application/trafficAnalysis" requestUrl="https://172.19.31.161/webacs/api/v1/op/statisticsService/application/trafficAnalysis?range=1" responseType="operation">
<statisticsDTO>
<childStatistics>
<childStatistic>
<childStatistics>
<childStatistic>
<childStatistics>
<childStatistic>
<childStatistics>
<childStatistic>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</childStatistic>
</childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</childStatistic>
</childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</childStatistic>
</childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</childStatistic>
</childStatistics>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://172.19.31.161/webacs/api/v1/op/statisticsService/application/trafficAnalysis?range=1.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/op\/statisticsService\/application\/statisticsService\/application\/trafficAnalysis",
"@requestUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/op\/statisticsService\/application\/trafficAnalysis?range=1",
"@responseType" : "operation",
"statisticsDTO" : {
"childStatistics" : {
"childStatistic" : {
"childStatistics" : {
"childStatistic" : {
"childStatistics" : {
"childStatistic" : {
"childStatistics" : {
"childStatistic" : {
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
},
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
},
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
},
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
}
}