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

Try it

Get processed sample (slice)

cURL

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

200

{
  "success": true,
  "features": [
    123
  ],
  "graphs": [
    {
      "name": "Frequency domain",
      "type": "<string>",
      "image": "<string>",
      "imageMimeType": "<string>",
      "X": {
        "accX": [
          3,
          5,
          7
        ],
        "accY": [
          2,
          1,
          5
        ]
      },
      "y": [
        0,
        0.5,
        1
      ],
      "suggestedXMin": 123,
      "suggestedXMax": 123,
      "suggestedYMin": 123,
      "suggestedYMax": 123,
      "lineWidth": 123,
      "smoothing": true,
      "axisLabels": {
        "X": "<string>",
        "y": "<string>"
      },
      "highlights": {}
    }
  ],
  "sample": {
    "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": [
        {
          "name": "accX",
          "units": "<string>"
        }
      ],
      "valuesCount": 123,
      "added": "2023-11-07T05:31:56Z",
      "boundingBoxes": [
        {
          "label": "<string>",
          "x": 123,
          "y": 123,
          "width": 123,
          "height": 123
        }
      ],
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "isDisabled": true,
      "isProcessing": true,
      "processingError": true,
      "isCropped": true,
      "projectId": 123,
      "sha256Hash": "<string>",
      "signatureMethod": "HS256",
      "signatureKey": "<string>",
      "deviceName": "<string>",
      "totalLengthMs": 123,
      "thumbnailVideo": "<string>",
      "thumbnailVideoFull": "<string>",
      "processingJobId": 123,
      "processingErrorString": "<string>",
      "metadata": {},
      "projectOwnerName": "<string>",
      "projectName": "<string>",
      "projectLabelingMethod": "single_label",
      "structuredLabels": [
        {
          "startIndex": 123,
          "endIndex": 123,
          "label": "<string>"
        }
      ],
      "structuredLabelsList": [
        "<string>"
      ],
      "createdBySyntheticDataJobId": 123,
      "imageDimensions": {
        "width": 123,
        "height": 123
      },
      "videoUrl": "<string>",
      "videoUrlFull": "<string>"
    },
    "payload": {
      "device_type": "DISCO-L475VG-IOT01A",
      "sensors": [
        {
          "name": "accX",
          "units": "<string>"
        }
      ],
      "values": [
        [
          123
        ]
      ],
      "device_name": "ac:87:a3:0a:2d:1b",
      "cropStart": 0,
      "cropEnd": 128
    },
    "totalPayloadLength": 123
  },
  "canProfilePerformance": true,
  "error": "<string>",
  "labels": [
    "<string>"
  ],
  "state_string": "<string>",
  "labelAtEndOfWindow": "<string>",
  "labelForWindow": "<string>",
  "performance": {
    "latency": 123,
    "ram": 123,
    "customDspString": "<string>"
  }
}

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

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.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

features · number[] · required

Array of processed features. Laid out according to the names in 'labels'

graphs · object[] · required

Graphs to plot to give an insight in how the DSP process ran

Show child attributes

graphs. name · string · required

Name of the graph

Example:

"Frequency domain"

graphs. type · string · required

Type of graph (either logarithmic, linear or image)

graphs. image · string

Base64 encoded image, only present if type is 'image'

graphs. imageMimeType · string

Mime type of the Base64 encoded image, only present if type is 'image'

graphs. X · object

Values on the x-axis per plot. Key is the name of the raw feature. Present if type is 'logarithmic' or 'linear'.

Show child attributes

graphs.X. {key} · number[]

Example:

{ "accX": [3, 5, 7], "accY": [2, 1, 5] }

graphs. y · number[]

Values of the y-axis. Present if type is 'logarithmic' or 'linear'.

Example:

[0, 0.5, 1]

graphs. suggestedXMin · number

Suggested minimum value of x-axis

graphs. suggestedXMax · number

Suggested maxium value of x-axis

graphs. suggestedYMin · number

Suggested minimum value of y-axis

graphs. suggestedYMax · number

Suggested maximum value of y-axis

graphs. lineWidth · number

Width of the graph line (if type is logarithmic or linear). Default 3.

graphs. smoothing · boolean

Whether to apply smoothing to the graph.

graphs. axisLabels · object

Labels for the graph x and y axes.

Show child attributes

graphs.axisLabels. X · string · required

graphs.axisLabels. y · string · required

graphs. highlights · object

Indices of points to highlight, per axis.

Show child attributes

graphs.highlights. {key} · number[]

sample · object · required

Show child attributes

sample. sample · object · required

Show child attributes

sample.sample. id · integer · required

Example:

2

sample.sample. filename · string · required

Example:

"idle01.d8Ae"

sample.sample. signatureValidate · boolean · required

Whether signature validation passed

Example:

true

sample.sample. created · string<date-time> · required

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

sample.sample. lastModified · string<date-time> · required

Timestamp when the sample was last modified.

