How can we help?

Statistics - Device API (Beta)

Follow

The Auvik Statistics API allows you to view device, interface, and component statistics recorded by Auvik.

For details on a specific endpoint or cURL example, click the endpoint name listed below. API documentation opens in a new window.

There are four available endpoints that are part of devices in the Statistics API:

  • Read device statistics - Pull detailed statistics of devices in a site (and children if it’s a multi-site). The statistic, the statistic ID, and the list of  data points included in each statistic are listed in the table below. An entry is returned for each device. The device ID and tenant ID are in the relationships field.

Statistic

Stat ID

Data Point

Bandwidth

bandwidth

  • time
  • average total
  • average transmitted
  • average received

CPU utilization

cpuUtilization

  • time
  • average

Memory utilization

memoryUtilization

  • time
  • average

Storage utilization

storageUtilization

  • time
  • average

Unicast, multicast, and broadcast packet rates

packetUnicast

packetMulticast

packetBroadcast

  • time
  • average transmitted
  • average received

 

  • Read device availability statistics - Pull detailed availability statistics of devices in a site (and children if it’s a multi-site). The statistic, the statistic ID, and the list of data points included in each statistic are listed in the table below.

 

Statistic

Stat ID

Data Point

Uptime percentage

uptime

  • time
  • average time online

Outage

outage

  • time
  • totaltime offline

 

The device is listed in the relationships field. An entry is returned for each device. The device ID and tenant ID are in the relationships field.

  • Read interface statistics - Pull detailed statistics of interfaces in a site (and children if it’s a multi-site). The statistic, the statistic ID, and the list of data points included in each statistic are listed in the table below.

Statistic

Stat ID

Data Point

Bandwidth

bandwidth

  • time
  • average total
  • average transmitted
  • average received

Utilization

utilization

  • time
  • average total
  • average transmitted
  • average received

Packet loss rate

packetLoss

  • time
  • average transmitted loss
  • average received loss

Packet discard rate

packetDiscard

  • time
  • average transmitted discard 
  • average received discard

Unicast, multicast, broadcast packets

packetUnicast

packetMulticast

packetBroadcast

  • time
  • average transmitted
  • average received

 

An entry is returned for each interface. The interface ID, parent device ID, and tenant ID are in the relationships field.

  • Read component statistics - Pull detailed statistics of components in a site (and children if it’s a multi-site). The statistic, the statistic ID, and the list of data points included in each statistic are listed in the table below.

CPU

Statistic

Stat ID

Data Point

Capacity

capacity

  • time
  • average

Latency

latency

  • time
  • average

Readiness

readiness

  • time
  • average

Ready

ready

  • time
  • average

Swap wait

swap

  • time
  • average

CPU Core

Statistic

Stat ID

Data Point

Idle

idle

  • time
  • average

Utilization

utilization

  • time
  • average

Disk

Statistic

Stat ID

Data Point

Latency

latency

  • time
  • average read
  • average write

Queue latency

queueLatency

  • time
  • average read
  • average write

Rate

rate

  • time
  • average read
  • average write

Total latency

totalLatency

  • time
  • average read
  • average write

Fan

Statistic

Stat ID

Data Point

Speed

speed

  • time
  • average

Memory

Statistic

Stat ID

Data Point

Counters

counters

  • time
  • average allocated balloon
  • average consumed
  • average overhead
  • average reserved
  • average unreserved

Swap

swap

  • time
  • average in
  • average out

Swap rate

swapRate

  • time
  • average  in
  • average out

Temperature

temperature

  • time
  • average

Power Supply

Statistic

Stat ID

Data Point

Power

power

  • time
  • average voltage
  • average current
  • average power

System Board

Statistic

Stat ID

Data Point

Temperature

temperature

  • time
  • average

 

An entry is returned for each component. The component ID, parent device ID, and tenant ID are in the relationships field.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Auvik System Status

Check system status