POST/api/v1/health/progress-audit

Progress Audit

Run a full progress integrity audit on a schedule.

Accepts a list of tasks and required audit options (including status_date). Returns a scored, graded report with per-anomaly details and prioritized remediation 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	Schedule tasks to audit (minimum 2).
tasks[].id	string	Required	Unique task identifier
options	object	Required	Configuration options for the progress audit check.
options.status_date	string	Required	Project data date (ISO 8601, e.g. '2025-06-30'). Required.
options.exclude_milestones	boolean	Optional	Exclude zero-duration tasks from progress checks.
options.max_examples	integer	Optional	Maximum anomaly examples to return per category.
options.include_recommendations	boolean	Optional	Include recommended remediation steps.

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_ProgressAuditData_"
}

Authentication

x-api-key header

Reference details

Operation ID: health_progress_audit
Section: health
Tags: health
Playground link: /playground?endpoint=%2Fapi%2Fv1%2Fhealth%2Fprogress-audit&method=post

Was this page helpful?

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

Topic: Progress Audit · Page: /docs/api-reference/health_progress_audit

Report an issue Suggest improvement

Terms Privacy Contact

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