Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

Statistics Response Structure

The Prime Infrastructure API uses a common response structure for all statistics services. This section presents some sample responses and details.

Statistics Response Structure

The Prime Infrastructure API offers a set of various statistics services around multiple aspects of the network and the system. To accommodate the different type of results, one single common format is used. The structure is as follow:

<mgmtResponse rootUrl="https://ncs-nbi-demo-1/webacs/api/v1/op" 
    requestUrl="https://ncs-nbi-demo-1/webacs/api/v1/op/statisticsService/application/topNHosts?range=1&topN=5" 
    responseType="operation">
	<statisticsDTO>
		<statisticEntries>
			<statisticEntry>
				<attributeName>value</attributeName>
				<displayName>Value</displayName>
				<entryValue>607</entryValue>
			</statisticEntry>
			<statisticEntry>
				<attributeName>label</attributeName>
				<displayName>Label</displayName>
				<entryValue>224.0.0.10</entryValue>
			</statisticEntry>
		</statisticEntries>
		<statisticsName>APPLICATION_TOPN_HOSTS</statisticsName>
	</statisticsDTO>
	...
</mgmtResponse>
		
  • Each value is wrapped as statisticsDTO element. There may be multiple statisticsDTO in a response.
  • The type of statistics is identified by the statisticsName element.
  • statisticsDTO contain a set of entries with the values relevant to the type of statistics.

More specifically, in the example above, where the statistics is pulling the Top 5 Hosts:

  • 5 statisticsDTO elements are returned ( = top 5)
  • Each DTO has 2 entries: the CPU utilization, and the device IP or MAC address.

The list of applicable statisticsName is as follows:

  • 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