---
title: "Gets aggregated device health metrics for the account."
method: GET
path: "/adhawk/devicemetrics"
tags: ["AdHawk"]
---

# Gets aggregated device health metrics for the account.

`GET /adhawk/devicemetrics`

## Request

- Base URL: `https://api.reveldigital.com`
- URL: `https://api.reveldigital.com/adhawk/devicemetrics`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.reveldigital.com/connect/authorize`
    - Token URL: `https://id.reveldigital.com/connect/token` scopes: `webapi`
  - API key in header `X-RevelDigital-ApiKey`
  - API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/adhawk/devicemetrics/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `startDate` string, date-time
- `endDate` string, date-time
- `deviceId` string[]
- `interval` 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month'
- `limit` integer

## Response `200`

OK

- AdHawkDeviceMetrics[]
  - `device_id` string, nullable: The device ID
  - `device_name` string, nullable: The device name
  - `period_start` string, date-time: Start of the time period for these metrics
  - `period_end` string, date-time: End of the time period for these metrics
  - `avg_cpu_usage` number, double, nullable: Average CPU usage percentage during the period
  - `max_cpu_usage` number, double, nullable: Maximum CPU usage percentage during the period
  - `avg_memory_usage` number, double, nullable: Average memory usage percentage during the period
  - `max_memory_usage` number, double, nullable: Maximum memory usage percentage during the period
  - `avg_disk_usage` number, double, nullable: Average disk usage percentage during the period
  - `total_tx_bytes` integer, nullable: Total bytes transmitted during the period
  - `total_rx_bytes` integer, nullable: Total bytes received during the period
  - `uptime_percentage` number, float, nullable: Percentage of time the device was online (0-100)
  - `ping_count` integer: Number of pings received during the period
  - `alert_count` integer: Number of alerts generated during the period

---

[API](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api.md) - [All operations](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/revisions/39d5c8302822?raw)