API Reference
Log In
API Reference

Get Budget Progress for AI Anomaly

get
https://api.revenium.ai/profitstream/v2/api/ai/alerts//budget/progress

Retrieve budget progress tracking for a CUMULATIVE_USAGE budget alert. Returns current value, remaining budget, percent used, and ahead/behind vs linear expectation. Optionally takes the budget's spend in 'spend', read over the window get_budget_spend_windows returned for the same 'now'; a budget that does not accept supplied spend ignores it and is computed as usual. Isotope uses this to serve the budget page from the ClickHouse copy.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The alert ID, a short string ID such as jR2kmLs, from the id field of GET /v2/api/sources/ai/anomaly. The numeric anomalyId in the response is not accepted.

Query Params
string

Optional ISO-8601 timestamp for progress calculation. Defaults to current time if not provided.

boolean

Include trend data. Accepted but currently ignored.

number

Optional. The budget's spend, read over the window get_budget_spend_windows returned for the same 'now'. Percent used, risk and pacing are computed from it. Ignored by a budget that does not accept supplied spend (split per group, filtered, or provider-billed), which is computed as usual.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
*/*

Updated 6 months ago

Did this page help you?