Get raw sample

Get raw sample

get

Get raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out. If you pass dspId = 0 this will return a raw graph without any processing.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

dspIdintegerrequired

DSP Block ID, use the impulse functions to retrieve the ID

sampleIdintegerrequired

Sample ID

Query parameters

limitPayloadValuesintegeroptional

Limit the number of payload values in the response

truncateStructuredLabelsbooleanoptional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "signatureKey": "text",
    "created": "2025-03-26T13:00:37.613Z",
    "lastModified": "2025-03-26T13:00:37.613Z",
    "category": "training",
    "coldstorageFilename": "text",
    "label": "healthy-machine",
    "intervalMs": 16,
    "frequency": 62.5,
    "originalIntervalMs": 16,
    "originalFrequency": 62.5,
    "deviceName": "text",
    "deviceType": "text",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "valuesCount": 1,
    "totalLengthMs": 1,
    "added": "2025-03-26T13:00:37.613Z",
    "boundingBoxes": [
      {
        "label": "text",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1
      }
    ],
    "boundingBoxesType": "object_detection",
    "chartType": "chart",
    "thumbnailVideo": "text",
    "thumbnailVideoFull": "text",
    "isDisabled": true,
    "isProcessing": true,
    "processingJobId": 1,
    "processingError": true,
    "processingErrorString": "text",
    "isCropped": true,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "projectId": 1,
    "projectOwnerName": "text",
    "projectName": "text",
    "projectLabelingMethod": "single_label",
    "sha256Hash": "text",
    "structuredLabels": [
      {
        "startIndex": 1,
        "endIndex": 1,
        "label": "text"
      }
    ],
    "structuredLabelsList": [
      "text"
    ],
    "createdBySyntheticDataJobId": 1,
    "imageDimensions": {
      "width": 1,
      "height": 1
    }
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        1
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  },
  "totalPayloadLength": 1
}

OK