Skip to content

Revenue forecast

GET
/api/v1/ml/forecast

Return revenue forecasts at the requested horizons (admin/owner).

Forecasts the whole customer base’s MRR (no tenant filter), so this is admin/owner only — consistent with the cohort and per-tenant analytics endpoints.

Authorizations

Parameters

Query Parameters

horizons
string
default: 1,3,6,12

Responses

200

Successful Response

Complete revenue forecast output.

Attributes: forecasts: List of forecast points at different horizons. historical_mrr: Recent historical MRR values for context. mape_1m: Mean absolute percentage error for 1-month forecasts. generated_at: When this forecast was generated.

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
generated_at
required
string format: date-time
historical_mrr
required
Array<number>
mape_1m
required
Any of:
number

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string