Skip to main content
GET
Read budget burn-down

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Path Parameters

id
string
required

Query Parameters

granularity
string

Bucket granularity: day, week or month. Defaults based on period length.

Response

Burn-down series returned

budgetId
string
periodStart
string<date>
Example:

"2022-03-10"

periodEnd
string<date>
Example:

"2022-03-10"

granularity
string
buckets
object[]