Get Client Compliance Health Metrics

get

https://api.scalepad.com/controlmap/v1/clients/{client_id}/health

Returns detailed compliance health metrics for a single MSP client.

This endpoint is optimized for retrieving the full health snapshot of a client,
including compliance score, risk score, frameworks, and work progress.

Use this endpoint instead of /clients/health when you need data for one client only.
All scoring fields reflect the most recently computed health values.
compliance_score.metric_history, risk_score.metric_history, each framework's metric_history, and each work-progress category's metric_history contain dated snapshots. If dates are omitted, the default history window is the previous 7 days.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

client_id

string

required

Unique identifier of the client

Accepts either the client UUID or the client's tenant_id.

Query Params

start_date

date

Inclusive start date for daily trend data. Must use yyyy-MM-dd.

end_date

date

Inclusive end date for daily trend data. Must use yyyy-MM-dd.

include_history

string

^(compliance_score|risk_score|frameworks|evidence|controls|action_items|assessments|documents|work_progress)(,(compliance_score|risk_score|frameworks|evidence|controls|action_items|assessments|documents|work_progress))*$

Comma-separated history sections to include. Defaults to compliance_score. Including work_progress returns history for all nested work-progress sections: evidence, controls, action_items, assessments, and documents. To retrieve only selected nested sections, omit work_progress and pass the individual values instead. Accepted values are compliance_score, risk_score, frameworks, evidence, controls, action_items, assessments, documents, and work_progress.

Responses

200OK — Client health returned successfully.

400Bad Request — Invalid input or business rule violation.

401Unauthorized - Authentication required

404Not Found — Client not found.

500Internal server error