Get rule statistics for a component

GET

/api/components/{id}/stats

Returns rule counts by status and severity plus completion and lock percentages, computed as SQL aggregates. Access matches the component show rules: released components are readable by any authenticated user; unreleased ones require viewer permission.

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 component.

Type

integer

Required

Example38

Responses

Component rule statistics

Content-Type

application/json

{

  

"document_type": "stig",

  

"rules_by_status": {

  

  

"not_yet_determined": 50,

  

  

"applicable_configurable": 120,

  

  

"applicable_inherently_meets": 15,

  

  

"applicable_does_not_meet": 8,

  

  

"not_applicable": 10

  

},

  

"rules_by_severity": {

  

  

"high": 20,

  

  

"medium": 173,

  

  

"low": 10

  

},

  

"rule_count": 203,

  

"completion_pct": 75.4,

  

"lock_pct": 12.3

}

GET

/api/components/{id}/stats

Playground

Server

Authorization

tokenAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI