API: cockpit

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

`GET /api/v1/contracts/{guid}/cockpit`

Get Cockpit

Live cockpit snapshot for a SalesContract (empty contract → all zeros).

Auth: Authorization: Bearer <token> required

Parameter	In	Required	Type	Description
`guid`	path	yes	`integer`

Responses:

Code	Meaning	Body
`200`	Successful Response	`CockpitResponse`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Get Heatmap

Generate per-step distribution from the SC’s in-flight generate run_steps.

Auth: Authorization: Bearer <token> required

Parameter	In	Required	Type	Description
`guid`	path	yes	`integer`

Responses:

Code	Meaning	Body
`200`	Successful Response	`object`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Get Published Articles

Published articles (live URL set) for a contract — title, link, word count.

Auth: Authorization: Bearer <token> required

Parameter	In	Required	Type	Description
`guid`	path	yes	`integer`

Responses:

Code	Meaning	Body
`200`	Successful Response	`array of PublishedArticle`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Get Timeline

24h per-pipeline Gantt strip from the SC’s last-24h pipeline_run rows.

Auth: Authorization: Bearer <token> required

Parameter	In	Required	Type	Description
`guid`	path	yes	`integer`
`window`	query	no	`string`

Responses:

Code	Meaning	Body
`200`	Successful Response	`object`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`