List Experiments

GET

///apis/intake/v2/workspaces/:workspace/experiments

GET

/apis/intake/v2/workspaces/:workspace/experiments

curl /apis/intake/v2/workspaces/workspace/experiments

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "workspace": "string",
      "default_sort": "string",
      "description": "string",
      "insight_id": "string",
      "summary": "string",
      "metadata": {},
      "pareto": {
        "x_metric": "cost_usd",
        "y_metric": "latency_ms"
      },
      "column_layout": {
        "order": [
          "string"
        ],
        "hidden": [
          "string"
        ]
      },
      "is_favorite": false,
      "show_evaluations_over_time": false,
      "baseline_evaluation_name": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "evaluation_count": 0
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "current_page_size": 1,
    "total_pages": 1,
    "total_results": 1
  },
  "sort": "string",
  "filter": {}
}

Path parameters

workspacestringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

Page number.

page_sizeintegerOptional1-1000Defaults to 100

Page size.

sortenumOptionalDefaults to -created_at

Sort field; prefix with ’-’ for descending.

filterobjectOptional

Filter experiments by name, insight_id, is_favorite, show_evaluations_over_time, baseline_evaluation_name, is_deleted, or a metadata key/value (filter[metadata.<key>]=<value>). Pass is_deleted=true to return only soft-deleted experiments; omit to see only live ones.

Response

Successful Response

datalist of objects

paginationobjectOptional

Pagination information.

sortstringOptional

The field on which the results are sorted.

filtermap from strings to anyOptional

Filtering information.

Errors

422

Unprocessable Entity Error