Create a budget

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

Creats a new budget

Body Params

alerts

array of objects

List of up to three thresholds defined as percentage of amount

alerts

amount

double

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

collaborators

array of objects

List of permitted users to view/edit the report

collaborators

currency

string

description

string

Budget description

endPeriod

int64

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

growthPerPeriod

double

Defaults to 0

Periodical growth percentage in recurring budget

metric

string

Defaults to cost

Budget metric - currently fixed to "cost"

name

string

Budget Name

public

string

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

List of attributions that defines that budget scope

scope

startPeriod

int64

Budget start Date

timeInterval

string

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

type

string

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

usePrevSpend

boolean

Defaults to false

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

Responses

Language

Credentials


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api.doit.com/analytics/v1/budgets \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "growthPerPeriod": 0,
8
  "metric": "cost",
9
  "usePrevSpend": false
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created - New budget created.

400Bad Request - The server cannot process the request, often due to malformed request.

401Unauthorized - Invalid API key.

403Forbidden - The client is not authorized to perform the request.

404Not Found - The requested resource does not exist.