EDedgeimpulse
DSP

Get metadata

Retrieve the metadata from a generated DSP block.

get/api/{projectId}/dsp/{dspId}/metadata

Request

Path parameters

projectIdinteger required

Project ID

dspIdinteger required

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

Query parameters

excludeIncludedSamplesboolean

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

category'training' | 'testing' | 'validation' | 'all'

Which of the acquisition categories to get metadata from

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

createdstring date-time required

Date when the features were created

generatedboolean required

Whether features were generated

dspConfigobject required
labelsstring[] required

Labels in the dataset when generator ran

featureLabelsstring[]

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

windowCountinteger required
featureCountinteger required

Number of features for this DSP block

windowSizeMsinteger required

Length of the sliding window when generating features.

windowIncreaseMsinteger required

Increase of the sliding window when generating features.

padZerosboolean required

Whether data was zero-padded when generating features.

frequencynumber required

Frequency of the original data in Hz.

fftUsedinteger[]
resamplingAlgorithmVersionnumber

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

featureExplorerJobIdinteger

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

featureExplorerJobFailedboolean

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

featureImportanceJobIdinteger

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

featureImportanceJobFailedboolean

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

Changes

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