List health for a dataset version

GET

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

curl -X GET 'https://api.embodiflow.io/v1/dataset-versions/{versionId}/health' \
  -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
- datasetVersionIdstringrequired
- datasetIdstringrequired
- projectIdstringrequired
- statusstringrequired
  Allowed values
  unknown
  blocked
  ready
  needs_review
- scorenumber | nullrequired
- dimensionsarray<HealthDimensionDto>required
- blockersarray<HealthBlockerDto>required
- recommendedNextActionstringrequired
- computedAtstringrequired
- freshnessStatusstringrequired
  Allowed values
  unknown
  stale
  fresh
  recomputing
- evidenceUpdatedAtstring | nullrequired
- isStaleone ofrequired
- staleReasonstring | nullrequired
- recomputeStatusstringrequired
  Allowed values
  in_progress
  idle
  available
- assetHealthStatusstring | nullrequired
  Allowed values
  failed
  warning
  unknown
  healthy
  stale

Response example

{
  "data": {
    "datasetVersionId": "string",
    "datasetId": "string",
    "projectId": "string",
    "status": "unknown",
    "score": 0,
    "dimensions": [
      {
        "id": "quality",
        "status": "warning",
        "message": "string",
        "recommendedAction": "string",
        "evidenceLinks": [
          {
            "kind": "workflow-run",
            "id": "string",
            "label": "string",
            "href": "string"
          }
        ]
      }
    ],
    "blockers": [
      {
        "id": "string",
        "dimensionId": "quality",
        "severity": "warning",
        "code": "string",
        "message": "string",
        "waived": false,
        "waiveReason": "string",
        "waivedAt": "string",
        "waivedByDisplayName": "string",
        "waiverNeedsReview": false,
        "evidenceLinks": [
          {
            "kind": "workflow-run",
            "id": "string",
            "label": "string",
            "href": "string"
          }
        ],
        "linkedRepairTaskId": "string",
        "linkedRepairTaskStatus": "in_progress"
      }
    ],
    "recommendedNextAction": "string",
    "computedAt": "string",
    "freshnessStatus": "unknown",
    "evidenceUpdatedAt": "string",
    "isStale": false,
    "staleReason": "string",
    "recomputeStatus": "in_progress",
    "assetHealthStatus": "failed"
  }
}

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

{ "data": { "datasetVersionId": "string", "datasetId": "string", "projectId": "string", "status": "unknown", "score": 0, "dimensions": [ { "id": "quality", "status": "warning", "message": "string", "recommendedAction": "string", "evidenceLinks": [ { "kind": "workflow-run", "id": "string", "label": "string", "href": "string" } ] } ], "blockers": [ { "id": "string", "dimensionId": "quality", "severity": "warning", "code": "string", "message": "string", "waived": false, "waiveReason": "string", "waivedAt": "string", "waivedByDisplayName": "string", "waiverNeedsReview": false, "evidenceLinks": [ { "kind": "workflow-run", "id": "string", "label": "string", "href": "string" } ], "linkedRepairTaskId": "string", "linkedRepairTaskStatus": "in_progress" } ], "recommendedNextAction": "string", "computedAt": "string", "freshnessStatus": "unknown", "evidenceUpdatedAt": "string", "isStale": false, "staleReason": "string", "recomputeStatus": "in_progress", "assetHealthStatus": "failed" } }