---
title: "get_resource_usage"
description: "Get device resource usage over time, broken down by a configurable aggregation window."
sidebarTitle: "get_resource_usage"
lastUpdated: "2026-09-23"
---

> **For AI agents:** the complete documentation index is at [llms.txt](/llms.txt). Append `.md` to any page URL for its markdown version.

{/* GENERATED FILE: do not edit by hand. Regenerate with: node scripts/generate.mjs */}

Get device resource usage over time, broken down by a configurable aggregation window.

<Note>
  **Read-only · Calls external systems.** Safe to call: this tool does not modify data.
</Note>

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `aggregation` | string | Yes | Time aggregation bucket — '5m' recommended (the platform samples usage at 5m). Days are not supported: use '24h', never '1d'. |
| `aggregations` | string | No | Comma-separated duration windows for peak usage (e.g. '1h,24h' — never stat names like 'p95'). When provided, returns the peak usage per window instead of the standard time-series. |
| `detail` | boolean | No | Return null-elided JSON instead of summary (default: false) |
| `end` | string | Yes | End time in ISO 8601 format (e.g. '2024-01-02T00:00:00Z') |
| `operator` | string | Yes | Operator slug (= InfluxDB database name) |
| `resources` | string | Yes | Comma-separated device IDs (SIM: national_msisdn, web-agent: hostname, smartphone: UUID) |
| `start` | string | Yes | Start time in ISO 8601 format (e.g. '2024-01-01T00:00:00Z') |

## Example arguments

Illustrative arguments an agent supplies when calling this tool:

```json
{
  "operator": "string",
  "resources": "string",
  "aggregation": "string",
  "start": "string",
  "end": "string"
}
```

## Description

```text
Returns usage percentage per resource. Use list_resources to find device IDs (SIM: national_msisdn, web-agent: hostname, smartphone: UUID). Response keyed by resource name. Maximum recommended range: 90 days. Pass aggregations (comma-separated duration windows, e.g. '1h,24h') to get peak usage per window instead. Use instead of query_metrics for device utilization %; no InfluxQL needed.
```

## Related

- [`list_resources`](/mcp/tools/discovery/list_resources)
- [`query_metrics`](/mcp/tools/metrics/query_metrics)

## What's next?

<Columns cols={2}>
  <Card title="All MCP tools" icon="robot" href="/mcp/tools/overview">
    Browse the full tool reference by category.
  </Card>
  <Card title="Connect a client" icon="plug" href="/mcp/connect">
    Point Claude, Cursor, or Claude Code at the server.
  </Card>
</Columns>