Metrics and telemetry ›
Get running over time
GET
/v1/metrics/runningHow many of your sandboxes were running, step by step.
RequestTypeScript
- import { Agental } from "agental-sdk";
- const agental = new Agental();
- const running = await agental.runningOverTime();
Answer200 OK · RunningOverTime
- {
- "since": string,
- "until": string,
- "stepSeconds": integer,
- "points": [{
- "at": string,
- "running": integer,
- }],
- }
How many of the caller's sandboxes were running at each step between two moments.
Query
sincestring | Count from this moment. 24 hours before until when omitted. e.g. "2026-10-13T16:00:00Z" |
untilstring | Count up to this moment. Now when omitted, and never later than now. |
stepSecondsinteger | Seconds between two points. When omitted, a step that gives about 288 points. e.g. 300 |
Headers
AuthorizationrequiredBearer key | An API key that may make this call. |
Returns
200 How many of the caller's sandboxes were running at each step between two moments. It is counted from the record of what ran, which is what is billed from, so it is there wherever sandboxes run, and a sandbox deleted since is still counted.
RunningOverTime4 fields
sincestring
untilstring
stepSecondsinteger
pointsobject[]2 fields
atstring
runninginteger
Errors and other answers
| 400 | since is not before until, the two are more than 366 days apart, or stepSeconds would give more than 1500 points. |
| 404 | Not found. |
Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.