Usage

Get Usage Overview

Returns usage for the requested window: totals, a per-day trend, and the top workflows, actions and members by credits spent. Defaults to the current calendar month (UTC).

What a run is. One run is one action call against one row. A run served from cache is counted in total_runs and cache_hits but costs no credits; cache_savings reports what those runs would have cost.

top_workflows lists workflow sheets only. Source spend counts toward summary — which is the whole organization's usage — and is attributed by List Source Usage.

What the key can see. A key holding org:read (admin only) reports the whole organization and populates top_users and summary.active_users. Any other key reports only the usage of the member who created it, leaves top_users empty, and omits active_users.

codeStatusMeaning
LEDGER_CUTOVER_SPAN400The window crosses the date this organization's usage history moved stores, and cannot be reported as one figure. Request the window on one side of cutover_at.

Requires the billing:read scope, which every role holds.

get/api/v1/usage/overview

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.