Get rule statistics for a project
GET
/api/projects/{id}/stats
Returns rule statistics aggregated across every component in the project plus a per-component breakdown, computed from grouped SQL queries. Requires viewer permission on the project.
Authorizations
tokenAuth
Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.
Type
HTTP (token)
Parameters
Path Parameters
id*
Numeric ID of the project.
Type
Requiredinteger
Example
7Responses
Project rule statistics with per-component breakdown
application/json
JSON "aggregate": { "rules_by_status_by_type": { "stig": { "not_yet_determined": 51, "applicable_configurable": 121, "applicable_inherently_meets": 15, "applicable_does_not_meet": 8, "not_applicable": 10 }, "srg": { "not_yet_determined": 2, "applicable": 1, "not_applicable": 0 } }, "rules_by_severity": { "high": 21, "medium": 176, "low": 11 }, "rule_count": 208, "completion_pct": 74.5, "lock_pct": 12 }, "components": [ { "id": 38, "name": "RHEL 9 Hardened Baseline", "prefix": "RHEL-09", "document_type": "stig", "rule_count": 203, "completion_pct": 75.4, "lock_pct": 12.3 }, { "id": 41, "name": "Photon OS 5 Baseline", "prefix": "PHTN-50", "document_type": "srg", "rule_count": 5, "completion_pct": 40, "lock_pct": 0 } ]
{
}