GET
/
api
/
{projectId}
/
dsp
/
{dspId}
/
metadata
Get metadata
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/metadata \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "generated": true,
  "dspConfig": {},
  "labels": [
    "<string>"
  ],
  "featureLabels": [
    "<string>"
  ],
  "windowCount": 123,
  "featureCount": 123,
  "includedSamples": [
    {
      "id": 123,
      "windowCount": 123
    }
  ],
  "windowSizeMs": 123,
  "windowIncreaseMs": 123,
  "padZeros": true,
  "frequency": 123,
  "outputConfig": {
    "type": "image",
    "shape": {
      "width": 123,
      "height": 123,
      "channels": 123,
      "frames": 123
    }
  },
  "fftUsed": [
    123
  ],
  "resamplingAlgorithmVersion": 123,
  "featureExplorerJobId": 123,
  "featureExplorerJobFailed": true,
  "featureImportanceJobId": 123,
  "featureImportanceJobFailed": true
}

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

Query Parameters

​
excludeIncludedSamples
boolean

Whether to exclude 'includedSamples' in the response (as these can slow down requests significantly).

​
category
enum<string>

Which of the acquisition categories to get metadata from

Available options:
training,
testing,
all

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
created
string<date-time>
required

Date when the features were created

​
generated
boolean
required

Whether features were generated

​
dspConfig
object
required
​
labels
string[]
required

Labels in the dataset when generator ran

​
windowCount
integer
required
​
featureCount
integer
required

Number of features for this DSP block

​
includedSamples
object[]
required

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
required

Length of the sliding window when generating features.

​
windowIncreaseMs
integer
required

Increase of the sliding window when generating features.

​
padZeros
boolean
required

Whether data was zero-padded when generating features.

​
frequency
number
required

Frequency of the original data in Hz.

​
outputConfig
object
required

Information about the output of the DSP block

​
error
string

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

​
featureLabels
string[]

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

​
fftUsed
integer[]
​
resamplingAlgorithmVersion
number

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

​
featureExplorerJobId
integer

When specified, a job is running (asynchronously) to generate the feature explorer.

​
featureExplorerJobFailed
boolean

If this is set, then the feature explorer job failed (get the status by getting the job logs for 'featureExplorerJobId').

​
featureImportanceJobId
integer

When specified, a job is running (asynchronously) to generate feature importance.

​
featureImportanceJobFailed
boolean

If this is set, then the feature importance job failed (get the status by getting the job logs for 'featureImportanceJobId').