Retrieve workspace compliance statistics

curl --request GET \ --url 'https://api.openlayer.com/v1/workspaces/3fa85f64-5717-4562-b3fc-2c963f66afa6/rule-stats?frameworkId=9f1b3c2d-4e5a-4f60-8a71-2b3c4d5e6f70' \ --header 'Authorization: Bearer <token>'

{ "rules": { "total": 1, "byType": { "platform": 1, "evidence": 1 }, "byScope": { "project": 1, "workspace": 1 } }, "ruleResults": { "total": 1, "totalPassing": 1, "totalFailing": 1, "totalSkipped": 1, "totalRunning": 1, "totalError": 1, "totalPending": 1, "totalDueSoon": 1, "byRuleType": { "platform": { "total": 1, "totalPassing": 1, "totalFailing": 1, "totalSkipped": 1, "totalRunning": 1, "totalError": 1, "totalPending": 1, "totalDueSoon": 1 }, "evidence": { "total": 1, "totalPassing": 1, "totalFailing": 1, "totalSkipped": 1, "totalRunning": 1, "totalError": 1, "totalPending": 1, "totalDueSoon": 1 } }, "byRuleScope": { "project": { "total": 1, "totalPassing": 1, "totalFailing": 1, "totalSkipped": 1, "totalRunning": 1, "totalError": 1, "totalPending": 1, "totalDueSoon": 1 }, "workspace": { "total": 1, "totalPassing": 1, "totalFailing": 1, "totalSkipped": 1, "totalRunning": 1, "totalError": 1, "totalPending": 1, "totalDueSoon": 1 } } } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

workspaceId

string<uuid>

required

The workspace id.

Query Parameters

frameworkId

string<uuid>

Only include items belonging to this framework.

projectId

string<uuid>

Only include items that apply to this project.

Response

Status OK.

rules

object

required

Counts of the rules themselves, after any filters in the request.

Show child attributes

ruleResults

object

required

Counts of rule results, after any filters in the request, with breakdowns by the type and scope of the rule each result belongs to.

Show child attributes

Reference

SDKs

CLI

REST API

Retrieve workspace compliance statistics

Authorizations

Path Parameters

Query Parameters

Response