Unifi icon

Unifi

Interact with Unifi API

Device → List Device Stats

AI-generated

Summary

Retrieve network device statistics for a specific device on a given UniFi site.

Inputs

  • siteId (required) — The identifier of the UniFi site to query, found in the "name" field from "List All Devices" operation.
  • macAddress (required) — The MAC address of the specific device to retrieve statistics for.
  • splitIntoItems — Whether to split each device's stats into separate items (true) or return the raw response as a single item (false). Defaults to true.

Output shape

a list of JSON items, each representing statistics about the specified device; or a single JSON response containing raw data if splitting is disabled.

If "Split Into Items" is true, the output is multiple items, each representing a device's stats. Otherwise, the raw API response is returned as one item. The operation requires valid credentials and a valid site and device MAC address to succeed. Errors include authentication failures and access permission issues.

Examples

Example 1: Retrieve stats for device with MAC address AA:BB:CC:DD:EE:FF on site with siteId 'default' and receive split items

Set siteId to 'default', macAddress to 'AA:BB:CC:DD:EE:FF', splitIntoItems to true (default).

Discussion