sales_velocity

get forecast model config

The forecast model this organisation has selected and the configuration behind it: the model, the minimum sales and minimum weeks with sales a variant needs to be forecast, the base and pattern filters, the time windows, and any model-specific parameters under model_parameters.

The models the engine carries are moving_average, seasonal_naive, seasonal_tsb and lightgbm, and none of them is plan-gated. This read answers the configuration; changing it is not public.

Scope: sales:read.

get/api/v1/sales/velocity/forecast-config

Request

  • Base URL: https://api.app.tightly.io
  • URL: https://api.app.tightly.io/api/v1/sales/velocity/forecast-config
  • Auth: HTTP bearer

Headers

Tightly-Versionstring
Example:2026-11

The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.

Response

Current forecast model configuration

messageobject

severity, service and desc.

Changes

No recorded changes to this operation across all 1 revision of this API.