Raw data

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

Request

Path parameters

projectIdinteger required

Project ID

sampleIdinteger required

Sample ID

Query parameters

sliceStartinteger required

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.

impulseIdinteger

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

datastreamIndexinteger

Datastream index (defaults to 0)

truncateStructuredLabelsboolean

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

datasetVersionIdinteger

Dataset version ID. If not set, the current mutable dataset is used

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

totalPayloadLengthinteger required

Total number of payload values

Example response

{
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "label": "healthy-machine",
    "intervalMs": 16,
    "frequency": 62.5,
    "originalIntervalMs": 16,
    "originalFrequency": 62.5,
    "sensors": [
      {
        "name": "accX"
      }
    ],
    "datastreams": [
      {
        "sensors": [
          {
            "name": "accX"
          }
        ]
      }
    ]
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX"
      }
    ],
    "cropEnd": 128,
    "intervalMs": 16,
    "frequencyHz": 62.5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.