API and SDKs references

Get dataset

Get information about a dataset

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}

Authorization

Path parameters

organizationId*integer

Organization ID

dataset*string

Dataset name

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

dataset*object

dataset*string

lastFileCreated*string (date-time)

totalFileSize*integer

totalFileCount*integer

totalItemCount*integer

totalItemCountChecklistOK*integer

totalItemCountChecklistFailed*integer

tags*array of string

itemsstring

categorystring

bucketobject

id*integer

Bucket ID

bucket*string

path*string

Path in the bucket

fullBucketPathDescription*string

Full bucket path, incl. protocol (e.g. s3://bucket/path) - to be used in the UI

dataItemNamingLevelsDeep*integer

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.

type*enum

clinicalfiles

bucketPathstring

Location of the dataset within the bucket

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dataset/{dataset}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "dataset": {
    "dataset": "text",
    "lastFileCreated": "2025-01-30T16:32:23.457Z",
    "totalFileSize": 0,
    "totalFileCount": 0,
    "totalItemCount": 0,
    "totalItemCountChecklistOK": 0,
    "totalItemCountChecklistFailed": 0,
    "tags": [
      "text"
    ],
    "category": "text",
    "bucket": {
      "id": 0,
      "bucket": "text",
      "path": "text",
      "fullBucketPathDescription": "text",
      "dataItemNamingLevelsDeep": 0
    },
    "type": "clinical",
    "bucketPath": "text"
  }
}