Get processed sample (slice)

Get processed sample (slice)

Get slice of sample data, and run it through the DSP block. This 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.

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

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)

features*array of number

Array of processed features. Laid out according to the names in 'labels'

graphs*array of DspRunGraph (object)

Graphs to plot to give an insight in how the DSP process ran

labelsarray of string

Labels of the feature axes

state_stringstring

String representation of the DSP state returned

labelAtEndOfWindowstring

Label for the window (only present for time-series data)

sample*RawSampleData (object)

performanceobject

canProfilePerformance*boolean

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "error": "text",
  "features": [
    0
  ],
  "graphs": [
    {
      "name": "Frequency domain",
      "image": "text",
      "imageMimeType": "text",
      "X": {
        "accX": [
          3,
          5,
          7
        ],
        "accY": [
          2,
          1,
          5
        ]
      },
      "y": [
        0,
        0.5,
        1
      ],
      "suggestedXMin": 0,
      "suggestedXMax": 0,
      "suggestedYMin": 0,
      "suggestedYMax": 0,
      "type": "text",
      "lineWidth": 0,
      "smoothing": false,
      "axisLabels": {
        "X": "text",
        "y": "text"
      }
    }
  ],
  "labels": [
    "text"
  ],
  "state_string": "text",
  "labelAtEndOfWindow": "text",
  "sample": {
    "sample": {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "text",
      "created": "2024-07-04T18:25:19.419Z",
      "lastModified": "2024-07-04T18:25:19.419Z",
      "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"
        }
      ],
      "totalLengthMs": 0,
      "added": "2024-07-04T18:25:19.419Z",
      "boundingBoxes": [
        {
          "label": "text"
        }
      ],
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "thumbnailVideo": "text",
      "thumbnailVideoFull": "text",
      "isDisabled": false,
      "isProcessing": false,
      "processingError": false,
      "processingErrorString": "text",
      "isCropped": false,
      "projectOwnerName": "text",
      "projectName": "text",
      "projectLabelingMethod": "single_label",
      "sha256Hash": "text",
      "structuredLabels": [
        {
          "label": "text"
        }
      ],
      "structuredLabelsList": [
        "text"
      ]
    },
    "payload": {
      "device_name": "ac:87:a3:0a:2d:1b",
      "device_type": "DISCO-L475VG-IOT01A",
      "sensors": [
        {
          "name": "accX",
          "units": "text"
        }
      ],
      "values": [
        [
          0
        ]
      ],
      "cropEnd": 128
    }
  },
  "performance": {},
  "canProfilePerformance": false
}