Get raw sample

Get raw sample

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.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}

Path parameters

projectId*integer

Project ID

dspId*integer

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

sampleId*integer

Sample ID

Query parameters

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

payload*RawSamplePayload (object)

Sensor readings and metadata

totalPayloadLength*integer

Total number of payload values

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "signatureKey": "text",
    "created": "2024-12-21T11:43:36.479Z",
    "lastModified": "2024-12-21T11:43:36.479Z",
    "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": 0,
    "totalLengthMs": 0,
    "added": "2024-12-21T11:43:36.479Z",
    "boundingBoxes": [
      {
        "label": "text",
        "x": 0,
        "y": 0,
        "width": 0,
        "height": 0
      }
    ],
    "boundingBoxesType": "object_detection",
    "chartType": "chart",
    "thumbnailVideo": "text",
    "thumbnailVideoFull": "text",
    "isDisabled": false,
    "isProcessing": false,
    "processingJobId": 0,
    "processingError": false,
    "processingErrorString": "text",
    "isCropped": false,
    "projectId": 0,
    "projectOwnerName": "text",
    "projectName": "text",
    "projectLabelingMethod": "single_label",
    "sha256Hash": "text",
    "structuredLabels": [
      {
        "startIndex": 0,
        "endIndex": 0,
        "label": "text"
      }
    ],
    "structuredLabelsList": [
      "text"
    ],
    "createdBySyntheticDataJobId": 0,
    "imageDimensions": {
      "width": 0,
      "height": 0
    }
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        0
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  },
  "totalPayloadLength": 0
}