Dynatrace Platform Subscription API - GET forecast

  • Reference

Gets a forecast of Dynatrace Platform Subscription usage by the end of the annual commitment period.

The request produces an application/json payload.

GET

https://api.dynatrace.com/sub/v2/accounts/{accountUuid}/subscriptions/forecast

Authentication

To execute this request, you need the Allow read access for usage and consumption resources (account-uac-read) scope assigned to your token. To learn how to obtain and use it, see OAuth clients.

Parameters

ParameterTypeDescriptionInRequired
accountUuidstring

The ID of the required account.

You can find the UUID on the Account Management > Identity & access management > OAuth clients page, during creation of an OAuth client.

pathrequired

Response

Response codes

CodeTypeDescription
200Forecast

Success. The response contains the forecast of the subscription's usage.

400-

Failed. The request was unacceptable, often due to missing a required parameter

401-

Failed. The bearer token is incorrect/expired or the requested account information does not match the bearer token

403-

Access denied

404-

Failed. The requested resource was not found

500-

Failed. Something went wrong in Account Management API

Response body objects

The Forecast object

ElementTypeDescription
forecastMediannumber

The median forecasted usage.

forecastLowernumber

The lower bound of forecasted usage.

forecastUppernumber

The upper bound of forecasted usage.

budgetnumber

The budget quota used in the forecast.

forecastBudgetPctnumber

The forecasted usage of the budget, in percent.

forecastBudgetDatestring

The date when the forecasted usage consumes all the budget quota.

forecastCreatedAtstring

The date when the forecast was created.

Response body JSON model

{
  "forecastMedian": 1,
  "forecastLower": 1,
  "forecastUpper": 1,
  "budget": 1,
  "forecastBudgetPct": 1,
  "forecastBudgetDate": "string",
  "forecastCreatedAt": "string"
}