OrganizationData

List files

Lists all files included by the filter.

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

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/data/files/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

Query parameters

datasetstring

Selected dataset

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).

limitinteger

Maximum number of results

offsetinteger

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

Response

successboolean required

Whether the operation succeeded

errorstring

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

filterParseErrorstring

totalFileSizeinteger required

totalFileCountinteger required

totalDataItemCountinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.