get_resource_usage
Get device resource usage over time, broken down by a configurable aggregation window.
Get device resource usage over time, broken down by a configurable aggregation window.
Read-only · Calls external systems. Safe to call: this tool does not modify data.
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:
{
"operator": "string",
"resources": "string",
"aggregation": "string",
"start": "string",
"end": "string"
}Description
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
What's next?
Last updated on