Skip to content
POST/api/v1/health/progress-audit/async

Progress Audit (Async)

Submit progress audit as async job.

Request example

json
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.

FieldTypeRequiredDescription
tasksarray<unknown>RequiredSchedule tasks to audit (minimum 2).
tasks[].idstringRequiredUnique task identifier
optionsobjectRequiredConfiguration options for the progress audit check.
options.status_datestringRequiredProject data date (ISO 8601, e.g. '2025-06-30'). Required.
options.exclude_milestonesbooleanOptionalExclude zero-duration tasks from progress checks.
options.max_examplesintegerOptionalMaximum anomaly examples to return per category.
options.include_recommendationsbooleanOptionalInclude recommended remediation steps.

Response example

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

Schema

json-schema
{
  "$ref": "#/components/schemas/ProgressAuditRequest"
}

Authentication

  • x-api-key header

Reference details

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

Was this page helpful?

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

Topic: Progress Audit (Async) · Page: /docs/api-reference/health_progress_audit_async

TermsPrivacyContact

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