Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET statisticsService/applications/performance

Retrieves the top N applications for a given group/site with given time period. If the group is Fabric, please mark isFabric=true else the parameter can be set to false or can be omitted in the URL. Here are the sample queries
  • /op/statisticsService/applications/performance?siteId=12121&startTime=4321&endTime=54321&isFabric=true -- Returns the Top 15 Applications for a given site id with start time and end time
  • /op/statisticsService/applications/performance?siteId=12121&range=54321&isFabric=true -- Returns the Top 15 Applications for a given site id with range

Since Product Version: 3.1

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/v2/op/statisticsService/applications/performance

Request Parameters

Attribute Source Description

attribute String

query

Optional

startTime Long

query

Required

Specifies the time to check the application performance from. (See 'range' for more details)

endTime Long

query

Required

Specifies the time to check the application performance to. (See 'range' for more details)

range Integer

query

Optional

trafficDir String

query

Optional

siteId String

query

Optional

siteId

pdsId String

query

Optional

dscp String

query

Optional

appId String

query

Optional

hostId String

query

Optional

deviceIp String

query

Optional

interfaceId String

query

Optional

interfaceIndex Integer

query

Optional

userName String

query

Optional

macAddr String

query

Optional

nAwareValue String

query

Optional

topN Integer

query

Required

The number of results to return.

sortOrder String

query

Optional

type Integer

query

Optional

ssid String

query

Optional

Use to filter on a specifc SSID.

domainId String

query

Optional

Use to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.

dataType String

query

Optional

nodeType String

query

Optional

controllerId Integer

query

Optional

apId Integer

query

Optional

viewType String

query

Optional

siteMapId String

query

Optional

isFabric Boolean

query

Optional

isFabric

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.

  • 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://10.56.58.149/webacs/api/v2/op/statisticsService/applications/performance?siteId="12121"&isFabric="true"

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v2/op/statisticsService/applications/performance?siteId=&amp;quot;12121&amp;quot;&amp;amp;isFabric=&amp;quot;true&amp;quot;
					" 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>
  <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://10.56.58.149/webacs/api/v2/op/statisticsService/applications/performance.json?siteId="12121"&isFabric="true"

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.56.58.149/webacs/api/v2/op/statisticsService/applications/performance?siteId=&quot;12121&quot;&amp;isFabric=&quot;true&quot;\n\t\t\t\t\t",
    "@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"
    }, {
      "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"
    } ]
  }
}