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.

get

/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}/slice/run/readonly

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

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

sliceEndinteger

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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'

200

200

{
  "success": true,
  "error": "text",
  "state_string": "text",
  "labelAtEndOfWindow": "text",
  "sample": {
    "sample": {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "text",
      "created": "2025-02-21T18:03:03.705Z",
      "lastModified": "2025-02-21T18:03:03.705Z",
      "category": "training",
      "coldstorageFilename": "text",
      "label": "healthy-machine",
      "intervalMs": 16,
      "frequency": 62.5,
      "originalIntervalMs": 16,
      "originalFrequency": 62.5,
      "deviceName": "text",
      "deviceType": "text",
      "valuesCount": 1,
      "totalLengthMs": 1,
      "added": "2025-02-21T18:03:03.705Z",
      "thumbnailVideo": "text",
      "thumbnailVideoFull": "text",
      "isDisabled": true,
      "isProcessing": true,
      "processingJobId": 1,
      "processingError": true,
      "processingErrorString": "text",
      "isCropped": true,
      "projectId": 1,
      "projectOwnerName": "text",
      "projectName": "text",
      "sha256Hash": "text",
      "createdBySyntheticDataJobId": 1,
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "projectLabelingMethod": "single_label",
      "sensors": [
        {
          "name": "accX",
          "units": "text"
        }
      ],
      "boundingBoxes": [
        {
          "label": "text",
          "x": 1,
          "y": 1,
          "width": 1,
          "height": 1
        }
      ],
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "structuredLabels": [
        {
          "startIndex": 1,
          "endIndex": 1,
          "label": "text"
        }
      ],
      "structuredLabelsList": [
        "text"
      ],
      "imageDimensions": {
        "width": 1,
        "height": 1
      }
    },
    "payload": {
      "device_name": "ac:87:a3:0a:2d:1b",
      "device_type": "DISCO-L475VG-IOT01A",
      "cropStart": 0,
      "cropEnd": 128,
      "sensors": [
        {
          "name": "accX",
          "units": "text"
        }
      ],
      "values": [
        [
          1
        ]
      ]
    },
    "totalPayloadLength": 1
  },
  "performance": {
    "latency": 1,
    "ram": 1,
    "customDspString": "text"
  },
  "canProfilePerformance": true,
  "features": [
    1
  ],
  "graphs": [
    {
      "name": "Frequency domain",
      "image": "text",
      "imageMimeType": "text",
      "suggestedXMin": 1,
      "suggestedXMax": 1,
      "suggestedYMin": 1,
      "suggestedYMax": 1,
      "type": "text",
      "lineWidth": 1,
      "smoothing": true,
      "y": [
        0,
        0.5,
        1
      ],
      "X": {
        "accX": [
          3,
          5,
          7
        ],
        "accY": [
          2,
          1,
          5
        ]
      },
      "axisLabels": {
        "X": "text",
        "y": "text"
      },
      "highlights": {
        "ANY_ADDITIONAL_PROPERTY": [
          1
        ]
      }
    }
  ],
  "labels": [
    "text"
  ]
}

OK