POST/api/v1/health/planning-horizon

Planning Horizon

Analyze work-readiness for upcoming tasks within horizon bands.

Accepts a current schedule with status date and optional schedule history. Returns per-band readiness scores, at-risk tasks, and recommendations.

Request example

json

{
  "tasks": [
    {
      "id": "T1",
      "duration_days": 5
    }
  ]
}

Required fields and the optional fields that change this call are listed here. The shared task model stays on the task schema guide.

This table is generated from the endpoint schema in openapi.json.

Field	Type	Required	Description
tasks	array<unknown>	Required	Schedule tasks.
tasks[].id	string	Required	Unique task identifier
status_date	string \| null	Optional	Current data date (ISO 8601, e.g. '2026-03-17'). When omitted, today's date is used as the planning horizon anchor.
schedule_history	array<object> \| null	Optional	No description in OpenAPI contract.
options	object	Optional	Options controlling planning horizon analysis.
options.horizon_bands	array<unknown>	Optional	No description in OpenAPI contract.
options.horizon_bands[].name	string	Optional	No description in OpenAPI contract.
options.horizon_bands[].days	integer	Optional	No description in OpenAPI contract.
options.readiness_dimensions	array<string>	Optional	No description in OpenAPI contract.
options.day_type	string	Optional	No description in OpenAPI contract.
options.include_risk_ranking	boolean	Optional	No description in OpenAPI contract.
options.include_recommendations	boolean	Optional	No description in OpenAPI contract.
options.min_float_days	integer	Optional	No description in OpenAPI contract.
options.max_forecast_drift_days	integer	Optional	No description in OpenAPI contract.

json

{
  "score": 92,
  "grade": "A"
}

This table is generated from the endpoint response schema in openapi.json.

Field	Type	Required	Description
status	string	Required	Top-level result status — always present in every response.
metadata	object	Required	Audit trail and processing context — always present, never null.
metadata.task_count	integer	Required	Number of tasks in the submitted schedule
metadata.endpoint	string	Required	Endpoint path e.g. /api/v1/health/score

json-schema

{
  "$ref": "#/components/schemas/BellatorResponse_PlanningHorizonData_"
}

Operation ID: health_planning_horizon
Section: health
Tags: health
Playground link: /playground?endpoint=%2Fapi%2Fv1%2Fhealth%2Fplanning-horizon&method=post

Was this page helpful?

Your feedback helps us improve docs, reference pages, and Playground flows.

Topic: Planning Horizon · Page: /docs/api-reference/health_planning_horizon

Schedule analysis guidance. Not legal advice. You remain responsible for contract and agency compliance.