Get dataset by name

POST

/v1/private/datasets/retrieve

POST

/api/v1/private/datasets/retrieve

$ curl -X POST http://localhost:5173/api/v1/private/datasets/retrieve \
>      -H "Content-Type: application/json" \
>      -d '{
>   "dataset_name": "Customer Churn Dataset"
> }'

200Successful

1 {
2   "name": "Customer Churn Dataset",
3   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4   "project_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
5   "type": "dataset",
6   "visibility": "private",
7   "tags": [
8     "churn",
9     "customer-data",
10     "telecom"
11   ],
12   "description": "Dataset containing customer churn information for telecom analysis.",
13   "created_at": "2024-01-15T09:30:00Z",
14   "created_by": "data.scientist@company.com",
15   "last_updated_at": "2024-04-10T14:45:00Z",
16   "last_updated_by": "data.engineer@company.com",
17   "experiment_count": 12,
18   "dataset_items_count": 15000,
19   "optimization_count": 5,
20   "most_recent_experiment_at": "2024-04-09T16:20:00Z",
21   "last_created_experiment_at": "2024-04-09T16:20:00Z",
22   "most_recent_optimization_at": "2024-04-08T11:00:00Z",
23   "last_created_optimization_at": "2024-04-08T11:00:00Z",
24   "status": "completed",
25   "latest_version": {
26     "id": "9b2d6f3a-4c3e-4f1a-9a2b-8f7e2d1c5a6b",
27     "version_hash": "a1b2c3d4e5f67890",
28     "version_name": "v3",
29     "change_description": "Added new features for customer demographics and updated labels.",
30     "tags": [
31       "v3",
32       "feature-update"
33     ]
34   }
35 }

Get dataset by name

Request

This endpoint expects an object.

dataset_namestringRequired>=1 character

project_namestringOptional

Response

Dataset resource

namestring>=1 character

idstringOptionalformat: "uuid"

project_idstringOptionalformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

typeenumOptional

visibilityenumOptional

tagslist of stringsOptional

descriptionstringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"0-255 characters

created_atdatetimeOptionalRead-only

created_bystringOptionalRead-only

last_updated_atdatetimeOptionalRead-only

last_updated_bystringOptionalRead-only

experiment_countlongOptionalRead-only

dataset_items_countlongOptionalRead-only

optimization_countlongOptionalRead-only

most_recent_experiment_atdatetimeOptionalRead-only

last_created_experiment_atdatetimeOptionalRead-only

most_recent_optimization_atdatetimeOptionalRead-only

last_created_optimization_atdatetimeOptionalRead-only

statusenumOptionalRead-only

latest_versionobjectOptionalRead-only

Summary of the latest dataset version