Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET

GET statisticsService/application/worstNHosts

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

HTTP Methods

GET

Retrieves the worst N application hosts.

Resource URL

/webacs/api/v1/op/statisticsService/application/worstNHosts

Since : 1.2

Request Parameters

Type Attribute Name Description

Long

startTime required

Specifies the time to check the worst N hosts from. (See 'range' for more details)

Long

endTime required

Specifies the time to check the worst N hosts 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.

String

appId optional

Use to filter on a specific application by ID. Defaults to 0 which implies no filtering.

Integer

siteId optional

Use to filter on a specific site by ID. Defaults to 0 which implies no filtering.

String

domainId optional

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

String

pdsId optional

Used to filter on a specific PDS by ID. If non-zero siteId is expected to be non-zero.

String

attribute optional

The attribute on which to measure worst N performing applications. Possible Values: transTime, svrRespTime, networkDelay.

String

sortOrder optional

The sort order of the results (ASC/DESC). Defaults to DESC for worst hosts first.

Integer

topN required

The number of results to return.

String

nwAwareValue optional

Use to filter on a specific CONNECTIONTYPE.

String

ssidValue optional

Use to filter on a specifc SSID.

String

userId optional

Use to filter on a specifc USERID.

String

macAddr optional

Use to filter on a specifc MACADDR.

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://192.168.116.207/webacs/api/v1/op/statisticsService/application/worstNHosts?range=1&topN=5&attribute=networkDelay

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://192.168.116.207/webacs/api/v1/op/statisticsService/application/statisticsService/application/worstNHosts" requestUrl="https://192.168.116.207/webacs/api/v1/op/statisticsService/application/worstNHosts?range=1&amp;topN=5&amp;attribute=networkDelay
					" 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://192.168.116.207/webacs/api/v1/op/statisticsService/application/worstNHosts?range=1&topN=5&attribute=networkDelay .json

{
  "mgmtResponse" : {
    "@rootUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/statisticsService\/application\/statisticsService\/application\/worstNHosts",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/statisticsService\/application\/worstNHosts?range=1&topN=5&attribute=networkDelay\n\t\t\t\t\t",
    "@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"
    }
  }
}