Last updated: July 21, 2025

Reference of all operations used by DQOps REST API

This is a list of the operations in DQOps REST API Python client broken down by individual groups of operations.

check_results

Returns all the data quality check results of executed checks on tables and columns.

Operation name	HTTP call	Description
get_column_monitoring_checks_results	GET	Returns a complete view of the recent column level monitoring executions for the monitoring at a requested time scale
get_column_partitioned_checks_results	GET	Returns an overview of the most recent column level partitioned checks executions for a requested time scale
get_column_profiling_checks_results	GET	Returns an overview of the most recent check executions for all column level data quality profiling checks on a column
get_table_data_quality_status	GET	Read the most recent results of executed data quality checks on the table and return the current table's data quality status - the number of failed data quality checks if the table has active data quality issues. Also returns the names of data quality checks that did not pass most recently. This operation verifies only the status of the most recently executed data quality checks. Previous data quality issues are not counted.
get_table_issues_histogram	GET	Generates a histograms of data quality issues for each day on a table, returning the number of data quality issues on that day. The other histograms are by a column name and by a check name.
get_table_monitoring_checks_results	GET	Returns the complete results of the most recent table level monitoring executions for the monitoring at a requested time scale
get_table_partitioned_checks_results	GET	Returns a complete view of the recent table level partitioned checks executions for a requested time scale
get_table_profiling_checks_results	GET	Returns the complete results of the most recent check executions for all table level data quality profiling checks on a table

check_results_overview

Returns the overview of the recently executed checks on tables and columns, returning a summary of the last 5 runs.

Operation name	HTTP call	Description
get_column_monitoring_checks_overview	GET	Returns an overview of the most recent column level monitoring executions for the monitoring at a requested time scale
get_column_partitioned_checks_overview	GET	Returns an overview of the most recent column level partitioned checks executions for a requested time scale
get_column_profiling_checks_overview	GET	Returns an overview of the most recent check executions for all column level data quality profiling checks on a column
get_table_monitoring_checks_overview	GET	Returns an overview of the most recent table level monitoring executions for the monitoring at a requested time scale
get_table_partitioned_checks_overview	GET	Returns an overview of the most recent table level partitioned checks executions for a requested time scale
get_table_profiling_checks_overview	GET	Returns an overview of the most recent check executions for all table level data quality profiling checks on a table

checks

Data quality check definition management operations for adding/removing/changing custom data quality checks.

Operation name	HTTP call	Description
create_check	POST	Creates (adds) a new custom check that is a pair of a sensor name and a rule name.
delete_check	DELETE	Deletes a custom check definition
get_all_checks	GET	Returns a flat list of all checks available in DQOps, both built-in checks and user defined or customized checks.
get_check	GET	Returns a check definition
get_check_folder_tree	GET	Returns a tree of all checks available in DQOps, both built-in checks and user defined or customized checks.
update_check	PUT	Updates an existing check, making a custom check definition if it is not present

column_quality_policies

Operations for managing the configuration of data quality policies at a column level. Policies are the default configuration of data quality checks for columns matching a pattern.

Operation name	HTTP call	Description
copy_from_column_quality_policy	POST	Creates (adds) a copy of an existing default column-level checks pattern configuration, under a new name.
create_column_quality_policy	POST	Creates (adds) a new default column-level checks pattern configuration by saving a full specification object.
create_column_quality_policy_target	POST	Creates (adds) a new default column-level checks pattern configuration.
delete_column_quality_policy	DELETE	Deletes a default column-level checks pattern
get_column_quality_policies	GET	Returns a flat list of all column-level default check patterns configured for this instance. Default checks are applied on columns dynamically.
get_column_quality_policy	GET	Returns a default checks pattern definition as a full specification object
get_column_quality_policy_target	GET	Returns a default checks pattern definition
get_monitoring_daily_column_quality_policy	GET	Returns UI model to show and edit the default configuration of the daily monitoring checks that are configured for a check pattern on a column level.
get_monitoring_monthly_column_quality_policy	GET	Returns UI model to show and edit the default configuration of the monthly monitoring checks that are configured for a check pattern on a column level.
get_partitioned_daily_column_quality_policy	GET	Returns UI model to show and edit the default configuration of the daily partitioned checks that are configured for a check pattern on a column level.
get_partitioned_monthly_column_quality_policy	GET	Returns UI model to show and edit the default configuration of the monthly partitioned checks that are configured for a check pattern on a column level.
get_profiling_column_quality_policy	GET	Returns UI model to show and edit the default configuration of the profiling checks that are configured for a check pattern on a column level.
update_column_quality_policy	PUT	Updates an default column-level checks pattern by saving a full specification object
update_column_quality_policy_target	PUT	Updates an default column-level checks pattern, changing only the target object
update_monitoring_daily_column_quality_policy	PUT	New configuration of the default daily monitoring checks on a column level. These checks will be applied to columns.
update_monitoring_monthly_column_quality_policy	PUT	New configuration of the default monthly monitoring checks on a column level. These checks will be applied to columns.
update_partitioned_daily_column_quality_policy	PUT	New configuration of the default daily partitioned checks on a column level. These checks will be applied to columns.
update_partitioned_monthly_column_quality_policy	PUT	New configuration of the default monthly partitioned checks on a column level. These checks will be applied to columns.
update_profiling_column_quality_policy	PUT	New configuration of the default profiling checks on a column level. These checks will be applied to columns.

