API Reference

Update a budget

patch
https://api.doit.com/analytics/v1/budgets/

Updates the specified budget.

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

List of up to three thresholds defined as a percentage of the amount.

alerts
double

Budget period amount required: true(if usePrevSpend is false)

seasonalAmounts
array of doubles

List of seasonal amounts for recurring budgets with different amounts per period.

seasonalAmounts
collaborators
array of objects

List of permitted users to view/edit the report.

collaborators
string
enum

Currency code for monetary values.

string

Budget description

int64

Fixed budget end date required: true(if budget type is fixed)

double
Defaults to 0

Periodical growth percentage in recurring budget

string
enum
Defaults to cost

Budget metric

Allowed:
string

Budget Name.

string
enum
Allowed:
recipients
array of strings

List of emails to notify when reaching alert threshold.

recipients
recipientsSlackChannels
array of objects

List of Slack channels to notify when reaching alert threshold.

recipientsSlackChannels
scope
array of strings
deprecated

List of allocations that define the budget scope.

scope
scopes
array of objects

The filters selected define the scope of the budget.

scopes
int64

Budget start Date

string

Recurring budget interval can be one of: ["day", "week", "month", "quarter", "year"]

string

budget type can be one of: ["fixed", "recurring"]

boolean
Defaults to false

Use the last period's spend as the target amount for recurring budgets

Responses

Updated 4 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago