Skip to content
UltimateTeam.ai Docs

Scenario forecasts

GET
/api/v1/ml/forecast/scenarios
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/ml/forecast/scenarios?churn_rate=0.05&expansion_rate=0.1&horizons=1%2C3%2C6%2C12' \
  --header 'X-API-Key: <X-API-Key>'

Return best/expected/worst case scenario forecasts (admin/owner).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
churn_rate
Churn Rate
number
default: 0.05 <= 1
expansion_rate
Expansion Rate
number
default: 0.1 <= 1
horizons
Horizons
string
default: 1,3,6,12

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Get Forecast Scenarios Api V1 Ml Forecast Scenarios Get
Array<object>
ScenarioForecast

A scenario-based forecast (best/expected/worst case).

Attributes: scenario: Scenario type. forecasts: Forecast points for this scenario.

object
forecasts
required
Forecasts
Array<object>
RevenueForecastPoint

A single forecast data point for a future period.

Attributes: horizon_months: Months into the future. point_forecast: Central forecast value, must be > 0. ci_80: 80% confidence interval (lower, upper). ci_95: 95% confidence interval (lower, upper).

object
ci_80
required
Ci 80
array
>= 2 items <= 2 items
ci_95
required
Ci 95
array
>= 2 items <= 2 items
horizon_months
required
Horizon Months
integer
point_forecast
required
Point Forecast
number
> 0
scenario
required
Scenario
string
Allowed values: best expected worst
Example
[
  {
    "scenario": "best"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}