Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET statisticsService/application/topNTraffics

Retrieves the top N clients or server traffic statistics of an application or all applications. Here are the sample queries
  • /op/statisticsService/application/topNTraffics -- return the top 15 client traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?nodeType=server -- return the top 15 server traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?networkAwareType=2 -- return the top 15 client wired traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?appId=1234 -- return the top 15 client traffics of the application with id 1234 in the past 1 hour
  • /op/statisticsService/application/topNTraffics?appId=1234,5678 -- return the top 15 client traffics of of the application with id 1234 and 5678 in the past 1 hour

Since Product Version: 1.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/op/statisticsService/application/topNTraffics

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

range Integer

query

OptionalSpecifies 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

OptionalSpecifies the time to start from. (See 'range' for more details)

endTime Long

query

OptionalSpecifies the time to check to. (See 'range' for more details)

trafficDirection String

query

OptionalTraffic directions. The value could be All,In,Out. The default is All

siteId String

query

OptionalUse to filter on a specific site by ID. If not specified then statistics for all sites will be returned.

dataSourceId String

query

OptionalUse to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.

deviceIp String

query

OptionalDevice Ip address

interfaceId String

query

Optional

interfaceIndex Integer

query

OptionalTo filter by interfaceIndex, the deviceIp needs to be provided

sortOrder String

query

OptionalValues could be DESC/ASC, The default value is DESC

appId String

query

OptionalThe comma separated application IDs. Use to filter on a specific application or a list of applications. If not specified then statistics for all applications will be returned.

topN Integer

query

OptionalThe default value is 15

clientIp String

query

OptionalClient Ip address

networkAwareType String

query

OptionalValues could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned

dataType String

query

OptionalValues could be rate(bytes/second) or volume(bytes), The default value is volume

nodeType String

query

OptionalValues could be client or server. The default value is client

Response Parameters

Attribute Description

childStatistics Arrow image StatisticsDTO[]

The set of nested StatisticsDTO objects.

statisticEntry Arrow image 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.

statisticsName StatisticsOperationTypeEnum

The Statistics operation type.

Allowed values:

  • DEVICE_TOPN_CPU_UTILIZATION
  • DEVICE_TOPN_MEMORY_UTILIZATION
  • DEVICE_TOPN_TEMPERATURE
  • DEVICE_AVAILABILITY
  • DEVICE_AVAILABILITY_SUMMARY
  • DEVICE_CPU_UTILIZATION_TREND
  • DEVICE_MEMORY_UTILIZATION_TREND
  • DEVICE_HEALTH_INFO
  • DEVICE_REACHABILITY_STATUS
  • DEVICE_PORT_SUMMARY
  • DEVICE_AVAILABILITY_MESSAGE
  • DEVICE_DOWN_MESSAGE
  • DEVICE_CPU_UTILIZATION_SUMMARY
  • INTERFACE_AVAILABILITY
  • INTERFACE_DETAILS
  • INTERFACE_OUT_ERRORS
  • INTERFACE_DISCARDS
  • INTERFACE_UTILIZATION
  • INTERFACE_TOPN_UTILIZATION
  • INTERFACE_TOPN_ERRORS
  • INTERFACE_TOPN_WAN_UTILIZATION
  • INTERFACE_UTILIZATION_SUMMARY
  • INTERFACE_AVAILABILITY_SUMMARY
  • INTERFACE_STATUS_SUMMARY
  • INTERFACE_AVAILABILITY_MESSAGE
  • INTERFACE_DOWN_MESSAGE
  • INTERFACE_TOPN_WAN_ISSUES
  • INTERFACE_CLASSMAP_QOS
  • APPLICATION_TOPN_WORST_HOSTS
  • APPLICATION_TOPN_WORST_SITES
  • APPLICATION_TOPN_HOSTS
  • APPLICATION_TOPN_APP_PERFORMANCE
  • APPLICATION_TOPN_TRAFFIC_ANALYSIS
  • APPLICATION_NUMBER_OF_USERS
  • SYSTEM_INFO
  • SYSTEM_HEALTH
  • APPLICATION_VOLUME
  • APPLICATION_ART_ANALYSIS
  • APPLICATION_TOPN_TRAFFICS
  • APPLICATION_TOPN_WITH_SITES

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://localhost/webacs/api/v4/op/statisticsService/application/topNTraffics

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/statisticsService/application/topNTraffics" rootUrl="https://localhost/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>
  <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_MEMORY_UTILIZATION</statisticsName>
  </statisticsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v4/op/statisticsService/application/topNTraffics.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v4/op/statisticsService/application/topNTraffics",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/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"
    }, {
      "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_MEMORY_UTILIZATION"
    } ]
  }
}