Lab

Build a lab status report for a project

Return a point-in-time lab operations report, rendered as Markdown.

Covers momentum over the trend window, utilization (whole lab, per site, per program, and against yesterday), channels released in the recent past, channels forecast to free up soon, the planned measurements queued next, plans that should already have started, equipment service — channels and whole cyclers out, calibration falling due, and booked visits — and healthy channels sitting idle. The response carries every section as structured data and the whole thing as a Markdown document in markdown, so a caller can convert it to PDF or paste it into a message without re-deriving anything.

This endpoint only builds the report; it does not deliver it anywhere.

get/projects/{project_id}/lab/report

Path parameters

project_idstring required

Query parameters

sectionsLabReportSection[] nullable

Sections to include. Repeat the parameter for several. Omit for the full report.

Sections to include. Repeat the parameter for several. Omit for the full report.

recently_stopped_hoursinteger

Lookback for stopped channels

Lookback for stopped channels

stopping_soon_hoursinteger

Forecast window for channels freeing up

Forecast window for channels freeing up

idle_thresholds_daysinteger[] nullable

Idle thresholds in days, e.g. 2 and 3. Channels past the lowest are listed; the rest become counts. Defaults to 2 and 3.

Idle thresholds in days, e.g. 2 and 3. Channels past the lowest are listed; the rest become counts. Defaults to 2 and 3.

queue_limitinteger

Maximum queued measurements to list

Maximum queued measurements to list

queue_horizon_daysinteger

How far ahead the queue looks

How far ahead the queue looks

service_horizon_daysinteger

How far ahead booked service is reported

How far ahead booked service is reported

trend_window_daysinteger

Length of the momentum trend window

Length of the momentum trend window

Response

Successful Response

project_idstring required

Project the report covers

project_namestring nullable

Project name

organization_namestring nullable

Organization the project belongs to

prepared_for_emailstring nullable

Email of the user the report was generated for

generated_atstring date-time required

Server time the report was generated (UTC)

markdownstring required

The full report rendered as Markdown

Changes

No recorded changes to this endpoint across all 1 revision of this API.