v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB

AdHawk

Gets aggregated device health metrics for the account.

get/adhawk/devicemetrics

startDatestring date-time

Start date for the query (required)

endDatestring date-time

End date for the query (required)

deviceIdstring[]

Optional list of device IDs to filter by

interval'Minute' | 'Hour' | 'Day' | 'Week' | 'Month'

Time interval for aggregation (minute, hour, day, week, month)

limitinteger

Maximum number of results (default: 1000, max: 10000)

device_idstring nullable

The device ID

device_namestring nullable

The device name

period_startstring date-time

Start of the time period for these metrics

period_endstring date-time

End of the time period for these metrics

avg_cpu_usagenumber double nullable

Average CPU usage percentage during the period

max_cpu_usagenumber double nullable

Maximum CPU usage percentage during the period

avg_memory_usagenumber double nullable

Average memory usage percentage during the period

max_memory_usagenumber double nullable

Maximum memory usage percentage during the period

avg_disk_usagenumber double nullable

Average disk usage percentage during the period

total_tx_bytesinteger nullable

Total bytes transmitted during the period

total_rx_bytesinteger nullable

Total bytes received during the period

uptime_percentagenumber float nullable

Percentage of time the device was online (0-100)

ping_countinteger

Number of pings received during the period

alert_countinteger

Number of alerts generated during the period