Get Workflow Usage
Returns one sheet's usage in the requested window: totals, a per-day trend, the actions that spent the credits, the most frequent errors, the 20 most recent runs, and per-member spend. Defaults to the current calendar month (UTC).
sheet_id is one SHEET's id, as returned by List Workflow Usage — the same id the workflow endpoints take as {sheet_id}. Passing a workflow's main-sheet id reports that sheet alone, not the workflow's other sheets; for a workflow total, sum its rows in List Workflow Usage. An id that is not a UUID is a 400, so a 404 always means the window holds no usage for that sheet.
A key restricted by allowed_workflow_ids may only drill into sheets of the workflows on its list; the list endpoints are not filtered that way, because a filtered list would not add up to its own totals.
What the key can see. A key holding org:read (admin only) reports every member's runs and populates per_user. Any other key reports only the runs of the member who created it and leaves per_user empty — so a sheet only a colleague ran returns 404 for that key, even though the sheet exists.
| code | Status | Meaning |
|---|---|---|
| LEDGER_CUTOVER_SPAN | 400 | The window crosses the date this organization's usage history moved stores. Request the window on one side of cutover_at. |
Requires the billing:read scope, which every role holds.
Request
- Base URLhttp://localhost:3009
- AuthHTTP bearer
Path parameters
Sheet ID, as returned by List Workflow Usage.
Query parameters
Inclusive start of the window, ISO 8601. Defaults to the first day of the current UTC month.
Exclusive end of the window, ISO 8601. Defaults to now.
Response
Default Response
Changes
No recorded changes to this operation across all 1 revision of this API.