curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset} \
--header 'x-api-key: <api-key>'{
"success": true,
"dataset": {
"dataset": "<string>",
"lastFileCreated": "2023-11-07T05:31:56Z",
"totalFileSize": 123,
"totalFileCount": 123,
"totalItemCount": 123,
"totalItemCountChecklistOK": 123,
"totalItemCountChecklistFailed": 123,
"tags": [
"<string>"
],
"type": "clinical",
"category": "<string>",
"bucket": {
"id": 123,
"bucket": "<string>",
"path": "<string>",
"fullBucketPathDescription": "<string>",
"dataItemNamingLevelsDeep": 123
},
"bucketPath": "<string>"
},
"error": "<string>"
}Get information about a dataset
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset} \
--header 'x-api-key: <api-key>'{
"success": true,
"dataset": {
"dataset": "<string>",
"lastFileCreated": "2023-11-07T05:31:56Z",
"totalFileSize": 123,
"totalFileCount": 123,
"totalItemCount": 123,
"totalItemCountChecklistOK": 123,
"totalItemCountChecklistFailed": 123,
"tags": [
"<string>"
],
"type": "clinical",
"category": "<string>",
"bucket": {
"id": 123,
"bucket": "<string>",
"path": "<string>",
"fullBucketPathDescription": "<string>",
"dataItemNamingLevelsDeep": 123
},
"bucketPath": "<string>"
},
"error": "<string>"
}OK
Whether the operation succeeded
Show child attributes
clinical, files Show child attributes
Bucket ID
Path in the bucket
Full bucket path, incl. protocol (e.g. s3://bucket/path) - to be used in the UI
Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" type.
Location of the dataset within the bucket
Optional error description (set if 'success' was false)
Was this page helpful?