Read Comparative Experiments

Get all comparative experiments for a given dataset.

GET /api/v1/datasets/{dataset_id}/comparative

Error

A valid request URL is required to generate request examples

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "reference_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "experiments_info": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "name": "<string>",
    "description": "<string>",
    "extra": {},
    "feedback_stats": {}
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

dataset_id · string<uuid> · required

Query Parameters

name · string | null

name_contains · string | null

id · string<uuid>[] | null

offset · integer · default: 0

Required range: x >= 0

limit · integer · default: 100

Required range: 1 <= x <= 100

sort_by · enum<string> · default: created_at

Enum for available comparative experiment columns to sort by.

Available options: name, created_at

sort_by_desc · boolean · default: true

Response

200

application/json

Successful Response

id · string<uuid> · required

tenant_id · string<uuid> · required

created_at · string<date-time> · required

modified_at · string<date-time> · required

reference_dataset_id · string<uuid> · required

experiments_info · SimpleExperimentInfo · object[] · required

Show child attributes

name · string | null

description · string | null

extra · Extra · object | null

feedback_stats · Feedback Stats · object | null