GET
/
api
/
{projectId}
/
dsp
/
{dspId}
/
raw-data
/
{sampleId}
Get raw sample
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/raw-data/{sampleId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "signatureKey": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "category": "training",
    "coldstorageFilename": "<string>",
    "label": "healthy-machine",
    "intervalMs": 16,
    "frequency": 62.5,
    "originalIntervalMs": 16,
    "originalFrequency": 62.5,
    "deviceName": "<string>",
    "deviceType": "<string>",
    "sensors": [
      {
        "name": "accX",
        "units": "<string>"
      }
    ],
    "valuesCount": 123,
    "totalLengthMs": 123,
    "added": "2023-11-07T05:31:56Z",
    "boundingBoxes": [
      {
        "label": "<string>",
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123
      }
    ],
    "boundingBoxesType": "object_detection",
    "chartType": "chart",
    "thumbnailVideo": "<string>",
    "thumbnailVideoFull": "<string>",
    "isDisabled": true,
    "isProcessing": true,
    "processingJobId": 123,
    "processingError": true,
    "processingErrorString": "<string>",
    "isCropped": true,
    "metadata": {},
    "projectId": 123,
    "projectOwnerName": "<string>",
    "projectName": "<string>",
    "projectLabelingMethod": "single_label",
    "sha256Hash": "<string>",
    "structuredLabels": [
      {
        "startIndex": 123,
        "endIndex": 123,
        "label": "<string>"
      }
    ],
    "structuredLabelsList": [
      "<string>"
    ],
    "createdBySyntheticDataJobId": 123,
    "imageDimensions": {
      "width": 123,
      "height": 123
    },
    "videoUrl": "<string>",
    "videoUrlFull": "<string>"
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "<string>"
      }
    ],
    "values": [
      [
        123
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  },
  "totalPayloadLength": 123
}

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
integer
required

Project ID

dspId
integer
required

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

sampleId
integer
required

Sample ID

Query Parameters

limitPayloadValues
integer

Limit the number of payload values in the response

truncateStructuredLabels
boolean

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

Response

200 - application/json

OK

The response is of type object.