Budgets

Create a budget

Create a new budget

post/analytics/v1/budgets

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/analytics/v1/budgets
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Request body

amountnumber double

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

seasonalAmountsnumber[]

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

currency'USD' | 'ILS' | 'EUR' | 'AUD' | 'CAD' | 'GBP' | 'DKK' | 'NOK' | 'SEK' | 'BRL' | 'SGD' | 'MXN' | 'CHF' | 'MYR' | 'TWD' | 'EGP' | 'ZAR' | 'JPY' | 'IDR' | 'AED' | 'THB' | 'COP'

Currency code for monetary values.

descriptionstring

Budget description

endPeriodinteger

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

growthPerPeriodnumber double

Periodical growth percentage in recurring budget

metric'cost' | 'amortized_cost'

Budget metric

namestring

Budget Name.

public'owner' | 'editor' | 'viewer'
recipientsstring[]

List of emails to notify when reaching alert threshold.

scopestring[]

List of allocations that define the budget scope.

startPeriodinteger

Budget start Date

timeIntervalstring

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

typestring

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

usePrevSpendboolean

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

Example request

{
  "scopes": [
    {
      "id": "cloud_provider",
      "type": "fixed",
      "inverse": false,
      "values": [
        "google-cloud"
      ]
    }
  ]
}

Response

Created - New budget created.

amountnumber double

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

seasonalAmountsnumber[]

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

createTimeinteger

Creation time (in UNIX timestamp).

currency'USD' | 'ILS' | 'EUR' | 'AUD' | 'CAD' | 'GBP' | 'DKK' | 'NOK' | 'SEK' | 'BRL' | 'SGD' | 'MXN' | 'CHF' | 'MYR' | 'TWD' | 'EGP' | 'ZAR' | 'JPY' | 'IDR' | 'AED' | 'THB' | 'COP' required

Currency code for monetary values.

currentUtilizationnumber double
descriptionstring

Budget description.

endPeriodinteger

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

forecastedUtilizationnumber double
growthPerPeriodnumber double

Periodical growth percentage in recurring budgets.

idstring

budget ID, identifying the report in:path

metricstring

Budget metric - currently fixed to "cost"

namestring required

Budget Name

public'owner' | 'editor' | 'viewer'

Public sharing access level for the budget.

recipientsstring[]

List of emails to notify when reaching alert threshold.

scopestring[]

List of allocations that defines the budget scope.

startPeriodinteger required

Budget start date (in UNIX timestamp).

timeIntervalstring required

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

typestring required

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

updateTimeinteger

Update time (in UNIX timestamp).

usePrevSpendboolean

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

Example response

{
  "scopes": [
    {
      "id": "cloud_provider",
      "type": "fixed",
      "inverse": false,
      "values": [
        "google-cloud"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.