Skip to content
POST/api/v1/health/logic-audit

Logic Audit

Run a full logic audit on a schedule.

Accepts a list of tasks and optional audit configuration options. Returns a scored, graded report with per-rule results and prioritized recommended fixes.

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)
tasks[].idstringRequiredUnique task identifier
optionsobjectOptionalOptions controlling Logic Audit analysis behavior.
options.max_examples_per_ruleintegerOptionalMaximum number of example task IDs returned per rule
options.include_network_statsbooleanOptionalInclude network topology statistics in response
options.include_forensic_pathsbooleanOptionalInclude full cycle/path details (may be large)
options.severity_thresholdstringOptionalMinimum severity level to include in findings
options.enable_recommendationsbooleanOptionalInclude recommended fixes in response
options.max_lag_daysnumberOptionalThreshold above which a lag is flagged as excessive (days)
options.relationship_type_thresholdsobjectOptionalConfigurable thresholds for relationship type distribution checks.
options.relationship_type_thresholds.fs_min_percentagenumberOptionalMinimum FS relationship percentage (default 80%)
options.relationship_type_thresholds.ss_max_percentagenumberOptionalMaximum SS relationship percentage (default 20%)
options.relationship_type_thresholds.ff_max_percentagenumberOptionalMaximum FF relationship percentage (default 20%)
options.relationship_type_thresholds.sf_max_percentagenumberOptionalMaximum SF relationship percentage (default 5%)

Response example

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

Response fields from OpenAPI contract

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

FieldTypeRequiredDescription
statusstringRequiredTop-level result status — always present in every response.
metadataobjectRequiredAudit trail and processing context — always present, never null.
metadata.task_countintegerRequiredNumber of tasks in the submitted schedule
metadata.endpointstringRequiredEndpoint path e.g. /api/v1/health/score

Schema

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

Authentication

  • x-api-key header

Reference details

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

Was this page helpful?

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

Topic: Logic Audit · Page: /docs/api-reference/health_logic_audit

TermsPrivacyContact

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