columns

Operations related to manage the metadata of columns, and managing the configuration of column-level data quality checks.

Operation name	HTTP call	Description
create_column	POST	Creates a new column (adds a column metadata to the table)
delete_column	DELETE	Deletes a column from the table
get_column	GET	Returns the full column specification
get_column_basic	GET	Returns the column specification
get_column_comments	GET	Return the list of comments assigned to a column
get_column_labels	GET	Return the list of labels assigned to a column
get_column_monitoring_checks_basic_model	GET	Return a simplistic UI friendly model of column level data quality monitoring on a column
get_column_monitoring_checks_daily	GET	Return the configuration of daily column level data quality monitoring on a column
get_column_monitoring_checks_model	GET	Return a UI friendly model of column level data quality monitoring on a column
get_column_monitoring_checks_model_filter	GET	Return a UI friendly model of column level data quality monitoring on a column filtered by category and check name
get_column_monitoring_checks_monthly	GET	Return the configuration of monthly column level data quality monitoring on a column
get_column_partitioned_checks_basic_model	GET	Return a simplistic UI friendly model of column level data quality partitioned checks on a column
get_column_partitioned_checks_daily	GET	Return the configuration of daily column level data quality partitioned checks on a column
get_column_partitioned_checks_model	GET	Return a UI friendly model of column level data quality partitioned checks on a column
get_column_partitioned_checks_model_filter	GET	Return a UI friendly model of column level data quality partitioned checks on a column, filtered by category and check name
get_column_partitioned_checks_monthly	GET	Return the configuration of monthly column level data quality partitioned checks on a column
get_column_profiling_checks	GET	Return the configuration of column level data quality profiling checks on a column
get_column_profiling_checks_basic_model	GET	Return a simplistic UI friendly model of column level data quality profiling checks on a column
get_column_profiling_checks_model	GET	Return a UI friendly model of data quality profiling checks on a column
get_column_profiling_checks_model_filter	GET	Return a UI friendly model of data quality profiling checks on a column filtered by category and check name
get_column_statistics	GET	Returns the column specification with the metrics captured by the most recent statistics collection.
get_columns	GET	Returns a list of columns inside a table
get_columns_statistics	GET	Returns a list of columns inside a table with the metrics captured by the most recent statistics collection.
update_column	PUT	Updates an existing column specification, changing all the fields (even the column level data quality checks).
update_column_basic	PUT	Updates an existing column, changing only the basic information like the expected data type (the data type snapshot).
update_column_comments	PUT	Updates the list of comments assigned to a column.
update_column_labels	PUT	Updates the list of labels assigned to a column.
update_column_monitoring_checks_daily	PUT	Updates configuration of daily column level data quality monitoring on a column.
update_column_monitoring_checks_model	PUT	Updates configuration of column level data quality monitoring on a column, for a given time scale, from a UI friendly model.
update_column_monitoring_checks_monthly	PUT	Updates configuration of monthly column level data quality monitoring checks on a column.
update_column_partitioned_checks_daily	PUT	Updates configuration of daily column level data quality partitioned checks on a column.
update_column_partitioned_checks_model	PUT	Updates configuration of column level data quality partitioned checks on a column, for a given time scale, from a UI friendly model.
update_column_partitioned_checks_monthly	PUT	Updates configuration of monthly column level data quality partitioned checks on a column.
update_column_profiling_checks	PUT	Updates configuration of column level data quality profiling checks on a column.
update_column_profiling_checks_model	PUT	Updates configuration of column level data quality profiling checks on a column from a UI friendly model.

connections

Operations for adding/updating/deleting the configuration of data sources managed by DQOps.

Operation name	HTTP call	Description
bulk_activate_connection_checks	PUT	Activates all named check on this connection in the locations specified by filter
bulk_deactivate_connection_checks	PUT	Deactivates (deletes) all named check on this connection in the locations specified by filter
create_connection	POST	Creates a new connection
create_connection_basic	POST	Creates a new connection given the basic information.
delete_connection	DELETE	Deletes a connection
get_all_connections	GET	Returns a list of connections (data sources)
get_connection	GET	Return the full details of a connection given the connection name
get_connection_auto_import	GET	Return the configuration of the table auto import for a connection
get_connection_basic	GET	Return the basic details of a connection given the connection name
get_connection_comments	GET	Return the comments for a connection
get_connection_common_columns	GET	Finds common column names that are used on one or more tables. The list of columns is sorted in descending order by column name.
get_connection_default_grouping_configuration	GET	Return the default data grouping configuration for a connection
get_connection_incident_grouping	GET	Retrieves the configuration of data quality incident grouping and incident notifications
get_connection_labels	GET	Return the labels for a connection
get_connection_scheduling_group	GET	Return the schedule for a connection for a scheduling group
update_connection	PUT	Updates an existing connection
update_connection_auto_import	PUT	Updates the configuration of the table auto import on a connection. The auto import specifies the table filters and a CRON schedule.
update_connection_basic	PUT	Updates the basic information of a connection
update_connection_comments	PUT	Updates (replaces) the list of comments of a connection
update_connection_default_grouping_configuration	PUT	Updates the default data grouping connection of a connection
update_connection_incident_grouping	PUT	Updates (replaces) configuration of incident grouping and notifications on a connection (data source) level.
update_connection_labels	PUT	Updates the list of labels of a connection
update_connection_scheduling_group	PUT	Updates the schedule of a connection for a scheduling group (named schedule for checks with a similar time series configuration)

