get_effective_coverage
Retrieve effective coverage rollup with credited inheritance for a threat model, showing per control objective coverage status, own vs inherited credit, and contributing controls, paginated.
Instructions
Effective coverage rollup with credited inheritance.
Per effective CO: whether it is covered, how much credit comes from
controls owned by this model vs inherited from ancestors, and the
list of contributing controls (with the owning model id, origin tag,
verification status, and mitigation group). This is the surface that
drives the composition view's coverage / compliance numbers — it
reflects TREE_COMPOSITION_ENABLED math, not the per-model
coverage shown by get_verification_report.
Return shape::
{
model_id, flag_enabled,
coverage: [
{co_qid, is_covered, own_credit, inherited_credit,
contributing_controls: [{control_id, owner_model_id,
origin, is_verified, mitigation_group}, ...]},
...
],
total, page, page_size,
}When composition is disabled on the backend, coverage is empty
and flag_enabled: false.
Omitting page / page_size defaults to page=1, page_size=100 — the response is paginated and no longer returns
every coverage row in a single call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-indexed page number (default ``1``). | |
| origin | No | filter coverage rows by contributing-control origin — one of ``"own" | "cross" | "inherited"``. When omitted, rows with any origin mix are returned. | |
| model_id | Yes | ID of the threat model. | |
| page_size | No | coverage rows per page (default ``100``). | |
| server_version | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||