Workflows

Get workflow quality metrics

Returns the data quality metric results for a workflow run, plus the run's total data quality issue count.

Metrics are only available once the run has finished, before that the endpoint returns { "results": null, "issueCount": null }.

Each metric result carries a status:

  • OK: the metric was computed, see data for it's details.
  • PENDING: the metric has not been computed yet.
  • NOT_APPLICABLE: the metric cannot be computed for this workflow, see message.
  • ERROR: the metric computation failed, see message.
get/v4/workflows/{workflowId}/quality-metrics

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows/{workflowId}/quality-metrics
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

workflowIdstring required

ID of the workflow to retrieve quality metrics for

Query parameters

jobIdstring

ID of a specific published run. Omit to use the latest published run.

Response

Quality metric results. results and issueCount are null until the run has finished.

issueCountinteger nullable required

Total number of data quality issues detected for the run. Null until the run has finished.

Changes

No recorded changes to this operation across all 1 revision of this API.