get_effective_coverage
Retrieve effective coverage for a threat model, showing own and inherited credits and contributing controls. Understand compliance by seeing which controls cover each control objective.
Instructions
Effective coverage rollup with credited inheritance.
Read-only. 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 composed (own ⊕ inherited) 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 not available on the backend, coverage is
empty and flag_enabled: false.
Paginated: omitting page / page_size defaults to page=1, page_size=100 — a single call no longer returns every coverage row.
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 | |||