v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB

Analytics - Financial

Get Revenue Forecast

Generate revenue or churn forecasts using statistical models (Moving Average, Linear Regression, ARIMA, SARIMA).

post/api/analytics/financial/forecast

Request body

account_idsstring[] required

Array of account prefixed IDs

metric'revenue' | 'churn_percentage' required

The metric to forecast

model'moving_average' | 'linear_regression' | 'arima' | 'sarima' required

The forecasting model to use

historical_daysinteger required

Number of historical days to analyze (30-730)

forecast_daysinteger required

Number of days to forecast (7-365)

Example request

{
  "account_ids": [
    "acc_abc123",
    "acc_def456"
  ],
  "metric": "revenue",
  "model": "linear_regression",
  "historical_days": 90,
  "forecast_days": 30
}

Response

metricstring

modelstring

Example response

{
  "metric": "revenue",
  "model": "linear_regression",
  "historical": [
    {
      "date": "2024-01-01",
      "value": 500
    }
  ],
  "forecast": [
    {
      "date": "2024-02-01",
      "value": 550
    }
  ]
}