Get all impulses (incl. metrics)

Retrieve all impulse for a project, including accuracy and performance metrics.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

impulses*array of DetailedImpulse (object)

impulse*Impulse (object)

id*integer

ID for this impulse.

name*string

Name for this impulse.

inputBlocks*array of ImpulseInputBlock (object)

Input Blocks that are part of this impulse

id*integer

Identifier for this block. Make sure to up this number when creating a new block, and don't re-use identifiers. If the block hasn't changed, keep the ID as-is. ID must be unique across the project and greather than zero (>0).

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

dspBlocks*array of ImpulseDspBlock (object)

DSP Blocks that are part of this impulse

id*integer

type*string

Block type

Example: "spectral-analysis"

name*string

Block name, will be used in menus

Example: "Spectral features"

axes*array of string

Input axes, identified by the name in the name of the axis

itemsstring

Example: "accX"

title*string

Block title, used in the impulse UI

Example: "Spectral Analysis"

valuesPerAxisinteger

Number of features this DSP block outputs per axis. This is only set when the DSP block is configured.

Example: 11

inputinteger

The ID of the Input block a DSP block is connected to

Example: 1

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

implementationVersion*integer

Implementation version of the block

organizationobject

id*integer

dspId*integer

customUrlstring

Required for type 'custom'

namedAxesarray of object

Named axes for the block

name*string

Name of the axis

descriptionstring

Description of the axis

requiredboolean

Whether the axis is required

selectedAxisstring

The selected axis for the block

learnBlocks*array of ImpulseLearnBlock (object)

Learning Blocks that are part of this impulse

id*integer

type*LearnBlockType (enum)

The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.

anomalyanomaly-gmmkeraskeras-transfer-imagekeras-transfer-kwskeras-object-detectionkeras-regressionkeras-akidakeras-akida-transfer-imagekeras-akida-object-detectionkeras-visual-anomaly

name*string

Block name, will be used in menus. If a block has a baseBlockId, this field is ignored and the base block's name is used instead.

Example: "NN Classifier"

dsp*array of integer

DSP dependencies, identified by DSP block ID

itemsinteger

Example: 27

title*string

Block title, used in the impulse UI

Example: "Classification (Keras)"

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

metrics*array of DetailedImpulseMetric (object)

name*string

type*enum

coreadditional

filteringTypeDetailedImpulseMetricFilteringType (object)

type*enum

numericstringselectbooleanlist

options*array of string

itemsstring

category*DetailedImpulseMetricCategory (enum)

impulseMetricsinputBlockConfigdspBlockConfiglearnBlockConfiglearnBlockMetrics

description*string

value*one of

string

titlestring

valueForSortinginteger

valueHintstring

Additional help explaining the value for this metric

dspBlockConfigs*array of object

blockId*integer

config*DSPConfig (object)

dsp*DSPInfo (object)

id*integer

Example: 1

name*string

Example: "Spectral features"

windowLength*integer

Example: 3000

type*string

Example: "spectral-analysis"

classes*array of string

itemsstring

features*object

generated*boolean

Whether this block has generated features

countinteger

Number of generated features

labelsarray of string

Names of the features

itemsstring

classesarray of string

Classes that the features were generated on

itemsstring

expectedWindowCount*integer

Expected number of windows that would be generated

inputAxes*array of string

Axes that this block depends on.

itemsstring

performanceDspPerformance (object)

latency*integer

ram*integer

customDspStringstring

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

canCalculateFeatureImportance*boolean

calculateFeatureImportance*boolean

hasAutoTuneboolean

Whether this type of DSP block supports autotuning.

minimumVersionForAutotunenumber

For DSP blocks that support autotuning, this value specifies the minimum block implementation version for which autotuning is supported.

hasAutotunerResultsboolean

Whether autotune results exist for this DSP block.

usesStateboolean

Whether this DSP block uses state.

configarray of DSPGroup (object)

group*string

Example: "Scaling"

items*array of DSPGroupItem (object)

name*string

Example: "Scale axes"

valuestring

defaultValue*string

type*string

Example: "text"

helpstring

Example: "Divide axes by this number"

param*string

Example: "scale-axes"

selectOptionsarray of object

valuestring

selectedboolean

optionLabelstring

readonly*boolean

shouldShow*boolean

showIfobject

parameter*string

operator*enum

eqneq

value*string

invalidTextstring

sectionenum

Interface section to render parameter in.

advancedaugmentationmodelProfiling

multilineboolean

Only valid for type "string". Will render a multiline text area.

required*boolean

hintstring

If set, shows a hint below the input.

placeholderstring

Sets the placeholder text on the input element (for types "string", "int", "float" and "secret")

configErrorstring

metadataDSPMetadata (object)

created*string (date-time)

Date when the features were created

dspConfig*object

Other propertiesstring

labels*array of string

Labels in the dataset when generator ran

itemsstring

featureLabelsarray of string

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

itemsstring

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.

id*integer

windowCount*integer

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

type*enum

Output type of the DSP block

imagespectrogramflat

shape*object

The shape of the block output

width*integer

Available on all types. Denotes the width of an 'image' or 'spectrogram', or the number of features in a 'flat' block.

heightinteger

Only available for type 'image' and 'spectrogram'

channelsinteger

Only available for type 'image'

framesinteger

Number of frames, only available for type 'image'

fftUsedarray of integer

itemsinteger

resamplingAlgorithmVersionnumber

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

learnBlockKerasConfigs*any

learnBlockAnomalyConfigs*any

pretrainedModelInfoobject

fileName*string

isStale*boolean

Whether this impulse contains blocks with "stale" features (i.e. the dataset has changed since features were generated)

tags*array of string

Tags associated with this impulse

itemsstring

createdFromTunerTrialIdnumber

The source EON Tuner trial ID for impulses created from the EON Tuner

metricKeysByCategory*array of object

category*DetailedImpulseMetricCategory (enum)

impulseMetricsinputBlockConfigdspBlockConfiglearnBlockConfiglearnBlockMetrics

metricKeys*array of object

name*string

description*string

type*enum

coreadditional

filteringTypeDetailedImpulseMetricFilteringType (object)

type*enum

numericstringselectbooleanlist

options*array of string

itemsstring

showInTable*boolean

extraTableColumns*array of string

Which extra impulse information should be shown in the impulses table.

itemsstring

Request

Response