dashboards

Operations for retrieving the list of data quality dashboards supported by DQOps and issuing short-term access keys to open a dashboard.

Operation name	HTTP call	Description
get_all_dashboards	GET	Returns a list of root folders with dashboards
get_dashboard_level_1	GET	Returns a single dashboard in the tree of folder with a temporary authenticated url
get_dashboard_level_2	GET	Returns a single dashboard in the tree of folders with a temporary authenticated url
get_dashboard_level_3	GET	Returns a single dashboard in the tree of folders with a temporary authenticated url
get_dashboard_level_4	GET	Returns a single dashboard in the tree of folders with a temporary authenticated url
get_dashboard_level_5	GET	Returns a single dashboard in the tree of folders with a temporary authenticated url

data_catalog_synchronization

Operations related to synchronization of data quality health results to the a data catalog.

Operation name	HTTP call	Description
push_data_quality_status_to_data_catalog	PUT	Pushes the data quality status of tables matching the search filters to the data catalog.

data_domains

Data domain management API to create different data domains.

Operation name	HTTP call	Description
create_data_domain	POST	Creates a new data domain given a data domain display name.
delete_data_domain	DELETE	Deletes a data domain. The domain is deleted in the DQOps SaaS cloud and locally.
get_local_data_domains	GET	Returns a list of local data domains that this instance is maintaining. Data domains are supported only in an ENTERPRISE versions of DQOps.
switch_to_data_domain	GET	Switches to a different data domain. This operation sends a special cookie and redirects the user to the home screen.
synchronize_data_domains	PATCH	Synchronizes the data domains in the SaaS DQOps Cloud to this instance. All data domains will be created locally.

data_grouping_configurations

Operations for managing the configuration of data groupings on a table level in DQOps.

Operation name	HTTP call	Description
create_table_grouping_configuration	POST	Creates a new data grouping configuration on a table level
delete_table_grouping_configuration	DELETE	Deletes a data grouping configuration from a table
get_table_grouping_configuration	GET	Returns a model of the data grouping configuration
get_table_grouping_configurations	GET	Returns the list of data grouping configurations on a table
set_table_default_grouping_configuration	PATCH	Sets a table's grouping configuration as the default or disables data grouping
update_table_grouping_configuration	PUT	Updates a data grouping configuration according to the provided model

data_lineage

Operations related to managing and inspecting table and column lineage.

Operation name	HTTP call	Description
create_table_source_table	POST	Creates a new source table of the table's data lineage.
delete_table_source_table	DELETE	Deletes a specific data lineage source table of the given table.
get_table_data_lineage_graph	GET	Returns a data lineage graph around the given table.
get_table_source_table	GET	Reads a specific data lineage source table defined on a target tale.
get_table_source_tables	GET	Returns a list of source tables on the data lineage that are sources of the given table.
get_table_target_tables	GET	Returns a list of target tables on the data lineage that are downstream tables of the given table.
update_table_source_table	PUT	Update a specific data lineage source table using a new model.

data_sources

Rest API controller that operates on data sources that are not yet imported, testing connections or retrieving the metadata (schemas and tables).

Operation name	HTTP call	Description
get_remote_data_source_schemas	GET	Introspects a list of schemas inside a remote data source, identified by an already imported connection.
get_remote_data_source_tables	GET	Introspects the list of columns inside a schema on a remote data source that is identified by a connection that was added to DQOps.
test_connection	POST	Checks if the given remote connection can be opened and if the credentials are valid

defaults

Default settings management for configuring the default data quality checks that are configured for all imported tables and columns.

Operation name	HTTP call	Description
get_default_schedule	GET	Returns spec to show and edit the default configuration of schedules.
get_default_webhooks	GET	Returns spec to show and edit the default configuration of addresses for incident notifications.
update_default_schedules	PUT	New configuration of the default schedules.
update_default_webhooks	PUT	New configuration of the default addresses.

dictionaries

Operations for managing data dictionary CSV files in DQOps. Data dictionaries can be used in accepted_values data quality checks.

