Type Alias DataQualitiesAPI

Index
clearCache: typeof dataQualities.clearCache

Clears the cache for data-qualities api requests.

createDataQualityComputation: typeof createDataQualityComputation

Triggers a full data quality computation for a dataset, running profile calculation followed by data quality assessment. Returns a computationId that can be used to track progress via the computation status endpoint (GET /data-governance/data-qualities/computations/{computationId}). The computation runs asynchronously. Poll the status endpoint until status is SUCCEEDED or FAILED.

an object with the body content

CreateDataQualityComputationHttpError

filterDataQualitiesFieldQualities: typeof filterDataQualitiesFieldQualities

Retrieves the latest computed field quality metrics for a list of datasets. The maximum number of datasets is 100. When a dataset has been analyzed through multiple connections, the response returns the result from the most recently computed connection.

an object with the body content

FilterDataQualitiesFieldQualitiesHttpError

filterDataQualitiesGlobalResults: typeof filterDataQualitiesGlobalResults

Retrieves the latest computed global quality metrics for a list of datasets. The maximum number of datasets is 100. When a dataset has been analyzed through multiple connections, the response returns the result from the most recently computed connection.

an object with the body content

FilterDataQualitiesGlobalResultsHttpError

getDataQualitiesBatchComputation: typeof getDataQualitiesBatchComputation

Retrieves the status of a batch computation, including per-dataset statuses.

Batch computation ID for tracking progress of the overall data quality computations.

GetDataQualitiesBatchComputationHttpError

getDataQualityComputation: typeof getDataQualityComputation

Retrieves the current execution status of a data quality computation. Poll this endpoint after triggering a computation to determine when results are available. The status field returns one of REQUESTED, SUBMITTED, PROFILE_REQUESTED, SUCCEEDED, FAILED, or PROFILE_FAILED.

getDataQualityComputation(
"4db06daa-3117-412e-8fb4-b29c937f9a0e"
)

The unique identifier of the computation, as returned by POST /data-governance/data-qualities/computations.

GetDataQualityComputationHttpError

getDataQualityGlobalResults: typeof getDataQualityGlobalResults

Retrieves the global quality results for a dataset, showing counts of valid, invalid, empty, and total sample cells.

an object with query parameters

GetDataQualityGlobalResultsHttpError