Skip to content

Last updated: July 22, 2025

DQOps REST API table_comparison_results operations

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).


get_table_comparison_monitoring_results

Retrieves the results of the most table comparison performed using the monitoring comparison checks.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/{timeScale}/comparisons/{tableComparisonConfigurationName}/results

Return value

 Property name   Description                       Data type 
table_comparison_results_model TableComparisonResultsModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
schema_name Schema name string
table_name Table name string
time_scale Time scale CheckTimeScale
table_comparison_configuration_name Table comparison configuration name string

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/daily/comparisons/sample_table_comparison/results^
    -H "Accept: application/json"
Expand to see the returned result
{
  "table_comparison_results" : { },
  "column_comparison_results" : { }
}

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_monitoring_results
from dqops.client.models import CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_table_comparison_monitoring_results.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_monitoring_results
from dqops.client.models import CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_table_comparison_monitoring_results.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_monitoring_results
from dqops.client.models import CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_table_comparison_monitoring_results.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_monitoring_results
from dqops.client.models import CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_table_comparison_monitoring_results.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

get_table_comparison_partitioned_results

Retrieves the results of the most table comparison performed using the partitioned comparison checks, comparing days or months of data.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/{timeScale}/comparisons/{tableComparisonConfigurationName}/results

Return value

 Property name   Description                       Data type 
table_comparison_results_model TableComparisonResultsModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
schema_name Schema name string
table_name Table name string
time_scale Time scale CheckTimeScale
table_comparison_configuration_name Table comparison configuration name string

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/daily/comparisons/sample_table_comparison/results^
    -H "Accept: application/json"
Expand to see the returned result
{
  "table_comparison_results" : { },
  "column_comparison_results" : { }
}

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_partitioned_results
from dqops.client.models import CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_table_comparison_partitioned_results.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_partitioned_results
from dqops.client.models import CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_table_comparison_partitioned_results.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_partitioned_results
from dqops.client.models import CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_table_comparison_partitioned_results.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_partitioned_results
from dqops.client.models import CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_table_comparison_partitioned_results.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

get_table_comparison_profiling_results

Retrieves the results of the most table comparison performed using the profiling checks comparison checks.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling/comparisons/{tableComparisonConfigurationName}/results

Return value

 Property name   Description                       Data type 
table_comparison_results_model TableComparisonResultsModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
schema_name Schema name string
table_name Table name string
table_comparison_configuration_name Table comparison configuration name string

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling/comparisons/sample_table_comparison/results^
    -H "Accept: application/json"
Expand to see the returned result
{
  "table_comparison_results" : { },
  "column_comparison_results" : { }
}

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_profiling_results

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_table_comparison_profiling_results.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_profiling_results

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_table_comparison_profiling_results.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_profiling_results

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_table_comparison_profiling_results.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)

Execution

from dqops import client
from dqops.client.api.table_comparison_results import get_table_comparison_profiling_results

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_table_comparison_profiling_results.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_table_comparison',
    client=dqops_client
)
Expand to see the returned result
TableComparisonResultsModel(
    table_comparison_results={

    },
    column_comparison_results={

    }
)