API referenceCost forecasts
Calculate a cost forecast
POST
Projects the trailing daily average over a future period, up to 90 days. The result is an estimate.
header
X-Auth-Token<token>application/json- body
allow_partial?booleanWhen a region does not answer, forecast from the regions that did and list the rest in missing_regions, instead of failing the forecast.
filter?granularity*stringValue in
"daily""monthly"lookback_days?integerFormat
int64Range
1 <= value <= 90Default
7metric?"cost"Value in
"cost"time_period*OK
application/json- response
as_of*stringFormat
date-timeestimated*booleanforecast_results_by_time*array<>|nullhistory_period*missing_regions?array<string>|Regions left out of an allow_partial forecast because they did not answer.
model*stringregions?array<>|The regions the history covers and how far each one's data is complete.
total*curl -X POST "https://example.com/v1/cost_forecasts" \ -H "Content-Type: application/json" \ -d '{ "granularity": "daily", "time_period": { "end": "2019-08-24T14:15:22Z", "start": "2019-08-24T14:15:22Z" } }'{ "as_of": "2019-08-24T14:15:22Z", "estimated": true, "forecast_results_by_time": [ { "mean_value": "string", "time_period": { "end": "2019-08-24T14:15:22Z", "start": "2019-08-24T14:15:22Z" } } ], "history_period": { "end": "2019-08-24T14:15:22Z", "start": "2019-08-24T14:15:22Z" }, "missing_regions": [ "string" ], "model": "string", "regions": [ { "data_through": "2019-08-24T14:15:22Z", "name": "string" } ], "total": { "amount": "string", "unit": "string" }}