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

GET statisticsService/applications/performance

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

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 URL

/webacs/api/v2/op/statisticsService/applications/performance

Request Parameters

Type Attribute Name Source Description

String

attribute optional

query

Long

startTime required

query

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

Long

endTime required

query

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

Integer

range optional

query

String

trafficDir optional

query

String

siteId optional

query

siteId

String

pdsId optional

query

String

dscp optional

query

String

appId optional

query

String

hostId optional

query

String

deviceIp optional

query

String

interfaceId optional

query

Integer

interfaceIndex optional

query

String

userName optional

query

String

macAddr optional

query

String

nAwareValue optional

query

Integer

topN required

query

The number of results to return.

String

sortOrder optional

query

Integer

type optional

query

String

ssid optional

query

Use to filter on a specifc SSID.

String

domainId optional

query

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

String

dataType optional

query

String

nodeType optional

query

Integer

controllerId optional

query

Integer

apId optional

query

String

viewType optional

query

String

siteMapId optional

query

Boolean

isFabric optional

query

isFabric

Response Parameters

Type Attribute Name Description

StatisticsDTO[]

childStatistics

The set of nested StatisticsDTO objects.

StatisticsEntry[]

statisticEntry

The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.

StatisticsOperationTypeEnum

statisticsName

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

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

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

{
  "mgmtResponse" : {
    "@requestUrl" : "https://172.25.123.114/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://172.25.123.114/webacs/api/v1/op/",
    "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"
    } ]
  }
}