API Enumerations

Description of different enumerations used in the API

Collection Frequency

How often should the custom data quality monitor be evaluated by Revefi

ValueDescription
COLLECTION_FREQUENCY_HOURLYEvaluate the data quality monitor every hour
COLLECTION_FREQUENCY_DAILYEvaluate the data quality monitor every day. Revefi runs the daily monitors at approximately 4am UTC


StaticThresholdComp

The type of comparison operation to perform between evaluated value of the monitor and the specified threshold.
The alert is triggered only if the evaluated value of the monitor does not satisfy the condition specified by the comparison operation and the threshold.
For eg if the comparison operation is STATIC_THRESHOLD_COMP_LESS_THAN and the threshold is 10,
Revefi will ensure that evaluated value of the monitor is less than 10, if not an alert will be triggered.

ValueDescription
STATIC_THRESHOLD_COMP_LESS_THANEvaluate the data quality monitor and alert if the evaluated value is not less than the given threshold
STATIC_THRESHOLD_COMP_LESS_THAN_EQUAL_TOEvaluate the data quality monitor and alert if the evaluated value is neither less than nor equal to the given threshold
STATIC_THRESHOLD_COMP_EQUAL_TOEvaluate the data quality monitor and alert if the evaluated value is not equal to the given threshold
STATIC_THRESHOLD_COMP_GREATER_THANEvaluate the data quality monitor and alert if the evaluated value is not greater than the given threshold
STATIC_THRESHOLD_COMP_GREATER_THAN_EQUAL_TOEvaluate the data quality monitor and alert if the evaluated value is neither greater than nor equal to the given threshold
STATIC_THRESHOLD_COMP_BETWEENEvaluate the data quality monitor and alert if the evaluated value is not in between the given upper and lower limits

StaticThresholdValueType

The type of the threshold metric

ValueDescription
STATIC_THRESHOLD_VALUE_TYPE_NUMERICEvaluate the data quality monitor and check if the evaluated value is within the given threshold
STATIC_THRESHOLD_VALUE_TYPE_PERCENT_LAST_VALUEPERCENT_LAST_VALUE means the percent that the data quality evaluation value is of the last value. For instance, if the evaluationValue is 10 and the previous evaluationValue was 20 then PERCENT_LAST_VALUE = 0.5
STATIC_THRESHOLD_VALUE_TYPE_PERCENT_AVERAGEPERCENT_AVERAGE means the avg percent that the data quality evaluation value is of the last value. For instance, if the evaluationValue is 10 and the previous evaluationValue was 20 then PERCENT_AVERAGE = 0.5
STATIC_THRESHOLD_VALUE_TYPE_TIMES_STANDARD_DEVIATIONTIMES_STANDARD_DEVIATION means the number of times the standard deviations that the evaluation value is above or below the threshold value.

SqlMetricEvaluationType

The type of evaluation for data quality monitor. For anomaly type Revefi will automatically figure the thresholds, for static threshold the thresholds needs to be provided

ValueDescription
SQL_METRIC_EVALUATION_TYPE_STATIC_THRESHOLDWith this option you can define the expected range of values for your monitor. We will alert you when we detect the evaluated value of the monitor is outside the provided range(thresholds).
SQL_METRIC_EVALUATION_TYPE_AUTOMATIC_ANOMALY_DETECTIONWith this option you can use Revefi's internal anomaly detection to automatically alert you the when value of the data quality monitor evaluation is anomalous. No thresholds need to be provided with this option.


SqlSpecName

The type of the custom data quality monitor to be created on a table

ValueDescription
COLUMN_NULL_COUNTData quality monitor type that validates the null count in columns. example: SELECT SUM(CASE WHEN col1 is null THEN 1 ELSE 0 END) FROM tableA
COLUMN_DISTINCT_VALUE_COUNTData quality monitor type that validates the number of distinct values in columns. example: SELECT COUNT(DISTINCT col1) FROM tableA
COLUMN_APPROXIMATE_DISTINCT_VALUE_COUNTData quality monitor type that validates the approximate number of distinct values in columns. example: SELECT APPROX_COUNT_DISTINCT(col1) FROM tableA
COLUMN_GROUP_UNIQUEData quality monitor type the unique number of values in columns. example: SELECT col1, col2, COUNT(*) AS duplicates FROM tableA GROUP BY col1, col2 HAVING duplicates > 1
CUSTOM_SQLData quality monitor type that runs a custom sql to evaluate