Usage

List Workflow Usage

Returns credits spent per workflow sheet in the requested window, ranked by credits. Defaults to the current calendar month (UTC).

One row is one SHEET, not one workflow. A workflow with three sheets produces three rows sharing a workflow_id; sum them for the workflow total. Names match the Sheet schema — sheet_id is the row, workflow_id is the workflow it belongs to — so either can be passed straight to the workflow endpoints. is_main_sheet marks the workflow's own main sheet, whose sheet_id equals its workflow_id.

Capped at the 100 highest-spending sheets, and not paginated. Narrow the window to see further down.

Sources are reported separately by List Source Usage, not here.

Deleted workflows still appear with deleted: true — their runs really did spend credits in the window, so dropping them would under-report the total.

What the key can see. A key holding org:read (admin only) reports the whole organization. Any other key reports only the usage of the member who created it, so a sheet a colleague ran is absent.

codeStatusMeaning
LEDGER_CUTOVER_SPAN400The 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.

get/api/v1/usage/workflows

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Query parameters

fromstring

Inclusive start of the window, ISO 8601. Defaults to the first day of the current UTC month.

tostring

Exclusive end of the window, ISO 8601. Defaults to now.

Response

Default Response

statusinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.