Skip to main content
GET
Get one compliance framework report

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

framework_key
string
required

Query Parameters

month
string

Render one recorded month (YYYY-MM) instead of the live evaluation.

Response

The scored control-by-control compliance report with the month-over-month trend.

framework
object
required
period
string
required
generated_at
string<date-time>
required
score
number
required
satisfied_controls
integer
required
at_risk_controls
integer
required
failing_controls
integer
required
manual_controls
integer
required
categories
object[]
required
trend
object[]
required
available_months
string[]
required