POST/api/v1/health/schedule-risk-index

Schedule Risk Index

Compute composite Schedule Risk Index across five sub-metrics.

Accepts a schedule with optional baseline dates, actuals, and resource fields. Sub-metrics are activated automatically based on available data (sub_metrics="auto"). Returns composite score, per-sub-metric breakdown, top risk drivers, and actionable recommendations.

Try in Playground

Request example

json

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

Request fields from OpenAPI contract

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	No description in OpenAPI contract.
tasks[].id	string	Required	Unique task identifier
status_date	string \| null	Optional	Project data date (ISO 8601, e.g. '2026-03-17'). When omitted, Progress Integrity Risk is skipped and Baseline Drift Risk runs in degraded mode. Float Risk and Logic Risk remain fully active.
options	object	Optional	Options for POST /api/v1/forensics/schedule-risk-index.
options.sub_metrics	string \| array<string>	Optional	No description in OpenAPI contract.
options.include_risk_drivers	boolean	Optional	No description in OpenAPI contract.
options.include_recommendations	boolean	Optional	No description in OpenAPI contract.
options.include_sub_metric_details	boolean	Optional	No description in OpenAPI contract.
options.exclude_task_types	array<string>	Optional	No description in OpenAPI contract.
options.baseline_weight_override	unknown \| null	Optional	No description in OpenAPI contract.
options.near_critical_float_threshold	number	Optional	No description in OpenAPI contract.
options.fields	array<string> \| null	Optional	No description in OpenAPI contract.

Response example

json

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

Response fields from OpenAPI contract

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

Schema

json-schema

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

Authentication

x-api-key header

Reference details

Operation ID: health_schedule_risk_index
Section: health
Tags: health
Playground link: /playground?endpoint=%2Fapi%2Fv1%2Fhealth%2Fschedule-risk-index&method=post

Was this page helpful?

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

Topic: Schedule Risk Index · Page: /docs/api-reference/health_schedule_risk_index

Report an issue Suggest improvement

Terms Privacy Contact

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