Skip to main content
GET
/
api
/
compliance
/
summary
Get Compliance Summary
curl --request GET \
  --url https://api.example.com/api/compliance/summary \
  --header 'Authorization: Bearer <token>'
{
  "generated_at": "2023-11-07T05:31:56Z",
  "kpis": {
    "total_datasets": 0,
    "total_scans": 0,
    "active_scans": 0,
    "failed_scans": 0,
    "total_reports": 0,
    "critical_changes": 0
  },
  "activity_stats": {
    "by_event_type": {},
    "by_actor": {},
    "by_scan_status": {}
  },
  "datasets": [
    {
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "dataset_type": "<string>",
      "status": "<string>",
      "severity": "<string>",
      "vulnerabilities": 0,
      "scan_count": 0,
      "completed_scan_count": 0,
      "failed_scan_count": 0,
      "report_count": 0,
      "critical_issue_count": 0,
      "source_provider": "<string>",
      "source_ref": "<string>",
      "repo_url": "<string>",
      "import_provider": "<string>",
      "upload_source": "<string>",
      "last_scan_at": "2023-11-07T05:31:56Z",
      "last_scan_actor": "<string>",
      "last_activity_at": "2023-11-07T05:31:56Z",
      "project_names": [
        "<string>"
      ]
    }
  ],
  "activity": [
    {
      "id": "<string>",
      "event_type": "<string>",
      "summary": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "category": "activity",
      "actor": "<string>",
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "scan_id": "<string>",
      "scan_type": "<string>",
      "scan_status": "<string>",
      "severity": "low",
      "critical": false,
      "details": {}
    }
  ],
  "critical_changes": [
    {
      "id": "<string>",
      "category": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "scan_id": "<string>",
      "actor": "<string>",
      "reason": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Query Parameters

dataset_ids
string[] | null

Optional dataset UUIDs to scope the summary to a subset of datasets.

time_start
string<date-time> | null

Optional ISO timestamp marking the beginning of the reporting window.

time_end
string<date-time> | null

Optional ISO timestamp marking the end of the reporting window.

activity_limit
integer
default:200

Maximum number of activity events returned in the response.

Required range: 1 <= x <= 2000
critical_limit
integer
default:100

Maximum number of critical changes returned in the response.

Required range: 1 <= x <= 1000

Cookies

antidote_session
string | null

Response

Successful Response

generated_at
string<date-time>
required
kpis
ComplianceKpis · object
required
activity_stats
ComplianceActivityStats · object
required
datasets
ComplianceDatasetStat · object[]
activity
ComplianceActivityEvent · object[]
critical_changes
ComplianceCriticalChange · object[]