POST/api/v1/analysis/resources

Resource Analysis

Run a time-phased resource analysis on a schedule.

Accepts a schedule payload (tasks), optional resource availability declarations, and analysis options. Returns demand profiles per resource, over-allocation periods, leveling candidates, and a composite risk score.

Try in Playground

GAOAACE

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
tasks[].id	string	Required	Unique task identifier
status_date	string \| null	Optional	Schedule status date (ISO 8601 YYYY-MM-DD). When omitted, today's date is used as the resource loading window anchor.
resource_availability	array<unknown> \| null	Optional	Optional declared resource capacities
options	object	Optional	Options controlling resource analysis behaviour.
options.period_size_days	integer	Optional	Histogram bucket size in days
options.include_histogram_data	boolean	Optional	Include demand histogram per resource
options.include_leveling_candidates	boolean	Optional	Include leveling candidate tasks
options.include_critical_path_resources	boolean	Optional	Include CP resource section
options.include_resource_curves	boolean	Optional	Include cumulative resource curves
options.over_allocation_threshold	number	Optional	Multiplier of declared capacity (or 1.0/day default) that triggers over-allocation
options.exclude_task_types	array<string>	Optional	Task types to exclude from analysis (e.g. 'loe', 'summary')
options.fields	array<string> \| null	Optional	Response fields to include (sparse fieldset)

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

Authentication

Starter tier or higher
x-api-key header

Reference details

Operation ID: analysis_resources
Section: Analysis
Tags: Analysis
Playground link: /playground?endpoint=/api/v1/analysis/resources&method=post

Was this page helpful?

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

Topic: Resource Analysis · Page: /docs/api-reference/analysis_resources

Report an issue Suggest improvement

Terms Privacy Contact

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