Get processed sample (slice)

Get processed sample (slice)

get

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.

Authorizations
Path parameters
projectIdintegerrequired

Project ID

dspIdintegerrequired

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

sampleIdintegerrequired

Sample ID

Query parameters
sliceStartintegerrequired

Begin index of the slice

sliceEndintegeroptional

End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.

Responses
curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}/slice/run/readonly?sliceStart=1' \
  --header 'x-api-key: YOUR_API_KEY'
{
  "success": true,
  "error": "text",
  "features": [
    1
  ],
  "graphs": [
    {
      "name": "Frequency domain",
      "image": "text",
      "imageMimeType": "text",
      "X": {
        "accX": [
          3,
          5,
          7
        ],
        "accY": [
          2,
          1,
          5
        ]
      },
      "y": [
        0,
        0.5,
        1
      ],
      "suggestedXMin": 1,
      "suggestedXMax": 1,
      "suggestedYMin": 1,
      "suggestedYMax": 1,
      "type": "text",
      "lineWidth": 1,
      "smoothing": true,
      "axisLabels": {
        "X": "text",
        "y": "text"
      },
      "highlights": {
        "ANY_ADDITIONAL_PROPERTY": [
          1
        ]
      }
    }
  ],
  "labels": [
    "text"
  ],
  "state_string": "text",
  "labelAtEndOfWindow": "text",
  "sample": {
    "sample": {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "text",
      "created": "2025-03-26T13:01:46.344Z",
      "lastModified": "2025-03-26T13:01:46.344Z",
      "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:01:46.344Z",
      "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
  },
  "performance": {
    "latency": 1,
    "ram": 1,
    "customDspString": "text"
  },
  "canProfilePerformance": true
}

Last updated

Was this helpful?