sample.sample. category · enum<string> · required

Available options: training, testing, post-processing

Example:

"training"

sample.sample. coldstorageFilename · string · required

sample.sample. label · string · required

Example:

"healthy-machine"

sample.sample. intervalMs · number · required

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example:

16

sample.sample. frequency · number · required

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example:

62.5

sample.sample. originalIntervalMs · number · required

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example:

16

sample.sample. originalFrequency · number · required

Frequency of the sample in the source data (before resampling).

Example:

62.5

sample.sample. deviceType · string · required

sample.sample. sensors · object[] · required

Show child attributes

sample.sample.sensors. name · string · required

Name of the axis

Example:

"accX"

sample.sample.sensors. units · string · required

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

sample.sample. valuesCount · integer · required

Number of readings in this file

sample.sample. added · string<date-time> · required

Timestamp when the sample was added to the current acquisition bucket.

sample.sample. boundingBoxes · object[] · required

Show child attributes

sample.sample.boundingBoxes. label · string · required

sample.sample.boundingBoxes. x · integer · required

sample.sample.boundingBoxes. y · integer · required

sample.sample.boundingBoxes. width · integer · required

sample.sample.boundingBoxes. height · integer · required

sample.sample. boundingBoxesType · enum<string> · required

Available options: object_detection, constrained_object_detection

sample.sample. chartType · enum<string> · required

Available options: chart, image, video, table

sample.sample. isDisabled · boolean · required

True if the current sample is excluded from use

sample.sample. isProcessing · boolean · required

True if the current sample is still processing (e.g. for video)

sample.sample. processingError · boolean · required

Set when processing this sample failed

sample.sample. isCropped · boolean · required

Whether the sample is cropped from another sample (and has crop start / end info)

sample.sample. projectId · integer · required

Unique identifier of the project this sample belongs to

sample.sample. sha256Hash · string · required

Data sample SHA 256 hash (including CBOR envelope if applicable)

sample.sample. signatureMethod · string

Example:

"HS256"

sample.sample. signatureKey · string

Either the shared key or the public key that was used to validate the sample

sample.sample. deviceName · string

sample.sample. totalLengthMs · number

Total length (in ms.) of this file

sample.sample. thumbnailVideo · string

sample.sample. thumbnailVideoFull · string

sample.sample. processingJobId · integer

Set when sample is processing and a job has picked up the request

sample.sample. processingErrorString · string

Error (only set when processing this sample failed)

sample.sample. metadata · object

Sample free form associated metadata

Show child attributes

sample.sample.metadata. {key} · string

sample.sample. projectOwnerName · string

Name of the owner of the project this sample belongs to

sample.sample. projectName · string

Name of the project this sample belongs to

sample.sample. projectLabelingMethod · enum<string>

What labeling flow the project this sample belongs to uses

Available options: single_label, object_detection

sample.sample. structuredLabels · object[]

Show child attributes

sample.sample.structuredLabels. startIndex · integer · required

Start index of the label (e.g. 0)

sample.sample.structuredLabels. endIndex · integer · required

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

sample.sample.structuredLabels. label · string · required

The label for this section.

sample.sample. structuredLabelsList · string[]

sample.sample. createdBySyntheticDataJobId · integer

If this sample was created by a synthetic data job, it's referenced here.

sample.sample. imageDimensions · object

Show child attributes

sample.sample.imageDimensions. width · integer · required

sample.sample.imageDimensions. height · integer · required

sample.sample. videoUrl · string

Video link, cropped and in original resolution.

sample.sample. videoUrlFull · string

Video link in original resolution.

sample. payload · object · required

Sensor readings and metadata

Show child attributes

sample.payload. device_type · string · required

Device type, for example the exact model of the device. Should be the same for all similar devices.

Example:

"DISCO-L475VG-IOT01A"

sample.payload. sensors · object[] · required

Array with sensor axes

Show child attributes

sample.payload.sensors. name · string · required

Name of the axis

Example:

"accX"

sample.payload.sensors. units · string · required

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

sample.payload. values · number[][] · required

Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.

sample.payload. device_name · string

Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).

Example:

"ac:87:a3:0a:2d:1b"

sample.payload. cropStart · integer

New start index of the cropped sample

Example:

0

sample.payload. cropEnd · integer

New end index of the cropped sample

Example:

128

sample. totalPayloadLength · integer · required

Total number of payload values

canProfilePerformance · boolean · required

error · string

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

labels · string[]

Labels of the feature axes

state_string · string

String representation of the DSP state returned

labelAtEndOfWindow · string

DEPRECATED. Label at the end of the window (only present for time-series data)

labelForWindow · string

Label for the window. How the label is chosen is dependent on the value of "labelingMethodMultiLabel" in the input block.

performance · object

Show child attributes

performance. latency · integer · required

performance. ram · integer · required

performance. customDspString · string

If the project latencyDevice has custom DSP hardware, this value contains a device specific latency metric (eg. cycles)