---
title: "Add Check Runs"
method: POST
path: "/dataquality/checkruns/{orgAgentId}"
tags: ["data quality", "experimental"]
---

# Add Check Runs

`POST /dataquality/checkruns/{orgAgentId}`

Add executions of a check against a metadata resource.

Access requirement: Requires an admin token. It also requires admin access to the organization.

This endpoint is in active development. Its definition and behavior may change frequently and without notice.

## Path parameters

- `orgAgentId` string, required

## Query parameters

- `collectionIri` string, required

## Request body

- CheckRunsDto — Executions of a check against a metadata resource
  - `checkRuns` CheckRunDto[], required — The list of executions
    - `config` CheckDto, required — Check definition
      - `description` string — Description of the check
      - `dimension` string — The dimension of the check, e.g. 'validation', 'data freshness', 'anomalies', etc.
      - `id` string, required — Unique identifier of the check
      - `lastUpdated` string, date-time, required — The time when the check was created or last updated.
      - `priorityLevel` string — Priority level
      - `query` string, required — SQL query of the check. Or the name of an internal function like "TableExistsBasic"
      - `resource` DatabaseResource, required
        - `type` 'IRI' | 'DATABASE' | 'TABLE' | 'COLUMN', required
      - `source` string, required — Data quality provider where this Check came from
      - `title` string, required — Title of the check
      - `url` string, uri — Check URL
      - `weight` number, double — A multiplier to the score of a Check Run. If a Check Run results in a score of 10 and the Check has a weight of 1.5, the overall score for the resource will be interpreted as 15.
    - `end` string, date-time, required — Time when execution was completed
    - `evaluatedMessage` string — Success or error message
    - `historyMessage` string — Message describing how many runs have passed/failed in the past
    - `result` 'PASS' | 'FAIL' | 'WARN', required — Execution status
    - `runSuccessful` boolean, required — Indicates whether execution was completed successfully
    - `score` number, double — Evaluated score for the resource after this check run
    - `start` string, date-time, required — Time when execution was started
    - `url` string, uri — Check execution URL

## Response `202`

Accepted

- SuccessMessage
  - `message` string

## Other responses

- `400` — Bad Request
- `401` — User is unauthorized to perform action
- `403` — Access forbidden
- `404` — Not found
- `500` — Server error

---

[API](https://skmtc.dev/data/apis/data-world-public-api.md) · [All operations](https://skmtc.dev/data/apis/data-world-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/data/data-world-public-api/revisions/0a0cb1f94dad/schema)