Scenario forecasts

GET

/api/v1/ml/forecast/scenarios

• Production
• Local development

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

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

churn_rate

number

default: 0.05 <= 1

expansion_rate

number

default: 0.1 <= 1

horizons

string

default: 1,3,6,12

Responses

200

Successful Response

Array<object>

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

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

object

forecasts

required

Array<object>

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

array

>= 2 items <= 2 items

ci_95

required

array

>= 2 items <= 2 items

horizon_months

required

integer

point_forecast

required

number

> 0

scenario

required

string

Allowed values: best expected worst

422

Validation Error

object

detail

Array<object>

object

ctx

object

input

loc

required

Array

msg

required

string

type

required

string