Skip to content
UltimateTeam.ai Docs

Revenue forecast

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

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

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
horizons
Horizons
string
default: 1,3,6,12

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
RevenueForecastResult

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
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
generated_at
required
Generated At
string format: date-time
historical_mrr
required
Historical Mrr
Array<number>
mape_1m
required
Any of:
number
Examplegenerated
{
  "forecasts": [
    {
      "ci_80": [
        "example"
      ],
      "ci_95": [
        "example"
      ],
      "horizon_months": 1,
      "point_forecast": 1
    }
  ],
  "generated_at": "2026-04-15T12:00:00Z",
  "historical_mrr": [
    1
  ],
  "mape_1m": 1
}

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"
    }
  ]
}