v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB

Budgets

Retrieve a budget

Returns the current utilization and configuration of the specified budget.

get/analytics/v1/budgets/{id}

Path parameters

idstring required

Budget ID

Response

OK - Budget details returned.

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"
      ]
    }
  ]
}