List commit test results

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:

The page to return in a paginated query.

Required range: x > 1

perPage

integer

default:

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.

items.projectVersionId

string | null

required

The project version (commit) id.

items.inferencePipelineId

string | null

required

The inference pipeline id.

items.dateCreated

string

required

The creation date.

items.dateUpdated

string

required

The last updated date.

items.dateDataStarts

string | null

required

The data start date.

items.dateDataEnds

string | null

required

The data end date.

items.status

enum<string>

required

The status of the test.

Available options:

running,

passing,

failing,

skipped,

error

items.statusMessage

string | null

required

The status message.

items.goal

object

items.goal.id

string

required

The test id.

items.goal.number

integer

required

The test number.

items.goal.name

string

required

The test name.

Maximum length: 100

items.goal.dateCreated

string

required

The creation date.

items.goal.dateUpdated

string

required

The last updated date.

items.goal.description

object | null

required

The test description.

items.goal.type

string

required

The test type.

items.goal.subtype

string

required

The test subtype.

items.goal.creatorId

string | null

required

The test creator id.

items.goal.originProjectVersionId

string | null

required

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

items.goal.thresholds

object[]

required

items.goal.dateArchived

string | null

required

The date the test was archived.

items.goal.suggested

boolean

required

Whether the test is suggested or user-created.

items.goal.commentCount

integer

required

The number of comments on the test.

Required range: x > 0

items.goal.evaluationWindow

number | null

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

Required range: x < 2592000

items.goal.delayWindow

number | null

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

Required range: 0 < x < 2592000

items.goal.archived

boolean

Whether the test is archived.

items.goal.usesMlModel

boolean

Whether the test uses an ML model.

items.goal.usesValidationDataset

boolean

Whether the test uses a validation dataset.

items.goal.usesTrainingDataset

boolean

Whether the test uses a training dataset.

items.goal.usesReferenceDataset

boolean

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

items.goal.usesProductionData

boolean

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

items.goalId

string | null

The test id.

Reference

SDKs

CLI

REST API

List commit test results

Authorizations

Path Parameters

Query Parameters

Response