Get impulse including disabled blocks

Retrieve the impulse for this project including disabled blocks. If you specify impulseId then that impulse is returned, otherwise the default impulse is returned.

GET /api/{projectId}/impulse/all

Try it

Get impulse including disabled blocks

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/impulse/all \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "error": "<string>",
  "impulse": {
    "id": 123,
    "name": "<string>",
    "inputBlocks": [
      {
        "id": 2,
        "type": "time-series",
        "name": "Time series",
        "title": "Time series",
        "windowSizeMs": 2004,
        "windowIncreaseMs": 123,
        "frequencyHz": 60,
        "classificationWindowIncreaseMs": 123,
        "padZeros": true,
        "labelingMethodMultiLabel": {
          "type": "end-of-window",
          "labels": [
            "<string>"
          ]
        },
        "imageWidth": 28,
        "imageHeight": 28,
        "resizeMode": "squash",
        "resizeMethod": "squash",
        "cropAnchor": "middle-center",
        "createdBy": "createImpulse",
        "createdAt": "2023-11-07T05:31:56Z",
        "datasetSubset": {
          "includePercentage": 123,
          "seed": 123
        }
      }
    ],
    "dspBlocks": [
      {
        "id": 2,
        "type": "spectral-analysis",
        "name": "Spectral features",
        "axes": [
          "accX"
        ],
        "title": "Spectral Analysis",
        "implementationVersion": 123,
        "valuesPerAxis": 11,
        "input": 1,
        "createdBy": "createImpulse",
        "createdAt": "2023-11-07T05:31:56Z",
        "organization": {
          "id": 123,
          "dspId": 123
        },
        "customUrl": "<string>",
        "namedAxes": [
          {
            "name": "<string>",
            "description": "<string>",
            "required": true,
            "selectedAxis": "<string>"
          }
        ]
      }
    ],
    "learnBlocks": [
      {
        "id": 2,
        "type": "anomaly",
        "name": "NN Classifier",
        "dsp": [
          27
        ],
        "title": "Classification (Keras)",
        "createdBy": "createImpulse",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "postProcessingBlocks": [
      {
        "id": 2,
        "type": "object-tracking",
        "name": "Object tracking",
        "title": "Object tracking",
        "implementationVersion": 123,
        "createdBy": "createImpulse",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Query Parameters

impulseId · integer

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

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

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

impulse · object

Show child attributes

impulse. id · integer · required

ID for this impulse.

impulse. name · string · required

Name for this impulse.

impulse. inputBlocks · object[] · required

Input Blocks that are part of this impulse

Show child attributes

impulse.inputBlocks. id · integer · required

Identifier for this block. Make sure to up this number when creating a new block via getNewBlockId, 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).

Required range: x >= 1

impulse.inputBlocks. type · enum<string> · required

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

Available options: time-series, image, features

Example:

"time-series"

impulse.inputBlocks. name · string · required

Block name, will be used in menus

Example:

"Time series"

impulse.inputBlocks. title · string · required

Block title, used in the impulse UI

Example:

"Time series"

impulse.inputBlocks. windowSizeMs · integer

Size of the sliding window in milliseconds

Example:

2004

impulse.inputBlocks. windowIncreaseMs · integer

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

impulse.inputBlocks. frequencyHz · number

(Input only) Frequency of the input data in Hz

Example:

60

impulse.inputBlocks. classificationWindowIncreaseMs · integer

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.

impulse.inputBlocks. padZeros · boolean

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

impulse.inputBlocks. labelingMethodMultiLabel · object

How to pick the label for multi-label samples

Show child attributes

impulse.inputBlocks.labelingMethodMultiLabel. type · enum<string> · required

Available options: end-of-window, anywhere-in-window

impulse.inputBlocks.labelingMethodMultiLabel. labels · string[]

Required when choosing "anywhere-in-window". The list of classes that should trigger detection (e.g. "interference").

impulse.inputBlocks. imageWidth · integer

Width all images are resized to before training

Example:

28

impulse.inputBlocks. imageHeight · integer

Width all images are resized to before training

Example:

28

impulse.inputBlocks. resizeMode · enum<string>

Input images are resized automatically before training and testing, to match the impulse input shape. This determines the resize mode used when the aspect ratio of the input data is different to the aspect ratio of the impulse.

Available options: squash, fit-short, fit-long, crop

Example:

"squash"

impulse.inputBlocks. resizeMethod · enum<string>

Resize method to use when resizing images

Available options: lanczos3, nearest

Example:

"squash"

impulse.inputBlocks. cropAnchor · enum<string>

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

Available options: top-left, top-center, top-right, middle-left, middle-center, middle-right, bottom-left, bottom-center, bottom-right

Example:

"middle-center"

impulse.inputBlocks. createdBy · string

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

Example:

"createImpulse"

impulse.inputBlocks. createdAt · string<date-time>

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

impulse.inputBlocks. datasetSubset · object

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

Show child attributes

impulse.inputBlocks.datasetSubset. includePercentage · number · required

Number between 0 and 100, with the % of data that should be included

impulse.inputBlocks.datasetSubset. seed · integer

Seed number (optional). If not specified, the seed is set to 0.

impulse. dspBlocks · object[] · required

DSP Blocks that are part of this impulse

Show child attributes

impulse.dspBlocks. id · integer · required

Identifier for this block. Make sure to up this number when creating a new block via getNewBlockId, 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).

Required range: x >= 1

impulse.dspBlocks. type · string · required

Block type

Example:

"spectral-analysis"

impulse.dspBlocks. name · string · required

Block name, will be used in menus

Example:

"Spectral features"

impulse.dspBlocks. axes · string[] · required

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

impulse.dspBlocks. title · string · required

Block title, used in the impulse UI

Example:

"Spectral Analysis"

impulse.dspBlocks. implementationVersion · integer · required

Implementation version of the block

impulse.dspBlocks. valuesPerAxis · integer

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

Example:

11

impulse.dspBlocks. input · integer

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

Example:

1

impulse.dspBlocks. createdBy · string

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

Example:

"createImpulse"

impulse.dspBlocks. createdAt · string<date-time>

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

impulse.dspBlocks. organization · object

Show child attributes

impulse.dspBlocks.organization. id · integer · required

impulse.dspBlocks.organization. dspId · integer · required

impulse.dspBlocks. customUrl · string

Required for type 'custom'

impulse.dspBlocks. namedAxes · object[]

Named axes for the block

Show child attributes

impulse.dspBlocks.namedAxes. name · string · required

Name of the axis

impulse.dspBlocks.namedAxes. description · string

Description of the axis

impulse.dspBlocks.namedAxes. required · boolean

Whether the axis is required

impulse.dspBlocks.namedAxes. selectedAxis · string

The selected axis for the block

impulse. learnBlocks · object[] · required

Learning Blocks that are part of this impulse

Show child attributes

impulse.learnBlocks. id · integer · required

Identifier for this block. Make sure to up this number when creating a new block via getNewBlockId, 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).

Required range: x >= 1

impulse.learnBlocks. type · enum<string> · required

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

Available options: anomaly, anomaly-gmm, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression, keras-akida, keras-akida-transfer-image, keras-akida-object-detection, keras-visual-anomaly

impulse.learnBlocks. name · string · required

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"

impulse.learnBlocks. dsp · integer[] · required

DSP dependencies, identified by DSP block ID

impulse.learnBlocks. title · string · required

Block title, used in the impulse UI

Example:

"Classification (Keras)"

impulse.learnBlocks. createdBy · string

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

Example:

"createImpulse"

impulse.learnBlocks. createdAt · string<date-time>

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

impulse. postProcessingBlocks · object[] · required

Post-processing blocks that are part of this impulse

Show child attributes

impulse.postProcessingBlocks. id · integer · required

Identifier for this block. Make sure to up this number when creating a new block via getNewBlockId, 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).

Required range: x >= 1

impulse.postProcessingBlocks. type · string · required

Block type

Example:

"object-tracking"

impulse.postProcessingBlocks. name · string · required

Block name, will be used in menus

Example:

"Object tracking"

impulse.postProcessingBlocks. title · string · required

Block title, used in the impulse UI

Example:

"Object tracking"

impulse.postProcessingBlocks. implementationVersion · integer · required

Implementation version of the block

impulse.postProcessingBlocks. createdBy · string

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

Example:

"createImpulse"

impulse.postProcessingBlocks. createdAt · string<date-time>

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