List files

List files

Lists all files included by the filter.

get

/api/organizations/{organizationId}/data/files

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/data/files' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "filterParseError": "text",
  "totalFileSize": 1,
  "totalFileCount": 1,
  "totalDataItemCount": 1,
  "data": [
    {
      "id": 1,
      "name": "text",
      "bucketId": 1,
      "bucketName": "text",
      "bucketPath": "text",
      "dataset": "text",
      "totalFileCount": 1,
      "totalFileSize": 1,
      "created": "2025-02-21T18:19:35.013Z",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "files": [
        {
          "name": "text",
          "bucketPath": "text",
          "size": 1,
          "lastModified": "2025-02-21T18:19:35.013Z"
        }
      ]
    }
  ]
}

OK