Get all impulses (incl. metrics)

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

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

impulses*array of DetailedImpulse (object)

metricKeysByCategory*array of object

extraTableColumns*array of string

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

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "error": "text",
  "impulses": [
    {
      "impulse": {
        "name": "text",
        "inputBlocks": [
          {
            "type": "time-series",
            "name": "Time series",
            "title": "Time series",
            "windowSizeMs": 2004,
            "frequencyHz": 60,
            "padZeros": false,
            "imageWidth": 28,
            "imageHeight": 28,
            "resizeMode": "squash",
            "resizeMethod": "squash",
            "cropAnchor": "middle-center",
            "description": "Reduced learning rate and more layers",
            "createdBy": "createImpulse",
            "createdAt": "2024-11-18T16:43:42.824Z",
            "datasetSubset": {
              "subsetModulo": 0,
              "subsetSeed": 0
            }
          }
        ],
        "dspBlocks": [
          {
            "type": "spectral-analysis",
            "name": "Spectral features",
            "axes": [
              "accX"
            ],
            "title": "Spectral Analysis",
            "valuesPerAxis": 11,
            "input": 1,
            "description": "Reduced learning rate and more layers",
            "createdBy": "createImpulse",
            "createdAt": "2024-11-18T16:43:42.824Z",
            "organization": {},
            "customUrl": "text",
            "namedAxes": [
              {
                "name": "text",
                "description": "text",
                "required": false,
                "selectedAxis": "text"
              }
            ]
          }
        ],
        "learnBlocks": [
          {
            "type": "anomaly",
            "name": "NN Classifier",
            "dsp": [
              27
            ],
            "title": "Classification (Keras)",
            "description": "Reduced learning rate and more layers",
            "createdBy": "createImpulse",
            "createdAt": "2024-11-18T16:43:42.824Z"
          }
        ]
      },
      "metrics": [
        {
          "name": "text",
          "type": "core",
          "filteringType": {
            "type": "numeric",
            "options": [
              "text"
            ]
          },
          "category": "impulseMetrics",
          "description": "text",
          "value": "text",
          "title": "text",
          "valueHint": "text"
        }
      ],
      "dspBlockConfigs": [
        {
          "config": {
            "dsp": {
              "id": 1,
              "name": "Spectral features",
              "windowLength": 3000,
              "type": "spectral-analysis",
              "classes": [
                "text"
              ],
              "features": {
                "generated": false,
                "labels": [
                  "text"
                ],
                "classes": [
                  "text"
                ]
              },
              "inputAxes": [
                "text"
              ],
              "performance": {},
              "canCalculateFeatureImportance": false,
              "calculateFeatureImportance": false,
              "hasAutoTune": false,
              "minimumVersionForAutotune": 0,
              "hasAutotunerResults": false,
              "usesState": false
            },
            "config": [
              {
                "group": "Scaling",
                "items": [
                  {
                    "name": "Scale axes",
                    "value": "text",
                    "defaultValue": "text",
                    "type": "text",
                    "help": "Divide axes by this number",
                    "param": "scale-axes",
                    "selectOptions": [
                      {
                        "value": "text",
                        "selected": false,
                        "optionLabel": "text"
                      }
                    ],
                    "readonly": false,
                    "shouldShow": false,
                    "showIf": {
                      "parameter": "text",
                      "operator": "eq",
                      "value": "text"
                    },
                    "invalidText": "text",
                    "section": "advanced",
                    "multiline": false,
                    "required": false,
                    "hint": "text",
                    "placeholder": "text"
                  }
                ]
              }
            ],
            "configError": "text"
          },
          "metadata": {
            "created": "2024-11-18T16:43:42.824Z",
            "labels": [
              "text"
            ],
            "featureLabels": [
              "text"
            ],
            "includedSamples": [
              {}
            ],
            "padZeros": false,
            "frequency": 0,
            "outputConfig": {
              "type": "image",
              "shape": {}
            },
            "fftUsed": [],
            "resamplingAlgorithmVersion": 0
          }
        }
      ],
      "pretrainedModelInfo": {
        "fileName": "text"
      },
      "isStale": false,
      "tags": [
        "text"
      ],
      "createdFromTunerTrialId": 0
    }
  ],
  "metricKeysByCategory": [
    {
      "category": "impulseMetrics",
      "metricKeys": [
        {
          "name": "text",
          "description": "text",
          "type": "core",
          "filteringType": {
            "type": "numeric",
            "options": [
              "text"
            ]
          },
          "showInTable": false
        }
      ]
    }
  ],
  "extraTableColumns": [
    "text"
  ]
}