Tenant.public.forecasts.generate

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

item_customer_group_idintegerOptional

item_namestring · max: 255Optional

item_idintegerOptional

customer_group_namestring · max: 255Optional

customer_group_idintegerOptional

scopestring · enumOptionalPossible values:

forecast_periodsinteger · min: 1Optional

algorithmstring · enumOptionalPossible values:

missing_imputationstring · enumOptionalPossible values:

forecast_constraintstring · enumOptionalPossible values:

history_startstring · date-timeOptional

history_endstring · date-timeOptional

dry_runbooleanOptional

Responses

200Success

application/json

messageconst: Dry run completed. Forecast request validated successfully.Required

dataarray · min: 1 · max: 1Required

metaany ofRequired

or

stringOptional

linksstringRequired

202Success

application/json

401

Unauthenticated

application/json

422

Validation error

application/json

500Error

application/problem+json

503Error

application/problem+json

post/forecasts/generate

POST /your-tenant/api/v1/forecasts/generate HTTP/1.1
Host: plan.claret.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "item_customer_group_id": 1,
  "item_name": "text",
  "item_id": 1,
  "customer_group_name": "text",
  "customer_group_id": 1,
  "scope": "all",
  "forecast_periods": 1,
  "algorithm": "auto",
  "missing_imputation": "auto",
  "forecast_constraint": "auto",
  "history_start": "2026-01-01T00:00:00.000Z",
  "history_end": "2026-01-01T00:00:00.000Z",
  "dry_run": true
}

{
  "message": "text",
  "data": [],
  "meta": [],
  "links": "text"
}