Last updated: July 22, 2025
DQOps REST API tables models reference
The references of all objects used by tables REST API operations are listed below.
SimilarTableModel
Model that describes a table that is similar to a reference table. Similar tables are used to build the data lineage graph.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
difference |
Table similarity score. Lower numbers indicate higher similarity. | integer |
similarity_pct |
A similarity score as a percentage. A value 100.0 means that the tables are probably equal. | double |
connection_name |
Connection name | string |
schema_name |
Schema name | string |
table_name |
Table name | string |
TableComparisonDailyMonitoringChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains the daily monitoring comparison checks for each configured reference table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
self |
Dict[string, TableComparisonDailyMonitoringChecksSpec] |
CustomCheckSpecMap
Dictionary of custom checks indexed by a check name.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
self |
Dict[string, CustomCheckSpec] |
TableDailyMonitoringCheckCategoriesSpec
Container of table level daily monitoring. Contains categories of daily monitoring.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
volume |
Daily monitoring volume data quality checks | TableVolumeDailyMonitoringChecksSpec |
timeliness |
Daily monitoring timeliness checks | TableTimelinessDailyMonitoringChecksSpec |
accuracy |
Daily monitoring accuracy checks | TableAccuracyDailyMonitoringChecksSpec |
custom_sql |
Daily monitoring custom SQL checks | TableCustomSqlDailyMonitoringChecksSpec |
availability |
Daily monitoring table availability checks | TableAvailabilityDailyMonitoringChecksSpec |
schema |
Daily monitoring table schema checks | TableSchemaDailyMonitoringChecksSpec |
uniqueness |
Daily monitoring uniqueness checks on a table level. | TableUniquenessDailyMonitoringChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | TableComparisonDailyMonitoringChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
TableComparisonDailyPartitionedChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains the daily partitioned comparison checks for each configured reference table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
self |
Dict[string, TableComparisonDailyPartitionedChecksSpec] |
TableDailyPartitionedCheckCategoriesSpec
Container of table level daily partitioned checks. Contains categories of daily partitioned checks.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
volume |
Volume daily partitioned data quality checks that verify the quality of every day of data separately | TableVolumeDailyPartitionedChecksSpec |
timeliness |
Daily partitioned timeliness checks | TableTimelinessDailyPartitionedChecksSpec |
custom_sql |
Custom SQL daily partitioned data quality checks that verify the quality of every day of data separately | TableCustomSqlDailyPartitionedChecksSpec |
uniqueness |
Daily partitioned uniqueness checks on a table level. | TableUniquenessDailyPartitionChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | TableComparisonDailyPartitionedChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
TableModel
Full table model that returns the specification of a single table in the REST Api.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
connection_name |
Connection name. | string |
table_hash |
Table hash that identifies the table using a unique hash code. | long |
spec |
Full table specification including all nested information, the table name is inside the 'target' property. | TableSpec |
can_edit |
Boolean flag that decides if the current user can update or delete this object. | boolean |
yaml_parsing_error |
Optional parsing error that was captured when parsing the YAML file. This field is null when the YAML file is valid. If an error was captured, this field returns the file parsing error message and the file location. | string |
TableComparisonMonthlyMonitoringChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains the monthly monitoring comparison checks for each configured reference table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
self |
Dict[string, TableComparisonMonthlyMonitoringChecksSpec] |
TableMonthlyMonitoringCheckCategoriesSpec
Container of table level monthly monitoring checks. Contains categories of monthly monitoring checks.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
volume |
Monthly monitoring of volume data quality checks | TableVolumeMonthlyMonitoringChecksSpec |
timeliness |
Monthly monitoring of timeliness checks | TableTimelinessMonthlyMonitoringChecksSpec |
accuracy |
Monthly monitoring accuracy checks | TableAccuracyMonthlyMonitoringChecksSpec |
custom_sql |
Monthly monitoring of custom SQL checks | TableCustomSqlMonthlyMonitoringChecksSpec |
availability |
Daily partitioned availability checks | TableAvailabilityMonthlyMonitoringChecksSpec |
schema |
Monthly monitoring table schema checks | TableSchemaMonthlyMonitoringChecksSpec |
uniqueness |
Monthly monitoring uniqueness checks on a table level. | TableUniquenessMonthlyMonitoringChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | TableComparisonMonthlyMonitoringChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
TableComparisonMonthlyPartitionedChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains the monthly partitioned comparison checks for each configured reference table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
self |
Dict[string, TableComparisonMonthlyPartitionedChecksSpec] |
TableMonthlyPartitionedCheckCategoriesSpec
Container of table level monthly partitioned checks. Contains categories of monthly partitioned checks.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
volume |
Volume monthly partitioned data quality checks that verify the quality of every month of data separately | TableVolumeMonthlyPartitionedChecksSpec |
timeliness |
Monthly partitioned timeliness checks | TableTimelinessMonthlyPartitionedChecksSpec |
custom_sql |
Custom SQL monthly partitioned data quality checks that verify the quality of every month of data separately | TableCustomSqlMonthlyPartitionedChecksSpec |
uniqueness |
Monthly partitioned uniqueness checks on a table level. | TableUniquenessMonthlyPartitionChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | TableComparisonMonthlyPartitionedChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
TablePartitioningModel
Rest model that returns the configuration of table partitioning information.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
connection_name |
Connection name. | string |
target |
Physical table details (a physical schema name and a physical table name) | PhysicalTableName |
timestamp_columns |
Column names that store the timestamps that identify the event (transaction) timestamp and the ingestion (inserted / loaded at) timestamps. Also configures the timestamp source for the date/time partitioned data quality checks (event timestamp or ingestion timestamp). | TimestampColumnsSpec |
incremental_time_window |
Configuration of time windows for executing partition checks incrementally, configures the number of recent days to analyze for daily partitioned tables or the number of recent months for monthly partitioned data. | PartitionIncrementalTimeWindowSpec |
can_edit |
Boolean flag that decides if the current user can update or delete this object. | boolean |
TableComparisonProfilingChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
self |
Dict[string, TableComparisonProfilingChecksSpec] |
TableProfilingCheckCategoriesSpec
Container of table level checks that are activated on a table level.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
result_truncation |
Defines how many profiling checks results are stored for the table monthly. By default, DQOps will use the 'one_per_month' configuration and store only the most recent profiling checks result executed during the month. By changing this value, it is possible to store one value per day or even store all profiling checks results. | ProfilingTimePeriodTruncation |
volume |
Configuration of volume data quality checks on a table level. | TableVolumeProfilingChecksSpec |
timeliness |
Configuration of timeliness checks on a table level. Timeliness checks detect anomalies like rapid row count changes. | TableTimelinessProfilingChecksSpec |
accuracy |
Configuration of accuracy checks on a table level. Accuracy checks compare the tested table with another reference table. | TableAccuracyProfilingChecksSpec |
custom_sql |
Configuration of data quality checks that are evaluating custom SQL conditions and aggregated expressions. | TableCustomSqlProfilingChecksSpec |
availability |
Configuration of the table availability data quality checks on a table level. | TableAvailabilityProfilingChecksSpec |
schema |
Configuration of schema (column count and schema) data quality checks on a table level. | TableSchemaProfilingChecksSpec |
uniqueness |
Configuration of uniqueness checks on a table level. | TableUniquenessProfilingChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | TableComparisonProfilingChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
TableProfilingSetupStatusModel
Table status model that identifies which type of information is already collected, such as data quality checks are configured, or statistics collected. DQOps user interface uses this information to activate red borders to highlight tabs in the user interface that must be clicked to continue profiling the table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
connection_name |
Connection name. | string |
table_hash |
Table hash that identifies the table using a unique hash code. | long |
target |
Physical table details (a physical schema name and a physical table name). | PhysicalTableName |
basic_statistics_collected |
The basic statistics were collected for this table. If this field returns false, the statistics were not collected and the user should collect basic statistics again. | boolean |
profiling_checks_configured |
Returns true if the table has any profiling checks configured on the table, or any of its column. Returns false when the user should first generate a configuration of the profiling checks using the rule miner. | boolean |
monitoring_checks_configured |
Returns true if the table has any monitoring checks configured on the table, or any of its column. Returns false when the user should first generate a configuration of the monitoring checks using the rule miner. | boolean |
partition_checks_configured |
Returns true if the table has any partition checks configured on the table, or any of its column. The value is true also when the table is not configured to support partitioned checks, so asking the user to configure partition checks is useless. Returns false when the user should first generate a configuration of the partition checks using the rule miner. | boolean |
check_results_present |
Returns true if the table has any recent data quality check results. Returns false when the user should run any checks to get any results. | boolean |
TableStatisticsModel
Model that returns a summary of the table level statistics (the basic profiling results).
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
connection_name |
Connection name. | string |
table |
Physical table name including the schema and table names. | PhysicalTableName |
collect_table_statistics_job_template |
Configured parameters for the "collect statistics" job that should be pushed to the job queue in order to run all statistics collectors within this table, limited only to the table level statistics (row count, etc). | StatisticsCollectorSearchFilters |
collect_table_and_column_statistics_job_template |
Configured parameters for the "collect statistics" job that should be pushed to the job queue in order to run all statistics collectors within this table, including statistics for all columns. | StatisticsCollectorSearchFilters |
can_collect_statistics |
Boolean flag that decides if the current user can collect statistics. | boolean |