Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Latest Check Reports

GET/api/v2/dataHealth/checks/{checkRid}/checkReports/getLatest
Warning

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 check reports for this Check. Reports are returned in reverse chronological order (most recent first).

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:data-health-read.

Path parameters

checkRid
string

The unique resource identifier (RID) of a Data Health Check.

Query parameters

limit
integer
optional

The maximum number of check reports to return. Defaults to 10. Maximum allowed value is 100.

preview
boolean
optional

Enables the use of preview functionality.

Response body

GetLatestCheckReportsResponse
object

The response for getting the latest check reports.

Hide child attributes

Hide child attributes

data
list<CheckReport>
optional

The list of check reports.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/dataHealth/checks/ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3/checkReports/getLatest?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "data": [ { "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 responses

Error Name
CheckTypeNotSupportedError CodeINVALID_ARGUMENT
Status Code400
DescriptionThe type of the requested check is not yet supported in the Platform API.
ParameterscheckType
GetLatestCheckReportsPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not getLatest the CheckReport.
ParameterscheckRid
CheckNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Check could not be found.
ParameterscheckRid