Operation name	HTTP call	Description
create_dictionary	POST	Creates (adds) a new data dictionary CSV file, which creates a file in the DQOps user's home dictionaries/ folder named as the dictionary and with the content that is provided in this call.
delete_dictionary	DELETE	Deletes a data dictionary CSV file from the DQOps user's home dictionaries/ folder.
download_dictionary	GET	Downloads a data dictionary CSV file
get_all_dictionaries	GET	Returns a list of all data dictionary CSV files that are present in the DQOps user's home dictionaries/ folder.
get_dictionary	GET	Returns the content of a data dictionary CSV file as a model object
update_dictionary	PUT	Updates an existing data dictionary CSV file, replacing the dictionary's file content.

environment

DQOps environment and configuration controller, provides access to the DQOps configuration, current user's information and issue local API Keys for the calling user.

Operation name	HTTP call	Description
download_logs	GET	Downloads logs as a zip file
get_dqo_settings	GET	Returns all effective DQOps configuration settings.
get_user_profile	GET	Returns the profile of the current user.
issue_api_key	GET	Issues a local API Key for the calling user. This API Key can be used to authenticate using the DQOps REST API client. This API Key should be passed in the "Authorization" HTTP header in the format "Authorization: Bearer <api_key>".

error_samples

Operations that return the error samples collected when data quality checks were executed on data sources from the check editor, and rules failed with an error.

Operation name	HTTP call	Description
get_column_monitoring_error_samples	GET	Returns error samples related to a column level monitoring checks at a requested time scale
get_column_partitioned_error_samples	GET	Returns the error samples related to column level partitioned checks for a requested time scale
get_column_profiling_error_samples	GET	Returns the error samples related to a profiling check for all column level data quality profiling checks on a column
get_column_profiling_error_samples_download	GET	Returns the error samples in CSV format related to a check for one of table level data quality profiling checks on a column
get_monitoring_profiling_error_samples_download	GET	Returns error samples in CSV format related to a column level monitoring checks at a requested time scale
get_partitioned_profiling_error_samples_download	GET	Returns the error samples in CSV format related to column level partitioned checks for a requested time scale
get_table_monitoring_error_samples	GET	Returns the error samples related to a table level monitoring check a requested time scale
get_table_monitoring_error_samples_download	GET	Returns the error samples in CSV format related to a table level monitoring check a requested time scale
get_table_partitioned_error_samples	GET	Returns error samples related to a table level partitioned check for a requested time scale
get_table_partitioned_error_samples_download	GET	Returns error samples in CSV format related to a table level partitioned check for a requested time scale
get_table_profiling_error_samples	GET	Returns the error samples related to a check for all table level data quality profiling checks on a table
get_table_profiling_error_samples_download	GET	Returns the error samples in CSV format related to a check for one of table level data quality profiling checks on a table

errors

Operations that return the execution errors captured when data quality checks were executed on data sources, and sensors or rules failed with an error.

Operation name	HTTP call	Description
get_column_monitoring_errors	GET	Returns errors related to the recent column level monitoring executions for the monitoring at a requested time scale
get_column_partitioned_errors	GET	Returns the errors related to the recent column level partitioned checks executions for a requested time scale
get_column_profiling_errors	GET	Returns the errors related to the recent check executions for all column level data quality profiling checks on a column
get_table_monitoring_errors	GET	Returns the errors related to the most recent table level monitoring executions for the monitoring at a requested time scale
get_table_partitioned_errors	GET	Returns errors related to the recent table level partitioned checks executions for a requested time scale
get_table_profiling_errors	GET	Returns the errors related to the most recent check executions for all table level data quality profiling checks on a table

filtered_notifications_configurations

Operations for managing the configuration of filtered notifications on a connection level in DQOps.

Operation name	HTTP call	Description
create_connection_filtered_notification_configuration	POST	Creates a new filtered notification configuration on a connection level
create_default_filtered_notification_configuration	POST	Creates a new filtered notification configuration at default notifications
delete_connection_filtered_notification_configuration	DELETE	Deletes a filtered notification configuration from a connection
delete_default_filtered_notification_configuration	DELETE	Deletes a filtered notification configuration from default notifications
get_connection_filtered_notification_configuration	GET	Returns a model of the filtered notification configuration
get_connection_filtered_notifications_configurations	GET	Returns the list of filtered notification configurations on a connection
get_default_filtered_notification_configuration	GET	Returns a model of the filtered notification from default notifications
get_default_filtered_notifications_configurations	GET	Returns the list of filtered notification configurations on default notifications
update_connection_filtered_notification_configuration	PUT	Updates a filtered notification configuration according to the provided model
update_default_filtered_notification_configuration	PUT	Updates a filtered notification configuration on default notifications according to the provided model

healthcheck

Health check operations for checking if the DQOps service is up and operational. Used for monitoring by load balancers.

Operation name	HTTP call	Description
is_healthy	GET	Checks if the DQOps instance is healthy and operational. Returns a text "OK" and a HTTP status code 200 when the service is active and can accept jobs, or returns a text "UNAVAILABLE" and a HTTP status code 503 when the service is still starting or is shutting down.

incidents

Data quality incidents controller that supports reading and updating data quality incidents, such as changing the incident status or assigning an external ticket number.

