---
title: "Get Data Check"
method: POST
path: "/data-check/{id}/get-item"
tags: ["Data Check"]
---

# Get Data Check

`POST /data-check/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/data-check/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/data-check/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Data Check by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` DataCheckSelectSchema: Select schema for DataCheck. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `dataAssetId` boolean
    - `dataStoreId` boolean
    - `name` boolean
    - `description` boolean
    - `checkType` boolean
    - `columnName` boolean
    - `segmentColumn` boolean
    - `acceptedValues` boolean
    - `pattern` boolean
    - `formatPreset` boolean
    - `samplePercent` boolean
    - `referenceTableKey` boolean
    - `referenceColumnName` boolean
    - `customSql` boolean
    - `intervalInMinutes` boolean
    - `isEnabled` boolean
    - `isManagedByFile` boolean
    - `alertCondition` boolean
    - `alertThreshold` boolean
    - `monitorId` boolean
    - `dataReconciliationId` boolean
    - `lastRunAt` boolean
    - `lastRunStatus` boolean
    - `lastRunMessage` boolean
    - `lastValue` boolean
    - `failingRowsSample` boolean
    - `lastSegmentCount` boolean
    - `externalId` boolean
    - `createdByUserId` boolean

## Response `200`

Successful response

- object
  - `data` DataCheck
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `dataAssetId` string, uuid, required: ID of the table the check reads. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `dataStoreId` string, uuid: ID of the data store the table is in, set from the table. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `name` string, required: What the check is called, as its metric and alerts name it. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `description` string: Why the check matters, and what to do when it fails. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `checkType` 'Null Percent' | 'Duplicate Percent' | 'Distinct Count' | 'Minimum' | 'Maximum' | 'Average' | 'Sum' | 'Invalid Percent' | 'Format Mismatch Percent' | 'Orphan Count' | 'Row Count' | 'Custom SQL' | 'Failing Rows' | 'dbt Test', required: What the check measures. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `columnName` string: The column the check reads, for a check on one column. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `segmentColumn` string: Run the check once per value of this column - a tenant, a region - one series each, the largest 100. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `acceptedValues` object: For Invalid Percent: the values the column may hold. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `pattern` string: For Format Mismatch Percent: the regular expression every value must match. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `formatPreset` string: For Format Mismatch Percent: a format everyone wants, instead of writing the pattern. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `samplePercent` number: Read this percent of the table's rows instead of all of them, for a check that reads a rate. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `referenceTableKey` string: For Orphan Count: the table the column refers to, as schema.table. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `referenceColumnName` string: For Orphan Count: the column of that table it refers to. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `customSql` string: For Custom SQL: one read-only SELECT returning a number - or, segmented, a segment and a number per row. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `intervalInMinutes` number, required: How often the check runs: 15, 60, 360 or 1440 minutes. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `isEnabled` boolean, required: Whether the check runs. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `isManagedByFile` boolean, required: Whether the check came from a file in a repository (oneuptime data-checks apply). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `alertCondition` 'Unusually High' | 'Unusually Low' | 'Above' | 'Below': When the check's value should alert: unusually high or low for the hour of the week (learned), or above or below a threshold. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `alertThreshold` number: The threshold an Above or Below alert compares with. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset]
    - `monitorId` string, uuid: ID of the Metrics monitor that alerts on the check. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `dataReconciliationId` string, uuid: For a check that reads one side of a reconciliation: the reconciliation's ID. Such a check is changed only from its reconciliation. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `lastRunAt` object: When the check last ran. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `lastRunStatus` string: How the last run went: Ran, or Failed. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `lastRunMessage` string: Why the last run failed, when it did. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `lastValue` number: The value the last run read - the largest segment's, for a segmented check. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `failingRowsSample` object: A masked sample of the rows the last run found failing, when the project keeps them. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `lastSegmentCount` number: How many segments the last run read. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `externalId` string: For a dbt test, the test's unique id in the dbt project, which each upload of its artifacts is matched by. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]
    - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)