List commit test results

from openlayer import Openlayer

client = Openlayer()
client.commits.test_results.list(
  project_version_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "goal": {
        "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.",
        "evaluationWindow": 3600,
        "delayWindow": 0,
        "type": "integrity",
        "subtype": "duplicateRowCount",
        "creatorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
        "originProjectVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "thresholds": [
          {
            "measurement": "duplicateRowCount",
            "insightName": "duplicateRowCount",
            "insightParameters": [
              {}
            ],
            "operator": "<=",
            "value": 0
          }
        ],
        "archived": false,
        "dateArchived": "2024-03-22T11:31:01.185Z",
        "suggested": false,
        "commentCount": 0,
        "usesMlModel": false,
        "usesValidationDataset": true,
        "usesTrainingDataset": false,
        "usesReferenceDataset": false,
        "usesProductionData": false
      },
      "goalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "projectVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "inferencePipelineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateCreated": "2024-03-22T11:31:01.185Z",
      "dateUpdated": "2024-03-22T11:31:01.185Z",
      "dateDataStarts": "2024-03-22T11:31:01.185Z",
      "dateDataEnds": "2024-03-22T11:31:01.185Z",
      "status": "passing",
      "statusMessage": "Test successfully processed."
    }
  ]
}

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

projectVersionId

string

required

The project version (commit) 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

includeArchived

boolean

default:false

Include archived goals.

Response

200

application/json

Status OK.

items

object[]

required

items.id

string

required

Project version (commit) id.

Example:

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

items.projectVersionId

string | null

required

The project version (commit) id.

Example:

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

items.inferencePipelineId

string | null

required

The inference pipeline id.

Example:

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

items.dateCreated

string

required

The creation date.

Example:

"2024-03-22T11:31:01.185Z"

items.dateUpdated

string

required

The last updated date.

Example:

"2024-03-22T11:31:01.185Z"

items.dateDataStarts

string | null

required

The data start date.

Example:

"2024-03-22T11:31:01.185Z"

items.dateDataEnds

string | null

required

The data end date.

Example:

"2024-03-22T11:31:01.185Z"

items.status

enum<string>

required

The status of the test.

Available options:

running,

passing,

failing,

skipped,

error

Example:

"passing"

items.statusMessage

string | null

required

The status message.

Example:

"Test successfully processed."

items.goal

object

items.goal.id

string

required

The test id.

Example:

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

items.goal.number

integer

required

The test number.

Example:

1

items.goal.name

string

required

The test name.

Maximum length: 100

Example:

"No duplicate rows"

items.goal.dateCreated

string

required

The creation date.

Example:

"2024-03-22T11:31:01.185Z"

items.goal.dateUpdated

string

required

The last updated date.

Example:

"2024-03-22T11:31:01.185Z"

items.goal.description

object | null

required

The test description.

Example:

"This test checks for duplicate rows in the dataset."

items.goal.type

string

required

The test type.

Example:

"integrity"

items.goal.subtype

string

required

The test subtype.

Example:

"duplicateRowCount"

items.goal.creatorId

string | null

required

The test creator id.

Example:

"589ece63-49a2-41b4-98e1-10547761d4b0"

items.goal.originProjectVersionId

string | null

required

The project version (commit) id where the test was created.

Example:

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

items.goal.thresholds

object[]

required

items.goal.dateArchived

string | null

required

The date the test was archived.

Example:

"2024-03-22T11:31:01.185Z"

items.goal.suggested

boolean

required

Whether the test is suggested or user-created.

Example:

false

items.goal.commentCount

integer

required

The number of comments on the test.

Required range: x >= 0

Example:

0

items.goal.evaluationWindow

number | null

The evaluation window in seconds. Only applies to tests that use production data.

Required range: x <= 2592000

Example:

3600

items.goal.delayWindow

number | null

The delay window in seconds. Only applies to tests that use production data.

Required range: 0 <= x <= 2592000

Example:

0

items.goal.archived

boolean

Whether the test is archived.

Example:

false

items.goal.usesMlModel

boolean

Whether the test uses an ML model.

Example:

false

items.goal.usesValidationDataset

boolean

Whether the test uses a validation dataset.

Example:

true

items.goal.usesTrainingDataset

boolean

Whether the test uses a training dataset.

Example:

false

items.goal.usesReferenceDataset

boolean

Whether the test uses a reference dataset (monitoring mode only).

Example:

false

items.goal.usesProductionData

boolean

Whether the test uses production data (monitoring mode only).

Example:

false

items.goalId

string | null

The test id.

Example:

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

Was this page helpful?

Create project commit Create inference pipeline

from openlayer import Openlayer

client = Openlayer()
client.commits.test_results.list(
  project_version_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "goal": {
        "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.",
        "evaluationWindow": 3600,
        "delayWindow": 0,
        "type": "integrity",
        "subtype": "duplicateRowCount",
        "creatorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
        "originProjectVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "thresholds": [
          {
            "measurement": "duplicateRowCount",
            "insightName": "duplicateRowCount",
            "insightParameters": [
              {}
            ],
            "operator": "<=",
            "value": 0
          }
        ],
        "archived": false,
        "dateArchived": "2024-03-22T11:31:01.185Z",
        "suggested": false,
        "commentCount": 0,
        "usesMlModel": false,
        "usesValidationDataset": true,
        "usesTrainingDataset": false,
        "usesReferenceDataset": false,
        "usesProductionData": false
      },
      "goalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "projectVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "inferencePipelineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateCreated": "2024-03-22T11:31:01.185Z",
      "dateUpdated": "2024-03-22T11:31:01.185Z",
      "dateDataStarts": "2024-03-22T11:31:01.185Z",
      "dateDataEnds": "2024-03-22T11:31:01.185Z",
      "status": "passing",
      "statusMessage": "Test successfully processed."
    }
  ]
}

Reference

SDKs

CLI

REST API

List commit test results

Authorizations

Path Parameters

Query Parameters

Response