Operation name	HTTP call	Description
disable_checks_for_incident	POST	Disables all data quality checks that caused a given data quality incident.
find_connection_incident_stats	GET	Returns a list of connection names with incident statistics - the count of recent open incidents.
find_recent_incidents_on_connection	GET	Returns a list of recent data quality incidents.
find_top_incidents_grouped	GET	Finds the most recent incidents grouped by one of the incident's attribute, such as a data quality dimension, a data quality check category or the connection name.
get_incident	GET	Return a single data quality incident's details.
get_incident_histogram	GET	Generates a histogram of data quality issues for each day, returning the number of data quality issues on that day. The other histograms are by a column name and by a check name.
get_incident_issues	GET	Return a paged list of failed data quality check results that are related to an incident.
recalibrate_checks_for_incident	POST	Recalibrates all data quality checks that caused a given data quality incident to generate less issues by changing the data quality rule parameters.
set_incident_issue_url	POST	Changes the incident's issueUrl to a new status.
set_incident_status	POST	Changes the incident's status to a new status.

jobs

Jobs management controller that supports starting new jobs, such as running selected data quality checks. Provides access to the job queue for incremental monitoring.

Operation name	HTTP call	Description
cancel_job	DELETE	Cancels a running job
collect_error_samples	POST	Starts a new background job that will run selected data quality checks to collect their error samples
collect_statistics_on_data_groups	POST	Starts a new background job that will run selected data statistics collectors on tables, calculating separate metric for each data grouping
collect_statistics_on_table	POST	Starts a new background job that will run selected data statistics collectors for the entire table
delete_stored_data	POST	Starts a new background job that will delete stored data about check results, sensor readouts etc.
get_all_jobs	GET	Retrieves a list of all queued and recently finished jobs.
get_job	GET	Retrieves the current status of a single job, identified by a job id.
get_job_changes_since	GET	Retrieves an incremental list of job changes (new jobs or job status changes)
import_tables	POST	Starts a new background job that will import selected tables.
is_cron_scheduler_running	GET	Checks if the DQOps internal CRON scheduler is running and processing jobs scheduled using cron expressions.
run_checks	POST	Starts a new background job that will run selected data quality checks
start_cron_scheduler	POST	Starts the job scheduler that runs monitoring jobs that are scheduled by assigning cron expressions.
stop_cron_scheduler	POST	Stops the job scheduler that runs monitoring jobs that are scheduled by assigning cron expressions.
synchronize_folders	POST	Starts multiple file synchronization jobs that will synchronize files from selected DQOps User home folders to the DQOps Cloud. The default synchronization mode is a full synchronization (upload local files, download new files from the cloud).
wait_for_collect_error_samples_job	GET	Waits for a job to finish. Returns the status of a finished job or a current state of a job that is still running, but the wait timeout elapsed.
wait_for_job	GET	Waits for a job to finish. Returns the status of a finished job or a current state of a job that is still running, but the wait timeout elapsed.
wait_for_run_checks_job	GET	Waits for a job to finish. Returns the status of a finished job or a current state of a job that is still running, but the wait timeout elapsed.

labels

Operations that returns all labels that are assigned to data assets. Labels serve the purpose of a lazy business glossary.

Operation name	HTTP call	Description
get_all_labels_for_columns	GET	Returns a list of all labels applied to columns, including the count of assignments to these data assets.
get_all_labels_for_connections	GET	Returns a list of all labels applied to the connections to data sources, including the count of assignments to these data assets.
get_all_labels_for_tables	GET	Returns a list of all labels applied to tables, including the count of assignments to these data assets.

log_shipping

Log shipping controller that accepts logs sent from a web application or external tools and aggregates them in the local DQOps instance logs.

Operation name	HTTP call	Description
log_debug	POST	Logs an information message in the server's logs as a debug severity log entry.
log_error	POST	Logs an information message in the server's logs as an error severity log entry.
log_info	POST	Logs an information message in the server's logs as an info severity log entry.
log_warn	POST	Logs an information message in the server's logs as a warn severity log entry.

rule_mining

Performs rule mining and proposes the configuration of data quality checks and their rule thresholds for tables.

Operation name	HTTP call	Description
apply_proposed_monitoring_checks	PUT	Applies the proposed configuration of data quality monitoring checks on a table.
apply_proposed_partitioned_checks	PUT	Applies the proposed configuration of data quality partitioned checks on a table.
apply_proposed_profiling_checks	PUT	Applies the proposed configuration of data quality profiling checks on a table.
propose_table_monitoring_checks	POST	Proposes the configuration of monitoring checks on a table by generating suggested configuration of checks and their rule thresholds.
propose_table_partitioned_checks	POST	Proposes the configuration of partitioned checks on a table by generating suggested configuration of checks and their rule thresholds.
propose_table_profiling_checks	POST	Proposes the configuration of profiling checks on a table by generating suggested configuration of checks and their rule thresholds.

rules

Operations for managing custom data quality rule definitions in DQOps. The custom rules are stored in the DQOps user home folder.

