Last updated: July 22, 2025

DQOps REST API error_samples models reference

The references of all objects used by error_samples REST API operations are listed below.

ErrorSampleResultDataType

Enumeration of data types that were detected as the error sample collector result.

The structure of this object is described below

Data type	Enum values
string	null boolean string integer float date datetime instant time

Time series gradient type (daily, monthly, quarterly, monthly, weekly, hourly).

The structure of this object is described below

Data type	Enum values
string	year quarter month week day hour millisecond

Detailed error samples captured for a single check. Represent one row in the error_samples table.

The structure of this object is described below

Property name	Description	Data type
`id`	Unique ID of the error sample value	string
`result_data_type`	Error sample result data type	ErrorSampleResultDataType
`collected_at`	The local timestamp when the error sample was collected	datetime
`sample_index`	The index of the result that was returned. Identifies a single error sample within a list.	integer
`check_type`	Check type	CheckType
`time_gradient`	Time gradient	TimePeriodGradient
`duration_ms`	Execution duration (ms)	integer
`row_id1`	The value of the first column of the unique identifier that identifies a row containing the error sample.	string
`row_id2`	The value of the second column of the unique identifier that identifies a row containing the error sample.	string
`row_id3`	The value of the third column of the unique identifier that identifies a row containing the error sample.	string
`row_id4`	The value of the fourth column of the unique identifier that identifies a row containing the error sample.	string
`row_id5`	The value of the fifth column of the unique identifier that identifies a row containing the error sample.	string
`column_name`	Column name	string
`data_group`	Data group	string
`provider`	Provider name	string
`quality_dimension`	Data quality dimension	string
`sensor_name`	Sensor name	string
`table_comparison`	Table comparison name	string

List of error samples for a single check. Returned in the context of a single data group, with a supplied list of other data groups.

The structure of this object is described below

Property name	Description	Data type
`check_name`	Check name	string
`check_display_name`	Check display name	string
`check_type`	Check type	CheckType
`check_hash`	Check hash	long
`check_category`	Check category name	string
`data_groups_names`	Data groups list	List[string]
`data_group`	Selected data group	string
`error_samples_entries`	Error samples entries	List[ErrorSampleEntryModel]