v1

latestOpenAPI 3.0.32026-07-223120123.1 KB

Projects

List tests in a project.

List tests under a project.

get/projects/{projectId}/tests

Path parameters

projectIdstring uuid required

The project id.

Query parameters

pageinteger

The page to return in a paginated query.

perPageinteger

Maximum number of items to return per page.

type'integrity' | 'consistency' | 'performance' | 'fairness' | 'robustness'

Filter objects by test type. Available types are integrity, consistency, performance, fairness, and robustness.

suggestedboolean

Filter for suggested tests.

includeArchivedboolean

Filter for archived tests.

originVersionIdstring uuid nullable

The project version (commit) id.

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

Retrive tests created by a specific project version.

usesProductionDataboolean nullable

Retrive tests with usesProductionData (monitoring).

Response

Status OK.

Example response

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "number": 1,
      "name": "No duplicate rows",
      "dateCreated": "2024-03-22T11:31:01.185Z",
      "dateUpdated": "2024-03-22T11:31:01.185Z",
      "evaluationWindow": 3600,
      "type": "integrity",
      "subtype": "duplicateRowCount",
      "creatorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
      "originProjectVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "thresholds": [
        {
          "measurement": "duplicateRowCount",
          "insightName": "duplicateRowCount",
          "insightParameters": [
            {
              "name": "column_name",
              "value": "Age"
            }
          ],
          "operator": "<="
        }
      ],
      "dateArchived": "2024-03-22T11:31:01.185Z",
      "usesValidationDataset": true
    }
  ]
}