List samples

List samples

Retrieve all raw data by category.

get

/api/{projectId}/raw-data

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

Query parameters

categorystring · enumrequired

Which of the three acquisition categories to retrieve data from

Options: training, testing, anomaly

limitinteger

Maximum number of results

offsetinteger

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

excludeSensorsboolean

Whether to exclude sensors in the response (as these can slow down requests when you have large pages).

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: ["idle", "snake"]

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValiditystring · enum

Include samples with either valid or invalid signatures

Options: both, valid, invalid

includeDisabledstring · enum

Include only enabled or disabled samples (or both)

Options: both, enabled, disabled

minLabelnumber

Only include samples with a label >= this value

maxLabelnumber

Only include samples with a label < this value

searchstring

Search query

Example: <id> <name>

proposedActionsJobIdinteger

Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data?category=training' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "totalCount": 1,
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "text",
      "created": "2025-02-21T18:22:23.896Z",
      "lastModified": "2025-02-21T18:22:23.896Z",
      "category": "training",
      "coldstorageFilename": "text",
      "label": "healthy-machine",
      "intervalMs": 16,
      "frequency": 62.5,
      "originalIntervalMs": 16,
      "originalFrequency": 62.5,
      "deviceName": "text",
      "deviceType": "text",
      "valuesCount": 1,
      "totalLengthMs": 1,
      "added": "2025-02-21T18:22:23.896Z",
      "thumbnailVideo": "text",
      "thumbnailVideoFull": "text",
      "isDisabled": true,
      "isProcessing": true,
      "processingJobId": 1,
      "processingError": true,
      "processingErrorString": "text",
      "isCropped": true,
      "projectId": 1,
      "projectOwnerName": "text",
      "projectName": "text",
      "sha256Hash": "text",
      "createdBySyntheticDataJobId": 1,
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "projectLabelingMethod": "single_label",
      "sensors": [
        {
          "name": "accX",
          "units": "text"
        }
      ],
      "boundingBoxes": [
        {
          "label": "text",
          "x": 1,
          "y": 1,
          "width": 1,
          "height": 1
        }
      ],
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "structuredLabels": [
        {
          "startIndex": 1,
          "endIndex": 1,
          "label": "text"
        }
      ],
      "structuredLabelsList": [
        "text"
      ],
      "imageDimensions": {
        "width": 1,
        "height": 1
      }
    }
  ]
}

OK