Get the original downsampled data

Get the original, uncropped, downsampled data.

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

Try it

Get the original downsampled data

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/original \
  --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": [
      {
        "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,
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

sampleId · integer · required

Sample ID

Query Parameters

limitPayloadValues · integer

Limit the number of payload values in the response

zoomStart · integer

Zoom into the sample, with the focus starting at this index

zoomEnd · integer

Zoom into the sample, with the focus ending at this index

impulseId · integer

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

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

sample. id · integer · required

Example:

2

sample. filename · string · required

Example:

"idle01.d8Ae"

sample. signatureValidate · boolean · required

Whether signature validation passed

Example:

true

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. lastModified · string<date-time> · required

Timestamp when the sample was last modified.

sample. category · enum<string> · required

Available options: training, testing, post-processing

Example:

"training"

sample. coldstorageFilename · string · required

sample. label · string · required

Example:

"healthy-machine"

sample. intervalMs · number · required

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

Example:

16

sample. frequency · number · required

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

Example:

62.5

sample. originalIntervalMs · number · required

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

Example:

16

sample. originalFrequency · number · required

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

Example:

62.5

sample. deviceType · string · required

sample. sensors · object[] · required

Show child attributes

sample.sensors. name · string · required

Name of the axis

Example:

"accX"

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. valuesCount · integer · required

Number of readings in this file

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

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

sample. boundingBoxes · object[] · required

Show child attributes

sample.boundingBoxes. label · string · required

sample.boundingBoxes. x · integer · required

sample.boundingBoxes. y · integer · required

sample.boundingBoxes. width · integer · required

sample.boundingBoxes. height · integer · required

sample. boundingBoxesType · enum<string> · required

Available options: object_detection, constrained_object_detection

sample. chartType · enum<string> · required

Available options: chart, image, video, table

sample. isDisabled · boolean · required

True if the current sample is excluded from use

sample. isProcessing · boolean · required

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

sample. processingError · boolean · required

Set when processing this sample failed

sample. isCropped · boolean · required

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

sample. projectId · integer · required

Unique identifier of the project this sample belongs to

sample. sha256Hash · string · required

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

sample. signatureMethod · string

Example:

"HS256"

sample. signatureKey · string

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

sample. deviceName · string

sample. totalLengthMs · number

Total length (in ms.) of this file

sample. thumbnailVideo · string

sample. thumbnailVideoFull · string

sample. processingJobId · integer

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

sample. processingErrorString · string

Error (only set when processing this sample failed)

sample. metadata · object

Sample free form associated metadata

Show child attributes

sample.metadata. {key} · string

sample. projectOwnerName · string

Name of the owner of the project this sample belongs to

sample. projectName · string

Name of the project this sample belongs to

sample. projectLabelingMethod · enum<string>

What labeling flow the project this sample belongs to uses

Available options: single_label, object_detection

sample. structuredLabels · object[]

Show child attributes

sample.structuredLabels. startIndex · integer · required

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

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.structuredLabels. label · string · required

The label for this section.

sample. structuredLabelsList · string[]

sample. createdBySyntheticDataJobId · integer

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

sample. imageDimensions · object

Show child attributes

sample.imageDimensions. width · integer · required

sample.imageDimensions. height · integer · required

sample. videoUrl · string

Video link, cropped and in original resolution.

sample. videoUrlFull · string

Video link in original resolution.

payload · object · required

Sensor readings and metadata

Show child attributes

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"

payload. sensors · object[] · required

Array with sensor axes

Show child attributes

payload.sensors. name · string · required

Name of the axis

Example:

"accX"

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).

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.

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"

payload. cropStart · integer

New start index of the cropped sample

Example:

0

payload. cropEnd · integer

New end index of the cropped sample

Example:

128

totalPayloadLength · integer · required

Total number of payload values

error · string

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