Type Alias DataQualitiesAPI

type DataQualitiesAPI = {
    clearCache: typeof clearCache;
    getDataQualitiesComputation: typeof getDataQualitiesComputation;
    getDataQualitiesGlobalResults: typeof getDataQualitiesGlobalResults;
    triggerDataQualitiesComputation: typeof triggerDataQualitiesComputation;
}
Index

Properties

clearCache getDataQualitiesComputation getDataQualitiesGlobalResults triggerDataQualitiesComputation

Properties

clearCache: typeof clearCache

Clears the cache for data-qualities api requests.

getDataQualitiesComputation: typeof getDataQualitiesComputation

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.

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

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

GetDataQualitiesComputationHttpError

getDataQualitiesGlobalResults: typeof getDataQualitiesGlobalResults

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

an object with query parameters

GetDataQualitiesGlobalResultsHttpError

triggerDataQualitiesComputation: typeof triggerDataQualitiesComputation

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-qualities/computations/{computationId}). The computation runs asynchronously. Poll the status endpoint until status is SUCCEEDED or FAILED.

Param: body

an object with the body content

TriggerDataQualitiesComputationHttpError

Settings

Member Visibility

On This Page

Properties