Skip to content

Last updated: July 22, 2025

DQOps REST API error_samples operations

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.


get_column_monitoring_error_samples

Returns error samples related to a column level monitoring checks at a requested time scale

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/monitoring/{timeScale}/errorsamples

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
column_name Column name string
time_scale Time scale CheckTimeScale
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/monitoring/daily/errorsamples^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_monitoring_error_samples
from dqops.client.models import CheckTimeScale

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

call_result = get_column_monitoring_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_monitoring_error_samples
from dqops.client.models import CheckTimeScale

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

call_result = await get_column_monitoring_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_monitoring_error_samples
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_column_monitoring_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_monitoring_error_samples
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_column_monitoring_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_column_partitioned_error_samples

Returns the error samples related to column level partitioned checks for a requested time scale

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/partitioned/{timeScale}/errorsamples

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
column_name Column name string
time_scale Time scale CheckTimeScale
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/partitioned/daily/errorsamples^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_partitioned_error_samples
from dqops.client.models import CheckTimeScale

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

call_result = get_column_partitioned_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_partitioned_error_samples
from dqops.client.models import CheckTimeScale

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

call_result = await get_column_partitioned_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_partitioned_error_samples
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_column_partitioned_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_partitioned_error_samples
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_column_partitioned_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_column_profiling_error_samples

Returns the error samples related to a profiling check for all column level data quality profiling checks on a column

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/profiling/errorsamples

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
column_name Column name string
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/profiling/errorsamples^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_profiling_error_samples

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

call_result = get_column_profiling_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_profiling_error_samples

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

call_result = await get_column_profiling_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_profiling_error_samples

token = 's4mp13_4u7h_70k3n'

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

call_result = get_column_profiling_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_profiling_error_samples

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_column_profiling_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_column_profiling_error_samples_download

Returns the error samples in CSV format related to a check for one of table level data quality profiling checks on a column

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/profiling/errorsamples/download

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
column_name Column name string
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/profiling/errorsamples/download^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_profiling_error_samples_download

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

call_result = get_column_profiling_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_profiling_error_samples_download

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

call_result = await get_column_profiling_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_profiling_error_samples_download

token = 's4mp13_4u7h_70k3n'

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

call_result = get_column_profiling_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_column_profiling_error_samples_download

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_column_profiling_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_monitoring_profiling_error_samples_download

Returns error samples in CSV format related to a column level monitoring checks at a requested time scale

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/monitoring/{timeScale}/errorsamples/download

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
column_name Column name string
time_scale Time scale CheckTimeScale
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/monitoring/daily/errorsamples/download^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_monitoring_profiling_error_samples_download
from dqops.client.models import CheckTimeScale

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

call_result = get_monitoring_profiling_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_monitoring_profiling_error_samples_download
from dqops.client.models import CheckTimeScale

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

call_result = await get_monitoring_profiling_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_monitoring_profiling_error_samples_download
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_monitoring_profiling_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_monitoring_profiling_error_samples_download
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_monitoring_profiling_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_partitioned_profiling_error_samples_download

Returns the error samples in CSV format related to column level partitioned checks for a requested time scale

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/partitioned/{timeScale}/errorsamples/download

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
column_name Column name string
time_scale Time scale CheckTimeScale
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/partitioned/daily/errorsamples/download^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_partitioned_profiling_error_samples_download
from dqops.client.models import CheckTimeScale

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

call_result = get_partitioned_profiling_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_partitioned_profiling_error_samples_download
from dqops.client.models import CheckTimeScale

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

call_result = await get_partitioned_profiling_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_partitioned_profiling_error_samples_download
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_partitioned_profiling_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_partitioned_profiling_error_samples_download
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_partitioned_profiling_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    'sample_column',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_table_monitoring_error_samples

Returns the error samples related to a table level monitoring check a requested time scale

Follow the link to see the source code on GitHub.

GET

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

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/daily/errorsamples^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_monitoring_error_samples
from dqops.client.models import CheckTimeScale

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

call_result = get_table_monitoring_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_monitoring_error_samples
from dqops.client.models import CheckTimeScale

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

call_result = await get_table_monitoring_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_monitoring_error_samples
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_monitoring_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_monitoring_error_samples
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_monitoring_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_table_monitoring_error_samples_download

Returns the error samples in CSV format related to a table level monitoring check a requested time scale

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/{timeScale}/errorsamples/download

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/daily/errorsamples/download^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_monitoring_error_samples_download
from dqops.client.models import CheckTimeScale

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

call_result = get_table_monitoring_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_monitoring_error_samples_download
from dqops.client.models import CheckTimeScale

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

call_result = await get_table_monitoring_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_monitoring_error_samples_download
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_monitoring_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_monitoring_error_samples_download
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_monitoring_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_table_partitioned_error_samples

Returns error samples related to a table level partitioned check for a requested time scale

Follow the link to see the source code on GitHub.

GET

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

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/daily/errorsamples^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_partitioned_error_samples
from dqops.client.models import CheckTimeScale

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

call_result = get_table_partitioned_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_partitioned_error_samples
from dqops.client.models import CheckTimeScale

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

call_result = await get_table_partitioned_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_partitioned_error_samples
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_partitioned_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_partitioned_error_samples
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_partitioned_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_table_partitioned_error_samples_download

Returns error samples in CSV format related to a table level partitioned check for a requested time scale

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/{timeScale}/errorsamples/download

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/daily/errorsamples/download^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_partitioned_error_samples_download
from dqops.client.models import CheckTimeScale

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

call_result = get_table_partitioned_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_partitioned_error_samples_download
from dqops.client.models import CheckTimeScale

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

call_result = await get_table_partitioned_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_partitioned_error_samples_download
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_partitioned_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_partitioned_error_samples_download
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_partitioned_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    CheckTimeScale.daily,
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_table_profiling_error_samples

Returns the error samples related to a check for all table level data quality profiling checks on a table

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling/errorsamples

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling/errorsamples^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_profiling_error_samples

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

call_result = get_table_profiling_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_profiling_error_samples

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

call_result = await get_table_profiling_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_profiling_error_samples

token = 's4mp13_4u7h_70k3n'

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

call_result = get_table_profiling_error_samples.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_profiling_error_samples

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_table_profiling_error_samples.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

get_table_profiling_error_samples_download

Returns the error samples in CSV format related to a check for one of table level data quality profiling checks on a table

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling/errorsamples/download

Return value

 Property name   Description                       Data type 
error_samples_list_model List[ErrorSamplesListModel]

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
data_group Data group string
month_start Month start boundary string
month_end Month end boundary string
check_name Check name string
category Check category name string
table_comparison Table comparison name string
max_results_per_check Maximum number of results per check, the default is 100 long

Usage examples

Execution

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling/errorsamples/download^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
}, {
  "errorSamplesEntries" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_profiling_error_samples_download

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

call_result = get_table_profiling_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_profiling_error_samples_download

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

call_result = await get_table_profiling_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_profiling_error_samples_download

token = 's4mp13_4u7h_70k3n'

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

call_result = get_table_profiling_error_samples_download.sync(
    'sample_connection',
    'sample_schema',
    'sample_table',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.error_samples import get_table_profiling_error_samples_download

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_table_profiling_error_samples_download.asyncio(
    'sample_connection',
    'sample_schema',
    'sample_table',
    client=dqops_client
)
Expand to see the returned result
[
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    ),
    ErrorSamplesListModel(
        error_samples_entries=[

        ]
    )
]