GET
/
api
/
{projectId}
/
raw-data
List samples
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "lastModified": "2023-11-07T05:31:56Z",
      "category": "training",
      "coldstorageFilename": "<string>",
      "label": "healthy-machine",
      "intervalMs": 16,
      "frequency": 62.5,
      "originalIntervalMs": 16,
      "originalFrequency": 62.5,
      "deviceName": "<string>",
      "deviceType": "<string>",
      "sensors": [
        {
          "name": "accX",
          "units": "<string>"
        }
      ],
      "valuesCount": 123,
      "totalLengthMs": 123,
      "added": "2023-11-07T05:31:56Z",
      "boundingBoxes": [
        {
          "label": "<string>",
          "x": 123,
          "y": 123,
          "width": 123,
          "height": 123
        }
      ],
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "thumbnailVideo": "<string>",
      "thumbnailVideoFull": "<string>",
      "isDisabled": true,
      "isProcessing": true,
      "processingJobId": 123,
      "processingError": true,
      "processingErrorString": "<string>",
      "isCropped": true,
      "metadata": {},
      "projectId": 123,
      "projectOwnerName": "<string>",
      "projectName": "<string>",
      "projectLabelingMethod": "single_label",
      "sha256Hash": "<string>",
      "structuredLabels": [
        {
          "startIndex": 123,
          "endIndex": 123,
          "label": "<string>"
        }
      ],
      "structuredLabelsList": [
        "<string>"
      ],
      "createdBySyntheticDataJobId": 123,
      "imageDimensions": {
        "width": 123,
        "height": 123
      },
      "videoUrl": "<string>",
      "videoUrlFull": "<string>"
    }
  ],
  "totalCount": 123
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

Query Parameters

​
category
enum<string>
required

Which of the three acquisition categories to retrieve data from

Available options:
training,
testing,
post-processing
​
limit
integer

Maximum number of results

​
offset
integer

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

​
excludeSensors
boolean

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

​
labels
string

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

Example:

"[\"idle\", \"snake\"]"

​
filename
string

Only include samples whose filename includes the given filename

​
maxLength
integer

Only include samples shorter than the given length, in milliseconds

​
minLength
integer

Only include samples longer than the given length, in milliseconds

​
minFrequency
number

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

​
maxFrequency
number

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

​
signatureValidity
enum<string>

Include samples with either valid or invalid signatures

Available options:
both,
valid,
invalid
​
includeDisabled
enum<string>

Include only enabled or disabled samples (or both)

Available options:
both,
enabled,
disabled
​
minLabel
number

Only include samples with a label >= this value

​
maxLabel
number

Only include samples with a label < this value

​
search
string

Search query

Example:

"<id> <name>"

​
proposedActionsJobId
integer

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.

​
truncateStructuredLabels
boolean

If true, only a slice of labels will be returned for samples with multiple labels.

​
sortBy
enum<string>

If not specified, "id-desc" is used.

Available options:
id-desc,
random
​
dataType
enum<string>

Include only samples with a particular data type

Available options:
audio,
image
​
minId
number

Include only samples with an ID >= this value

​
maxId
number

Include only samples with an ID < this value

​
metadata
string

Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { "no_metadata": true }.

Example:
[
  "[{ \"key\": \"locationId\", \"op\": \"eq\", \"values\": [\"buildingA\"] }, { \"key\": \"deviceId\", \"op\": \"neq\", \"values\": [\"val1\", \"val2\"] }]",
  "[{ \"key\": \"distance\", \"op\": \"eq\", \"values\": [\"1.5\", \"2.9\"], \"key\": \"comments\", exclude: [\"faulty\"] }]",
  "[{ \"key\": \"nullKeyExample\", \"op\": \"eq\" }]",
  "[{ \"key\": \"presentKeyExample\", \"op\": \"neq\" }]",
  "[{ \"no_metadata\": true }]"
]
​
minDate
string<date-time>

Only include samples that where added after the date given

Example:

"2023-01-01T00:00:00.000Z"

​
maxDate
string<date-time>

Only include samples that were added before the date given

Example:

"2024-12-31T00:00:00.000Z"

Response

200 - application/json

OK

The response is of type object.