Operation name	HTTP call	Description
create_rule	POST	Creates (adds) a new custom rule given the rule definition.
delete_rule	DELETE	Deletes a custom rule definition
get_all_rules	GET	Returns a flat list of all rules available in DQOps, both built-in rules and user defined or customized rules.
get_rule	GET	Returns a rule definition
get_rule_folder_tree	GET	Returns a tree of all rules available in DQOps, both built-in rules and user defined or customized rules.
update_rule	PUT	Updates an existing rule, making a custom rule definition if it is not present

schemas

Operations for listing imported schemas from monitored data sources. Also provides operations for activating and deactivating multiple checks at once.

Operation name	HTTP call	Description
get_schema_monitoring_checks_model	GET	Return a UI friendly model of configurations for data quality monitoring checks on a schema
get_schema_monitoring_checks_templates	GET	Return available data quality checks on a requested schema.
get_schema_partitioned_checks_model	GET	Return a UI friendly model of configurations for data quality partitioned checks on a schema
get_schema_partitioned_checks_templates	GET	Return available data quality checks on a requested schema.
get_schema_profiling_checks_model	GET	Return a flat list of configurations for profiling checks on a schema
get_schema_profiling_checks_templates	GET	Return available data quality checks on a requested schema.
get_schemas	GET	Returns a list of schemas inside a connection

search

Search operations for finding data assets, such as tables.

Operation name	HTTP call	Description
find_columns	GET	Finds columns in any data source and schema
find_tables	GET	Finds tables in any data source and schema

sensor_readouts

Operations that are retrieving the data quality sensor readouts of executed checks on tables and columns.

Operation name	HTTP call	Description
get_column_monitoring_sensor_readouts	GET	Returns a complete view of the sensor readouts for recent column level monitoring executions for the monitoring at a requested time scale
get_column_partitioned_sensor_readouts	GET	Returns a view of the sensor readouts for recent column level partitioned checks executions for a requested time scale
get_column_profiling_sensor_readouts	GET	Returns sensor results of the recent check executions for all column level data quality profiling checks on a column
get_table_monitoring_sensor_readouts	GET	Returns the complete results of the most recent table level monitoring executions for the monitoring at a requested time scale
get_table_partitioned_sensor_readouts	GET	Returns a complete view of sensor readouts for recent table level partitioned checks executions for a requested time scale
get_table_profiling_sensor_readouts	GET	Returns the complete results of the most recent check executions for all table level data quality profiling checks on a table

sensors

Operations for managing custom data quality sensor definitions in DQOps. The custom sensors are stored in the DQOps user home folder.

Operation name	HTTP call	Description
create_sensor	POST	Creates (adds) a new sensor given sensor information.
delete_sensor	DELETE	Deletes a custom sensor definition
get_all_sensors	GET	Returns a flat list of all sensors available in DQOps, both built-in sensors and user defined or customized sensors.
get_sensor	GET	Returns a sensor model
get_sensor_folder_tree	GET	Returns a tree of all sensors available in DQOps, both built-in sensors and user defined or customized sensors.
update_sensor	PUT	Updates an existing sensor, making a custom sensor definition if it is not present.
Removes sensor if custom definition is same as Dqo Home sensor

shared_credentials

Operations for managing shared credentials in DQOps. Credentials that are stored in the shared .credentials folder in the DQOps user's home folder.

Operation name	HTTP call	Description
create_shared_credential	POST	Creates (adds) a new shared credential, which creates a file in the DQOps user's home .credentials/ folder named as the credential and with the content that is provided in this call.
delete_shared_credential	DELETE	Deletes a shared credential file from the DQOps user's home .credentials/ folder.
download_shared_credential	GET	Downloads a shared credential's file
get_all_shared_credentials	GET	Returns a list of all shared credentials that are present in the DQOps user's home .credentials/ folder.
get_shared_credential	GET	Returns a shared credential content
update_shared_credential	PUT	Updates an existing shared credential, replacing the credential's file content.

table_comparison_results

Operations that returns the results of the most recent table comparison that was performed between the compared table and the reference table (the source of truth).

Operation name	HTTP call	Description
get_table_comparison_monitoring_results	GET	Retrieves the results of the most table comparison performed using the monitoring comparison checks.
get_table_comparison_partitioned_results	GET	Retrieves the results of the most table comparison performed using the partitioned comparison checks, comparing days or months of data.
get_table_comparison_profiling_results	GET	Retrieves the results of the most table comparison performed using the profiling checks comparison checks.

table_comparisons

Operations for managing the configurations of table comparisons between tables on the same or different data sources

