This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Get the most recent Data Health Check report for each check configured on the given Dataset. Returns one report per check, representing the current health status of the dataset.
To get the list of checks configured on a Dataset, use Get Dataset Health Checks. For the full report history of a specific check, use Get Latest Check Reports.
Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:data-health-read api:datasets-read.
stringThe name of the Branch. If none is provided, the default Branch name - master for most enrollments - will be used.
booleanEnables the use of preview functionality.
objectmap<CheckRid, CheckReport>A map from Check RID to the most recent report for that check. If a check is configured but has not yet produced a report, the value will be absent.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getHealthCheckReports?branchName=master&preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3": {
"result": {
"status": "PASSED"
},
"createdTime": "2003-05-06T12:34:56.789Z",
"check": {
"updatedTime": "2024-09-25T17:29:35.974Z",
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"groups": [
"ri.data-health.main.check-group.08e376a8-607d-4f44-b8dd-b4587be6ce9b"
],
"rid": "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3",
"intent": "Check to ensure builds are passing."
},
"rid": "ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
}| Error Name | ||
|---|---|---|
Branch | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested branch could not be found, or the client token does not have access to it. | |
| Parameters | datasetRid, branchName | |
Dataset | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested dataset could not be found, or the client token does not have access to it. | |
| Parameters | datasetRid | |
Check | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The type of the requested check is not yet supported in the Platform API. | |
| Parameters | checkType | |
Get | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not getHealthCheckReports the Dataset. | |
| Parameters | datasetRid | |
See Errors for a general overview of errors in the platform.