HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Retrieve information about data quality values

Retrieve information about data quality values. Values by default will return all values applied to objects, both directly and related.
Related values are values applied to objects that would indirectly affect another object.
For example, a value applied on an Attribute would have that same value applied on the owning parent Table.
Alation automatically sets and propagates these relations during ingestion.
This default result is the same data as you would see on the Data Health tab in the Alation catalog.

This indirect relation is reflected with the fields object_key object_name otype oid.

The originating source object the value was applied to are reflected with the fields source_object_key source_object_name source_otype source_oid

To only retrieve values that were directly assigned without propagated value results, use the hide_related query parameter.

Query Params
array of strings

Filter values on those applied indirectly by the related object's api_keys.

object_key
array of strings

Filter values on those applied directly to a source object's api_key.

source_object_key
array of strings

Filter values on those applied on specified field keys.

field_key
string

Filter values by their quality

boolean
array of strings

Order by response by field. Prepend order_by value with '-' to sort by field descending

order_by
integer

Size limit of the page. Defaults to 100 entries.

integer

Skip x number of records.

Response

Language
Credentials
URL
Choose an example:
application/json