List checks for a dataset version

GET

/v1/dataset-versions/{versionId}/checks

curl -X GET 'https://api.embodiflow.io/v1/dataset-versions/{versionId}/checks' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

versionIdstringrequired

Responses

Success

dataobjectrequired
- overallStatusstringrequired
  Allowed values
  failed
  warning
  passed
  skipped
- blockingFailedone ofrequired
- passedCountnumberrequired
- warningCountnumberrequired
- failedCountnumberrequired
- skippedCountnumberrequired
- latestCheckAtstring | nullrequired
- schemaDriftobject

Response example

{
  "data": {
    "overallStatus": "failed",
    "blockingFailed": false,
    "passedCount": 0,
    "warningCount": 0,
    "failedCount": 0,
    "skippedCount": 0,
    "latestCheckAt": "string",
    "schemaDrift": {
      "overallStatus": "failed",
      "blockingFailed": false,
      "passedCount": 0,
      "warningCount": 0,
      "failedCount": 0,
      "skippedCount": 0,
      "findings": [
        {
          "scope": "topic",
          "field": "string",
          "expected": "string",
          "actual": "string",
          "message": "string",
          "status": "failed",
          "blocking": false
        }
      ]
    }
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1

{ "data": { "overallStatus": "failed", "blockingFailed": false, "passedCount": 0, "warningCount": 0, "failedCount": 0, "skippedCount": 0, "latestCheckAt": "string", "schemaDrift": { "overallStatus": "failed", "blockingFailed": false, "passedCount": 0, "warningCount": 0, "failedCount": 0, "skippedCount": 0, "findings": [ { "scope": "topic", "field": "string", "expected": "string", "actual": "string", "message": "string", "status": "failed", "blocking": false } ] } } }