Health scorecards API
13 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/scorecards/ |
List Scorecards Query: segment, active_only. |
POST |
/api/scorecards/ |
Create Scorecard Accepts a JSON body. |
POST |
/api/scorecards/accounts/{account_id}/measures/{measure_id} |
Set Manual Measure Accepts a JSON body. |
GET |
/api/scorecards/accounts/{account_id}/scorecard |
Get Account Scorecard State Query: scorecard_id. |
GET |
/api/scorecards/{scorecard_id} |
Get Scorecard |
PATCH |
/api/scorecards/{scorecard_id} |
Update Scorecard Accepts a JSON body. |
DELETE |
/api/scorecards/{scorecard_id} |
Delete Scorecard |
POST |
/api/scorecards/{scorecard_id}/groups |
Create Measure Group Accepts a JSON body. |
PATCH |
/api/scorecards/{scorecard_id}/groups/{group_id} |
Update Measure Group Accepts a JSON body. |
DELETE |
/api/scorecards/{scorecard_id}/groups/{group_id} |
Delete Measure Group |
POST |
/api/scorecards/{scorecard_id}/groups/{group_id}/measures |
Create Measure Accepts a JSON body. |
PATCH |
/api/scorecards/{scorecard_id}/groups/{group_id}/measures/{measure_id} |
Update Measure Accepts a JSON body. |
DELETE |
/api/scorecards/{scorecard_id}/groups/{group_id}/measures/{measure_id} |
Delete Measure |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.