foliot docs

API reference / Metrics / Read a workspace's usage for a month

Read a workspace's usage for a month

GET/workspaces/{workspaceId}/usage

Authenticate with a signed-in Foliot Console session.

What the workspace has used in one UTC calendar month, against its plan. Usage is counted in step attempts: a task attempt counts whether it succeeds or fails, each retry counts again, and a sleep or wait step counts once it finishes. Choice steps don’t count. The count is brought up to date shortly after the fact. Usage is kept for a limited number of months; an older month, or one in the future, is 400. Any member of the workspace (viewer and up). A workspace the caller is not in answers 404.

Path parameters

workspaceId
string (uuid)
REQUIRED

The workspace.

Query parameters

month
string
OPTIONAL

The UTC month, like 2026-10. This month when left out.

pattern ^[0-9]{4}-(0[1-9]|1[0-2])$

Responses

200 object OK
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
404 Error No such resource.
503 Error A dependency this route needs is unreachable.