ONoneuptime
Data Check

List Data Check

Endpoint to list all Data Check items

post/data-check/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "name": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "checkType": true,
    "columnName": true,
    "segmentColumn": true,
    "formatPreset": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

Example response

{
  "data": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "updatedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "deletedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "version": 42,
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "dataAssetId": "123e4567-e89b-12d3-a456-426614174000",
      "dataStoreId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Orders without a customer",
      "description": "Every order must belong to a customer.",
      "checkType": "Null Percent",
      "columnName": "customer_id",
      "segmentColumn": "tenant_id",
      "acceptedValues": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "pattern": "^[^@\\s]+@[^@\\s]+$",
      "formatPreset": "Email",
      "samplePercent": 42,
      "referenceTableKey": "public.customers",
      "referenceColumnName": "id",
      "customSql": "SELECT COUNT(*) FROM orders WHERE total < 0",
      "intervalInMinutes": 42,
      "isEnabled": true,
      "isManagedByFile": true,
      "alertCondition": "Unusually High",
      "alertThreshold": 42,
      "monitorId": "123e4567-e89b-12d3-a456-426614174000",
      "dataReconciliationId": "123e4567-e89b-12d3-a456-426614174000",
      "lastRunAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "lastRunStatus": "Example short text",
      "lastRunMessage": "This is an example of longer text content that might be stored in this field.",
      "lastValue": 42,
      "failingRowsSample": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "lastSegmentCount": 42,
      "externalId": "This is an example of longer text content that might be stored in this field.",
      "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.