Operation name	HTTP call	Description
create_table_comparison_configuration	POST	Creates a new table comparison configuration added to the compared table
create_table_comparison_monitoring_daily	POST	Creates a table comparison configuration using daily monitoring checks
create_table_comparison_monitoring_monthly	POST	Creates a table comparison configuration using monthly monitoring checks
create_table_comparison_partitioned_daily	POST	Creates a table comparison configuration using daily partitioned checks
create_table_comparison_partitioned_monthly	POST	Creates a table comparison configuration using monthly partitioned checks
create_table_comparison_profiling	POST	Creates a table comparison configuration using profiling checks
delete_table_comparison_configuration	DELETE	Deletes a table comparison configuration from a compared table
get_table_comparison_configuration	GET	Returns a model of the table comparison configuration
get_table_comparison_configurations	GET	Returns the list of table comparison configurations on a compared table
get_table_comparison_monitoring_daily	GET	Returns a model of the table comparison using daily monitoring checks (comparison once a day)
get_table_comparison_monitoring_monthly	GET	Returns a model of the table comparison using monthly monitoring checks (comparison once a month)
get_table_comparison_partitioned_daily	GET	Returns a model of the table comparison using daily partition checks (comparing day to day)
get_table_comparison_partitioned_monthly	GET	Returns a model of the table comparison using monthly partition checks (comparing month to month)
get_table_comparison_profiling	GET	Returns a model of the table comparison using profiling checks (comparison at any time)
update_table_comparison_configuration	PUT	Updates a table configuration configuration
update_table_comparison_monitoring_daily	PUT	Updates a table comparison checks monitoring daily
update_table_comparison_monitoring_monthly	PUT	Updates a table comparison checks monitoring monthly
update_table_comparison_partitioned_daily	PUT	Updates a table comparison checks partitioned daily (comparing day to day)
update_table_comparison_partitioned_monthly	PUT	Updates a table comparison checks partitioned monthly (comparing month to month)
update_table_comparison_profiling	PUT	Updates a table comparison profiling checks

table_quality_policies

Operations for managing the configuration of data quality policies at a table level. Policies are the default configuration of data quality checks for tables matching a pattern.

Operation name	HTTP call	Description
copy_from_table_quality_policy	POST	Creates (adds) a copy of an existing default table-level checks pattern configuration (data quality policy) under a new name.
create_table_quality_policy_pattern	POST	Creates (adds) a new default table-level checks pattern (data quality policy) configuration by saving a full specification object.
create_table_quality_policy_target	POST	Creates (adds) a new default table-level checks pattern configuration (a table-level data quality policy).
delete_table_quality_policy	DELETE	Deletes a default table-level checks pattern (a data quality policy at a column level).
get_monitoring_daily_table_quality_policy	GET	Returns UI model to show and edit the default configuration of the daily monitoring checks that are configured for a check pattern on a table level.
get_monitoring_monthly_table_quality_policy	GET	Returns UI model to show and edit the default configuration of the monthly monitoring checks that are configured for a check pattern on a table level.
get_partitioned_daily_table_quality_policy	GET	Returns UI model to show and edit the default configuration of the daily partitioned checks that are configured for a check pattern on a table level.
get_partitioned_monthly_table_quality_policy	GET	Returns UI model to show and edit the default configuration of the monthly partitioned checks that are configured for a check pattern on a table level.
get_profiling_table_quality_policy	GET	Returns UI model to show and edit the default configuration of the profiling checks that are configured for a check pattern on a table level.
get_table_quality_policies	GET	Returns a flat list of all table-level default check patterns (data quality policies) configured for this instance. Default checks are applied on tables dynamically.
get_table_quality_policy	GET	Returns a default table-level checks pattern (data quality policy) definition as a full specification object
get_table_quality_policy_target	GET	Returns a default checks pattern definition (a data quality policy)
update_monitoring_daily_table_quality_policy	PUT	New configuration of the default daily monitoring checks on a table level. These checks will be applied to tables.
update_monitoring_monthly_table_quality_policy	PUT	New configuration of the default monthly monitoring checks on a table level. These checks will be applied to tables.
update_partitioned_daily_table_quality_policy	PUT	New configuration of the default daily partitioned checks on a table level. These checks will be applied to tables.
update_partitioned_monthly_table_quality_policy	PUT	New configuration of the default monthly partitioned checks on a table level. These checks will be applied to tables.
update_profiling_table_quality_policy	PUT	New configuration of the default profiling checks on a table level. These checks will be applied to tables.
update_table_quality_policy	PUT	Updates an default table-level checks pattern (data quality policy) by saving a full specification object
update_table_quality_policy_target	PUT	Updates an default table-level checks pattern (data quality policy), changing only the target object

tables

Operations related to manage the metadata of imported tables, and managing the configuration of table-level data quality checks.

