Get sample slice

Get a slice of a sample. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is returned. sliceStart / sliceEnd are relative to the datastream.

GET /api/{projectId}/raw-data/{sampleId}/slice

Get sample slice

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/slice \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "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,
    "deviceType": "<string>",
    "sensors": [
      {
        "index": 123,
        "name": "accX",
        "units": "<string>"
      }
    ],
    "valuesCount": 123,
    "added": "2023-11-07T05:31:56Z",
    "boundingBoxes": [
      {
        "label": "<string>",
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123
      }
    ],
    "isDisabled": true,
    "isProcessing": true,
    "processingError": true,
    "isCropped": true,
    "projectId": 123,
    "sha256Hash": "<string>",
    "datastreams": [
      {
        "index": 123,
        "intervalMs": 123,
        "frequencyHz": 123,
        "sensors": [
          {
            "index": 123,
            "name": "accX",
            "units": "<string>"
          }
        ],
        "valuesCount": 123,
        "totalLengthMs": 123,
        "imageDimensions": {
          "width": 123,
          "height": 123
        }
      }
    ],
    "signatureMethod": "HS256",
    "signatureKey": "<string>",
    "deviceName": "<string>",
    "totalLengthMs": 123,
    "thumbnailVideo": "<string>",
    "thumbnailVideoFull": "<string>",
    "processingJobId": 123,
    "processingErrorString": "<string>",
    "metadata": {},
    "projectOwnerName": "<string>",
    "projectName": "<string>",
    "structuredLabels": [
      {
        "startIndex": 123,
        "endIndex": 123,
        "label": "<string>",
        "labelMap": {
          "type": "key-values",
          "labels": {}
        }
      }
    ],
    "structuredLabelsList": [
      "<string>"
    ],
    "createdBySyntheticDataJobId": 123,
    "imageDimensions": {
      "width": 123,
      "height": 123
    },
    "videoUrl": "<string>",
    "videoUrlFull": "<string>",
    "labelMap": {
      "type": "key-values",
      "labels": {}
    },
    "lastUpdatedBy": {
      "type": "user",
      "id": 123
    }
  },
  "payload": {
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "index": 123,
        "name": "accX",
        "units": "<string>"
      }
    ],
    "values": [
      [
        123
      ]
    ],
    "intervalMs": 16,
    "frequencyHz": 62.5,
    "device_name": "ac:87:a3:0a:2d:1b",
    "cropStart": 0,
    "cropEnd": 128
  },
  "totalPayloadLength": 123,
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

sampleId · integer · required

Sample ID

Query Parameters

sliceStart · integer · required

Begin index of the slice

sliceEnd · integer

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

impulseId · integer

Impulse ID. If this is unset then the default impulse is used.

datastreamIndex · integer

Datastream index (defaults to 0)

truncateStructuredLabels · boolean

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

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

sample · object · required

Show child attributes

payload · object · required

If multiple payloads are present (one per datastream) this returns the first datastream.

Show child attributes

totalPayloadLength · integer · required

Total number of payload values

error · string

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