API Reference
Log In
API Reference

Get budget portfolio for your account

get
https://api.revenium.ai/profitstream/v2/api/ai/alerts/budgets/portfolio

Retrieve a paginated portfolio view of all budget alerts in your account. Returns current progress, risk assessment, and window boundaries for each budget. Supports sorting by risk level or percent used.

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

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

boolean

Include trend data. Accepted but currently ignored.

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 20

The size of the page to be returned

sort
array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
string

ID of the team that owns this data. Optional. When set, only that team's budgets are returned and you must be able to read the team. When omitted, budgets on every team you can read in your account are returned.

int32

Optional. For a budget split per group, return only this many of its highest groups, highest first; groupCount still reports every group. 1 to 100. Omit for every group in query order.

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?