Skip to main content
Python
import os
from openlayer import Openlayer

client = Openlayer()
tests = client.projects.tests.list(
  project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)
{
  "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",
      "description": "This test checks for duplicate rows in the dataset.",
      "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": "<unknown>"
            }
          ],
          "thresholdMode": "manual",
          "operator": "<=",
          "value": 0
        }
      ],
      "dateArchived": "2024-03-22T11:31:01.185Z",
      "suggested": false,
      "commentCount": 0,
      "evaluationWindow": 3600,
      "delayWindow": 0,
      "archived": false,
      "usesMlModel": false,
      "usesValidationDataset": true,
      "usesTrainingDataset": false,
      "usesReferenceDataset": false,
      "usesProductionData": false,
      "includeHistoricalData": false,
      "defaultToAllPipelines": true,
      "includePipelines": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "excludePipelines": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

​
projectId
string<uuid>
required

The project id.

Query Parameters

​
page
integer
default:1

The page to return in a paginated query.

Required range: x >= 1
​
perPage
integer
default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100
​
type
enum<string>

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

Available options:
integrity,
consistency,
performance,
fairness,
robustness
​
suggested
boolean
default:false

Filter for suggested tests.

​
includeArchived
boolean
default:false

Filter for archived tests.

​
originVersionId
string<uuid> | null

Retrive tests created by a specific project version. The project version (commit) id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
usesProductionData
boolean | null

Retrive tests with usesProductionData (monitoring).

Response

Status OK.

​
items
object[]
required