Statistics - Device API – Auvik Support

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
Read device availability statistics
Read interface statistics
Read component statistics

Before using the Statistics API, please read Statistics - API Requested Time Ranges.

Read Device Statistics

Read device statistics pulls detailed statistics of devices in a site (and children if it’s a multi-site). The statistic type, statistic ID, and a list of data points included with 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 (unix minutes) average transmitted (bits per second) average received (bits per second) average total (bits per second)
CPU utilization	cpuUtilization	time (unix minutes) average (percent)
Memory utilization	memoryUtilization	time (unix minutes) average (percent)
Storage utilization	storageUtilization	time (unix minutes) average (percent)
Unicast, multicast, and broadcast packet rates	packetUnicast packetMulticast packetBroadcast	time (unix minutes) average transmitted (packets per second) average received (packets per second)

Read device availability statistics

Read device availability statistics pulls detailed availability statistics of devices in a site (and children if it’s a multi-site). The statistic type, the statistic ID, and a list of data points included within each statistic are listed in the table below. 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.

Statistic	Stat ID	Data Point
Uptime percentage	uptime	time (unix minutes) average time online (percent)
Outage	outage	time (unix minutes) total time offline (seconds)

Read interface statistics

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

Statistic	Stat ID	Data Point
Bandwidth	bandwidth	time (unix minutes) average transmitted (bits per second) average received (bits per second) average total (bits per second)
Utilization	utilization	time (unix minutes) average total (percent) average transmitted (percent) average received (percent)
Packet loss rate	packetLoss	time (unix minutes) average total (packets per second) average transmitted loss (packets per second) average received loss (packets per second)
Packet discard rate	packetDiscard	time (unix minutes) average total (packets per second) average transmitted discard (packets per second) average received discard (packets per second)
Unicast, multicast, broadcast packets	packetUnicast packetMulticast packetBroadcast	time (unix minutes) average transmitted (packets per second) average received (packets per second)

Read component statistics

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

CPU

Statistic	Stat ID	Data Point
Capacity	capacity	time (unix minutes) Average (megahertz)
Latency	latency	time (unix minutes) average (percent)
Readiness	readiness	time (unix minutes) average (percent)
Ready	ready	time (unix minutes) average (milliseconds)
Swap wait	swap	time (unix minutes) average (milliseconds)

CPU Core

Statistic	Stat ID	Data Point
Idle	idle	time (unix minutes) average (milliseconds)
Utilization	utilization	time (unix minutes) average (percent)

Disk

Statistic	Stat ID	Data Point
Latency	latency	time (unix minutes) average read (milliseconds) average write (milliseconds)
Queue latency	queueLatency	time (unix minutes) average read (milliseconds) average write (milliseconds)
Rate	rate	time (unix minutes) average read (kilobytes per second) average write (kilobytes per second)
Total latency	totalLatency	time (unix minutes) average read (milliseconds) average write (milliseconds)

Fan

Statistic	Stat ID	Data Point
Speed	speed	time (unix minutes) average (rpm)

Memory

Statistic	Stat ID	Data Point
Counters	counters	time (unix minutes) average allocated balloon (megabytes) average consumed (megabytes) average overhead (megabytes) average reserved (megabytes) average unreserved (megabytes)
Swap	swap	time (unix minutes) average in (megabytes) average out (megabytes)
Swap rate	swapRate	time (unix minutes) average in (kilobytes per second) average out (kilobytes per second)
Temperature	temperature	time (unix minutes) average (celsius)

Power Supply

Statistic	Stat ID	Data Point
Power	power	time (unix minutes) average voltage (volts) average current (amps) average power (watts)

System Board

Statistic	Stat ID	Data Point
Temperature	temperature	time (unix minutes) average (celsius)

How can we help?

Statistics - Device API

Read Device Statistics

Read device availability statistics

Read interface statistics

Read component statistics

CPU

CPU Core

Disk

Fan

Memory

Power Supply

System Board

Auvik System Status

Need help?

How can we help?

Read Device Statistics

Read device availability statistics

Read interface statistics

Read component statistics

CPU

CPU Core

Disk

Fan

Memory

Power Supply

System Board

Auvik System Status

Need help?

Related articles