Operation name	HTTP call	Description
create_table	POST	Creates a new table (adds a table metadata)
delete_table	DELETE	Deletes a table
find_similar_tables	GET	Finds a list of tables that are most similar to a given table
get_table	GET	Return the table specification
get_table_basic	GET	Return the basic table information
get_table_columns_monitoring_checks_model	GET	Return a UI friendly model of configurations for column-level data quality monitoring checks on a table
get_table_columns_partitioned_checks_model	GET	Return a UI friendly model of configurations for column-level data quality partitioned checks on a table
get_table_columns_profiling_checks_model	GET	Return a UI friendly model of configurations for column-level data quality profiling checks on a table
get_table_comments	GET	Return the list of comments added to a table
get_table_daily_monitoring_checks	GET	Return the configuration of daily table level data quality monitoring on a table
get_table_daily_partitioned_checks	GET	Return the configuration of daily table level data quality partitioned checks on a table
get_table_default_grouping_configuration	GET	Return the default data grouping configuration for a table.
get_table_incident_grouping	GET	Return the configuration of incident grouping on a table
get_table_labels	GET	Return the list of labels assigned to a table
get_table_monitoring_checks_basic_model	GET	Return a simplistic UI friendly model of table level data quality monitoring on a table for a given time scale
get_table_monitoring_checks_model	GET	Return a UI friendly model of configurations for table level data quality monitoring on a table for a given time scale
get_table_monitoring_checks_model_filter	GET	Return a UI friendly model of configurations for table level data quality monitoring on a table for a given time scale, filtered by category and check name.
get_table_monitoring_checks_monthly	GET	Return the configuration of monthly table level data quality monitoring on a table
get_table_monitoring_checks_templates	GET	Return available data quality checks on a requested table.
get_table_partitioned_checks_basic_model	GET	Return a simplistic UI friendly model of table level data quality partitioned checks on a table for a given time scale
get_table_partitioned_checks_model	GET	Return a UI friendly model of configurations for table level data quality partitioned checks on a table for a given time scale
get_table_partitioned_checks_model_filter	GET	Return a UI friendly model of configurations for table level data quality partitioned checks on a table for a given time scale, filtered by category and check name.
get_table_partitioned_checks_monthly	GET	Return the configuration of monthly table level data quality partitioned checks on a table
get_table_partitioned_checks_templates	GET	Return available data quality checks on a requested table.
get_table_partitioning	GET	Return the table partitioning information
get_table_profiling_checks	GET	Return the configuration of table level data quality checks on a table
get_table_profiling_checks_basic_model	GET	Return a simplistic UI friendly model of all table level data quality profiling checks on a table
get_table_profiling_checks_model	GET	Return a UI friendly model of configurations for all table level data quality profiling checks on a table
get_table_profiling_checks_model_filter	GET	Return a UI friendly model of configurations for all table level data quality profiling checks on a table passing a filter
get_table_profiling_checks_templates	GET	Return available data quality checks on a requested table.
get_table_profiling_status	GET	Return the status of profiling the table, which provides hints to the user about which profiling steps were not yet performed
get_table_scheduling_group_override	GET	Return the schedule override configuration for a table
get_table_statistics	GET	Returns a list of the profiler (statistics) metrics on a chosen table captured during the most recent statistics collection.
get_tables	GET	Returns a list of tables inside a connection/schema
update_table	PUT	Updates an existing table specification, changing all the fields
update_table_basic	PUT	Updates the basic field of an existing table, changing only the most important fields.
update_table_comments	PUT	Updates the list of comments on an existing table.
update_table_daily_monitoring_checks	PUT	Updates the list of daily table level data quality monitoring on an existing table.
update_table_default_grouping_configuration	PUT	Updates the default data grouping configuration at a table level.
update_table_incident_grouping	PUT	Updates the configuration of incident grouping on a table.
update_table_labels	PUT	Updates the list of assigned labels of an existing table.
update_table_monitoring_checks_model	PUT	Updates the data quality monitoring from a model that contains a patch with changes.
update_table_monitoring_checks_monthly	PUT	Updates the list of monthly table level data quality monitoring on an existing table.
update_table_partitioned_checks_daily	PUT	Updates the list of daily table level data quality partitioned checks on an existing table.
update_table_partitioned_checks_model	PUT	Updates the data quality partitioned checks from a model that contains a patch with changes.
update_table_partitioned_checks_monthly	PUT	Updates the list of monthly table level data quality partitioned checks on an existing table.
update_table_partitioning	PUT	Updates the table partitioning configuration of an existing table.
update_table_profiling_checks	PUT	Updates the list of table level data quality profiling checks on an existing table.
update_table_profiling_checks_model	PUT	Updates the data quality profiling checks from a model that contains a patch with changes.
update_table_scheduling_group_override	PUT	Updates the overridden schedule configuration of an existing table for a named schedule group (named schedule for checks using the same time scale).

timezones

Operations for returning time zone names and codes supported by DQOps.

Operation name	HTTP call	Description
get_available_zone_ids	GET	Returns a list of available time zone ids

users

Operations for managing access for DQOps users in a multi-user installations. User management is supported in the TEAM and ENTERPRISE licences.

Operation name	HTTP call	Description
change_caller_password	PUT	Changes the password of the calling user. When the user is identified by the DQOps local API key, it is the user whose email is stored in the DQOps API Key.
change_user_password	PUT	Changes the password of a user identified by the email.
create_user	POST	Creates (adds) a new user to a multi-user account.
delete_user	DELETE	Deletes a user from a multi-user account.
get_all_users	GET	Returns a list of all users.
get_user	GET	Returns the user model that describes the role of a user identified by an email
update_user	PUT	Updates a user in a multi-user account. The user's email cannot be changed.