Get metadata

Get metadata

Retrieve the metadata from a generated DSP block.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/metadata

Path parameters

projectId*integer

Project ID

dspId*integer

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

Query parameters

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

created*string (date-time)

Date when the features were created

dspConfig*object

labels*array of string

Labels in the dataset when generator ran

featureLabelsarray of string

Names of the generated features. Only set if axes have explicit labels.

windowCount*integer

featureCount*integer

Number of features for this DSP block

includedSamples*array of object

The included samples in this DSP block. Note that these are sorted in the same way as the npy files are laid out. So with the windowCount parameter you can exactly search back to see which file contributed to which windows there.

windowSizeMs*integer

Length of the sliding window when generating features.

windowIncreaseMs*integer

Increase of the sliding window when generating features.

padZeros*boolean

Whether data was zero-padded when generating features.

frequency*number

Frequency of the original data in Hz.

outputConfig*object

Information about the output of the DSP block

fftUsedarray of integer

resamplingAlgorithmVersionnumber

The version number of the resampling algorithm used (for resampled time series data only)

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/metadata', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "created": "2024-12-21T11:52:53.245Z",
  "labels": [
    "text"
  ],
  "featureLabels": [
    "text"
  ],
  "windowCount": 0,
  "featureCount": 0,
  "includedSamples": [
    {
      "id": 0,
      "windowCount": 0
    }
  ],
  "windowSizeMs": 0,
  "windowIncreaseMs": 0,
  "padZeros": false,
  "frequency": 0,
  "outputConfig": {
    "type": "image",
    "shape": {
      "width": 0,
      "height": 0,
      "channels": 0,
      "frames": 0
    }
  },
  "fftUsed": [
    0
  ],
  "resamplingAlgorithmVersion": 0
}