Get one compliance framework report

GET /org/security/compliance/frameworks/{framework_key}/report

Get one compliance framework report

Python

import requests

url = "https://platform.ankra.app/org/security/compliance/frameworks/{framework_key}/report"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "framework": {
    "key": "<string>",
    "title": "<string>",
    "short_title": "<string>",
    "version": "<string>",
    "description": "<string>"
  },
  "period": "<string>",
  "generated_at": "2023-11-07T05:31:56Z",
  "score": 123,
  "satisfied_controls": 123,
  "at_risk_controls": 123,
  "failing_controls": 123,
  "manual_controls": 123,
  "categories": [
    {
      "key": "<string>",
      "title": "<string>",
      "score": 123,
      "satisfied": 123,
      "at_risk": 123,
      "failing": 123,
      "manual": 123,
      "controls": [
        {
          "id": "<string>",
          "title": "<string>",
          "description": "<string>",
          "status": "satisfied",
          "checks": [
            {
              "key": "<string>",
              "title": "<string>",
              "passed": true,
              "evidence": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "trend": [
    {
      "month": "<string>",
      "score": 123,
      "captured_at": "2023-11-07T05:31:56Z"
    }
  ],
  "available_months": [
    "<string>"
  ]
}

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

200

application/json

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

framework · object · required

Show child attributes

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

Show child attributes

trend · object[] · required

Show child attributes

available_months · string[] · required