List data

Lists all data items. This can be filtered by the ?filter parameter.

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

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

filterstring

Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

filterParseErrorstring

dataarray of object

id*integer

name*string

bucketId*integer

bucketName*string

bucketPath*string

fullBucketPath*string

dataset*string

totalFileCount*integer

totalFileSize*integer

created*string (date-time)

metadata*object

Other propertiesstring

metadataStringForCLI*string

String that's passed in to a transformation block in --metadata (the metadata + a dataItemInfo object)

totalFileCountinteger

totalDataItemCountinteger

Request

Response

List data

Lists all data items. This can be filtered by the ?filter parameter.

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

Path parameters

organizationId*integer

Organization ID

Query parameters

datasetstring

Selected dataset

Example: "activity data"

filterstring

Example: "dataset = 'activity data' AND (label = 'running' OR metadata->user = 'Jan Jongboom')"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

filterParseErrorstring

dataarray of object

id*integer

name*string

bucketId*integer

bucketName*string

bucketPath*string

fullBucketPath*string

dataset*string

totalFileCount*integer

totalFileSize*integer

created*string (date-time)

metadata*object

Other propertiesstring

metadataStringForCLI*string

String that's passed in to a transformation block in --metadata (the metadata + a dataItemInfo object)

totalFileCountinteger

totalDataItemCountinteger

Request

Response

{
  "success": false,
  "error": "text",
  "filterParseError": "text",
  "data": [
    {
      "name": "text",
      "bucketName": "text",
      "bucketPath": "text",
      "fullBucketPath": "text",
      "dataset": "text",
      "created": "2024-11-21T12:04:41.386Z",
      "metadataStringForCLI": "text"
    }
  ]
}