Compliance dashboard

GET

/api/v1/compliance/dashboard

const url = 'https://api.ultimateteam.ai/api/v1/compliance/dashboard';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/compliance/dashboard \
  --header 'X-API-Key: <X-API-Key>'

Get the compliance posture summary for the tenant.

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

ComplianceDashboardEnvelope

Typed envelope for GET /dashboard.

object

data

required

ComplianceDashboardResponse

Response body for the compliance posture dashboard.

Attributes: active_alerts: Number of unacknowledged compliance alerts. upcoming_deadlines: Number of upcoming compliance deadlines. compliance_score: Overall compliance health score (0.0 - 100.0). categories_monitored: List of compliance categories being tracked. last_scan_date: Date of the most recent compliance scan, if any.

object

active_alerts

Active Alerts

Number of unacknowledged compliance alerts

integer

categories_monitored

Categories Monitored

Compliance categories being tracked

Array<string>

compliance_score

Compliance Score

Overall compliance health score (0-100)

number

0 <= 100

last_scan_date

Any of:

string
null

string format: date

upcoming_deadlines

Upcoming Deadlines

Number of upcoming compliance deadlines

integer

meta

required

ResponseMeta

Standard metadata attached to every API response.

object

request_id

required

Request Id

Unique request identifier

string

timestamp

required

Timestamp

Server timestamp of the response

string format: date-time

Example

{
  "data": {
    "active_alerts": 0,
    "compliance_score": 0,
    "upcoming_deadlines": 0
  }
}