Get all impulses (incl. metrics)
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed \
--header 'x-api-key: <api-key>'import requests
url = "https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"impulses": [
{
"impulse": {
"id": 123,
"name": "<string>",
"inputBlocks": [
{
"id": 2,
"type": "time-series",
"name": "Time series",
"title": "Time series",
"axes": [
"accX"
],
"windowSizeMs": 2004,
"windowIncreaseMs": 123,
"frequencyHz": 60,
"classificationWindowIncreaseMs": 123,
"padZeros": true,
"labelingMethodMultiLabel": {
"type": "end-of-window",
"labels": [
"<string>"
],
"minPercentage": 123
},
"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",
"trainingProcessor": "cpu"
}
],
"postProcessingBlocks": [
{
"id": 2,
"type": "object-tracking",
"name": "Object tracking",
"title": "Object tracking",
"implementationVersion": 123,
"createdBy": "createImpulse",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"type": "default",
"datasetVersionId": 123
},
"metrics": [
{
"name": "<string>",
"type": "core",
"category": "impulseMetrics",
"description": "<string>",
"value": "<string>",
"filteringType": {
"type": "numeric",
"options": [
"<string>"
]
},
"title": "<string>",
"valueForSorting": 123,
"valueHint": "<string>"
}
],
"dspBlockConfigs": [
{
"blockId": 123,
"config": {
"dsp": {
"id": 1,
"name": "Spectral features",
"windowLength": 3000,
"type": "spectral-analysis",
"classes": [
"<string>"
],
"features": {
"generated": true,
"count": 123,
"labels": [
"<string>"
],
"classes": [
"<string>"
]
},
"expectedWindowCount": 123,
"inputAxes": [
"<string>"
],
"canCalculateFeatureImportance": true,
"calculateFeatureImportance": true,
"canNormalizeData": true,
"normalizeData": "none",
"classesPerKey": {},
"performance": {
"latency": 123,
"ram": 123,
"customDspString": "<string>"
},
"hasAutoTune": true,
"minimumVersionForAutotune": 123,
"hasAutotunerResults": true,
"usesState": true
},
"config": [
{
"group": "Scaling",
"items": [
{
"name": "Scale axes",
"defaultValue": "<string>",
"type": "text",
"param": "scale-axes",
"readonly": true,
"shouldShow": true,
"required": true,
"showClickToSet": true,
"value": "<string>",
"help": "Divide axes by this number",
"selectOptions": [
{
"value": "<string>",
"selected": true,
"optionLabel": "<string>",
"priority": 123,
"romEstimate": 123,
"needsOps": [
"<string>"
],
"needsFeatures": [
"<string>"
]
}
],
"showIf": {
"parameter": "<string>",
"operator": "eq",
"value": "<string>"
},
"invalidText": "<string>",
"section": "advanced",
"multiline": true,
"hint": "<string>",
"placeholder": "<string>",
"valid": [
{}
],
"items": {},
"properties": {},
"minVal": 123,
"maxVal": 123
}
]
}
],
"configError": "<string>"
},
"metadata": {
"created": "2023-11-07T05:31:56Z",
"generated": true,
"dspConfig": {},
"labels": [
"<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
}
},
"featureLabels": [
"<string>"
],
"fftUsed": [
123
],
"resamplingAlgorithmVersion": 123,
"featureExplorerJobId": 123,
"featureExplorerJobFailed": true,
"featureImportanceJobId": 123,
"featureImportanceJobFailed": true
}
}
],
"learnBlockKerasConfigs": [
{
"blockId": 123,
"config": {
"dependencies": {
"classes": [
"<string>"
],
"blockNames": [
"<string>"
],
"featureCount": 123,
"sampleCount": 123,
"outputClasses": [
"<string>"
],
"classesPerKey": {}
},
"trained": true,
"name": "<string>",
"script": "<string>",
"minimumConfidenceRating": 123,
"selectedModelType": "int8",
"mode": "visual",
"visualLayers": [
{
"type": "dense",
"neurons": 123,
"kernelSize": 123,
"dropoutRate": 123,
"columns": 123,
"stack": 123,
"enabled": true,
"organizationModelId": 123
}
],
"trainingCycles": 123,
"learningRate": 123,
"defaultBatchSize": 123,
"shape": "<string>",
"augmentationPolicyImage": "none",
"transferLearningModels": [
{
"name": "<string>",
"shortName": "<string>",
"description": "<string>",
"hasNeurons": true,
"hasDropout": true,
"type": "dense",
"learnBlockType": "anomaly",
"author": "<string>",
"blockType": "official",
"hasExpertMode": true,
"abbreviatedName": "<string>",
"defaultNeurons": 123,
"defaultDropout": 123,
"defaultLearningRate": 123,
"defaultTrainingCycles": 123,
"hasImageAugmentation": true,
"organizationModelId": 123,
"implementationVersion": 123,
"repositoryUrl": "<string>",
"customBlockRef": "<string>",
"customParameters": [
{
"name": "Scale axes",
"defaultValue": "<string>",
"type": "text",
"param": "scale-axes",
"readonly": true,
"shouldShow": true,
"required": true,
"showClickToSet": true,
"value": "<string>",
"help": "Divide axes by this number",
"selectOptions": [
{
"value": "<string>",
"selected": true,
"optionLabel": "<string>",
"priority": 123,
"romEstimate": 123,
"needsOps": [
"<string>"
],
"needsFeatures": [
"<string>"
]
}
],
"showIf": {
"parameter": "<string>",
"operator": "eq",
"value": "<string>"
},
"invalidText": "<string>",
"section": "advanced",
"multiline": true,
"hint": "<string>",
"placeholder": "<string>",
"valid": [
{}
],
"items": {},
"properties": {},
"minVal": 123,
"maxVal": 123
}
],
"displayCategory": "classical",
"blockNoLongerAvailable": {
"reasonMarkdown": "<string>",
"reasonHtml": "<string>"
}
}
],
"profileInt8": true,
"skipEmbeddingsAndMemory": true,
"showAdvancedTrainingSettings": true,
"showAugmentationTrainingSettings": true,
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"type": "anomaly",
"batchSize": 123,
"trainTestSplit": 123,
"autoClassWeights": true,
"useLearnedOptimizer": true,
"augmentationPolicySpectrogram": {
"enabled": true,
"warping": true,
"freqMasking": "none",
"timeMasking": "none",
"gaussianNoise": "none"
},
"akidaEdgeLearningConfig": {
"enabled": true,
"additionalClasses": 123,
"neuronsPerClass": 123
},
"customValidationMetadataKey": "<string>",
"customParameters": {},
"anomalyCapacity": "low",
"lastShownModelVariant": "int8",
"blockParameters": {
"backbone": "<string>",
"numLayers": 123,
"poolSize": 123,
"samplingRatio": 123,
"numNearestNeighbors": 123
},
"kFoldsValidationConfig": {
"numFolds": 123,
"includeFinalTrainingRun": true,
"extraEpochs": 123
},
"isMultiHead": true
},
"metadata": {
"created": "2023-11-07T05:31:56Z",
"layers": [
{
"input": {
"shape": 33,
"name": "x_input:0",
"type": "<dtype: 'float32'>"
},
"output": {
"shape": 20,
"name": "dense_1/Relu:0",
"type": "<dtype: 'float32'>"
}
}
],
"classNames": [
"<string>"
],
"labels": [
"<string>"
],
"availableModelTypes": [
"int8"
],
"recommendedModelType": "int8",
"modelValidationMetrics": [
{
"type": "int8",
"loss": 123,
"confusionMatrix": [
[
31,
1,
0
],
[
2,
27,
3
],
[
1,
0,
39
]
],
"report": {},
"onDevicePerformance": [
{
"mcu": "<string>",
"name": "<string>",
"isDefault": true,
"latency": 123,
"tflite": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"eon": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"hasPerformance": true,
"eon_ram_optimized": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"customMetrics": [
{
"name": "<string>",
"value": "<string>"
}
],
"profilingError": "<string>"
}
],
"visualization": "featureExplorer",
"isSupportedOnMcu": true,
"additionalMetrics": [
{
"name": "<string>",
"value": "<string>",
"fullPrecisionValue": 123,
"tooltipText": "<string>",
"link": "<string>"
}
],
"accuracy": 123,
"predictions": [
{
"sampleId": 123,
"startMs": 123,
"endMs": 123,
"prediction": "<string>",
"label": "<string>",
"predictionCorrect": true,
"expectedAnomalyOutcome": "<string>",
"f1Score": 123,
"anomalyScores": [
[
123
]
],
"boundingBoxes": [
{
"label": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"score": 123
}
],
"labelMapPredictions": {}
}
],
"mcuSupportError": "<string>",
"profilingJobId": 123,
"profilingJobFailed": true
}
],
"hasTrainedModel": true,
"mode": "classification",
"imageInputScaling": "0..1",
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"objectDetectionLastLayer": "mobilenet-ssd",
"tensorboardGraphs": [
{
"title": "<string>",
"data": [
{
"title": "<string>",
"values": [
123
]
}
],
"xLabel": "<string>",
"yLabel": "<string>",
"description": "<string>",
"hideInUI": true
}
],
"kFoldsMetadata": {
"folds": [
{
"created": "2023-11-07T05:31:56Z",
"layers": [
{
"input": {
"shape": 33,
"name": "x_input:0",
"type": "<dtype: 'float32'>"
},
"output": {
"shape": 20,
"name": "dense_1/Relu:0",
"type": "<dtype: 'float32'>"
}
}
],
"classNames": [
"<string>"
],
"labels": [
"<string>"
],
"availableModelTypes": [
"int8"
],
"recommendedModelType": "int8",
"modelValidationMetrics": [
{
"type": "int8",
"loss": 123,
"confusionMatrix": [
[
31,
1,
0
],
[
2,
27,
3
],
[
1,
0,
39
]
],
"report": {},
"onDevicePerformance": [
{
"mcu": "<string>",
"name": "<string>",
"isDefault": true,
"latency": 123,
"tflite": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"eon": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"hasPerformance": true,
"eon_ram_optimized": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"customMetrics": [
{
"name": "<string>",
"value": "<string>"
}
],
"profilingError": "<string>"
}
],
"visualization": "featureExplorer",
"isSupportedOnMcu": true,
"additionalMetrics": [
{
"name": "<string>",
"value": "<string>",
"fullPrecisionValue": 123,
"tooltipText": "<string>",
"link": "<string>"
}
],
"accuracy": 123,
"predictions": [
{
"sampleId": 123,
"startMs": 123,
"endMs": 123,
"prediction": "<string>",
"label": "<string>",
"predictionCorrect": true,
"expectedAnomalyOutcome": "<string>",
"f1Score": 123,
"anomalyScores": [
[
123
]
],
"boundingBoxes": [
{
"label": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"score": 123
}
],
"labelMapPredictions": {}
}
],
"mcuSupportError": "<string>",
"profilingJobId": 123,
"profilingJobFailed": true
}
],
"hasTrainedModel": true,
"mode": "classification",
"imageInputScaling": "0..1",
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"foldId": 1,
"foldName": "<string>",
"objectDetectionLastLayer": "mobilenet-ssd",
"tensorboardGraphs": [
{
"title": "<string>",
"data": [
{
"title": "<string>",
"values": [
123
]
}
],
"xLabel": "<string>",
"yLabel": "<string>",
"description": "<string>",
"hideInUI": true
}
]
}
],
"persistedFoldId": 123,
"persistedFoldName": "<string>",
"hasFinalRun": true,
"persistedFoldMetricType": "int8"
}
}
}
],
"learnBlockAnomalyConfigs": [
{
"blockId": 123,
"config": {
"dependencies": {
"classes": [
"<string>"
],
"blockNames": [
"<string>"
],
"featureCount": 123,
"sampleCount": 123,
"outputClasses": [
"<string>"
],
"classesPerKey": {}
},
"name": "<string>",
"axes": [
{
"ix": 123,
"label": "<string>",
"selected": true,
"favourite": true
}
],
"trained": true,
"selectedAxes": [
123
],
"minimumConfidenceRating": 123,
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"clusterCount": 123
},
"metadata": {
"created": "2023-11-07T05:31:56Z",
"scale": [
123
],
"mean": [
123
],
"clusters": [
{
"center": [
123
],
"maxError": 123
}
],
"axes": "`[ 0, 11, 22 ]`",
"defaultMinimumConfidenceRating": 123,
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"availableModelTypes": [
"int8"
],
"recommendedModelType": "int8",
"modelValidationMetrics": [
{
"type": "int8",
"loss": 123,
"confusionMatrix": [
[
31,
1,
0
],
[
2,
27,
3
],
[
1,
0,
39
]
],
"report": {},
"onDevicePerformance": [
{
"mcu": "<string>",
"name": "<string>",
"isDefault": true,
"latency": 123,
"tflite": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"eon": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"hasPerformance": true,
"eon_ram_optimized": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"customMetrics": [
{
"name": "<string>",
"value": "<string>"
}
],
"profilingError": "<string>"
}
],
"visualization": "featureExplorer",
"isSupportedOnMcu": true,
"additionalMetrics": [
{
"name": "<string>",
"value": "<string>",
"fullPrecisionValue": 123,
"tooltipText": "<string>",
"link": "<string>"
}
],
"accuracy": 123,
"predictions": [
{
"sampleId": 123,
"startMs": 123,
"endMs": 123,
"prediction": "<string>",
"label": "<string>",
"predictionCorrect": true,
"expectedAnomalyOutcome": "<string>",
"f1Score": 123,
"anomalyScores": [
[
123
]
],
"boundingBoxes": [
{
"label": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"score": 123
}
],
"labelMapPredictions": {}
}
],
"mcuSupportError": "<string>",
"profilingJobId": 123,
"profilingJobFailed": true
}
],
"hasTrainedModel": true
},
"gmmMetadata": {
"means": [
[
123
]
],
"covariances": [
[
[
123
]
]
],
"weights": [
123
]
}
}
],
"postProcessingBlockConfigs": [
{
"blockId": 123,
"config": {
"enabled": true,
"parameters": [
{
"name": "Scale axes",
"defaultValue": "<string>",
"type": "text",
"param": "scale-axes",
"readonly": true,
"shouldShow": true,
"required": true,
"showClickToSet": true,
"value": "<string>",
"help": "Divide axes by this number",
"selectOptions": [
{
"value": "<string>",
"selected": true,
"optionLabel": "<string>",
"priority": 123,
"romEstimate": 123,
"needsOps": [
"<string>"
],
"needsFeatures": [
"<string>"
]
}
],
"showIf": {
"parameter": "<string>",
"operator": "eq",
"value": "<string>"
},
"invalidText": "<string>",
"section": "advanced",
"multiline": true,
"hint": "<string>",
"placeholder": "<string>",
"valid": [
{}
],
"items": {},
"properties": {},
"minVal": 123,
"maxVal": 123
}
],
"type": "object-tracking"
}
}
],
"isStale": true,
"configured": true,
"complete": true,
"tags": [
"<string>"
],
"pretrainedModelInfo": {
"fileName": "<string>"
},
"createdFromTunerTrialId": 123,
"createdByUser": {
"id": 123,
"name": "<string>",
"username": "<string>",
"photo": "<string>"
},
"datasetVersion": {
"id": 123,
"created": "2023-11-07T05:31:56Z",
"versionIndex": 123,
"description": "<string>",
"parentVersionId": 123,
"type": "auto_save",
"summary": {
"rawEventCountInWindow": 123,
"sampleChangesCount": 123,
"actionCounts": {
"insert": 123,
"update": 123,
"delete": 123
}
},
"windowStart": "2023-11-07T05:31:56Z",
"windowEnd": "2023-11-07T05:31:56Z",
"actors": [
{
"id": 123,
"name": "<string>",
"username": "<string>",
"type": "user",
"photo": "<string>"
}
],
"restoredFromDatasetVersionId": 123
}
}
],
"metricKeysByCategory": [
{
"category": "impulseMetrics",
"metricKeys": [
{
"name": "<string>",
"description": "<string>",
"type": "core",
"showInTable": true,
"filteringType": {
"type": "numeric",
"options": [
"<string>"
]
}
}
]
}
],
"extraTableColumns": [
"<string>"
],
"error": "<string>"
}Get all impulses (incl. metrics)
Retrieve all impulse for a project, including accuracy and performance metrics.
GET
/
api
/
{projectId}
/
impulses-detailed
Get all impulses (incl. metrics)
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed \
--header 'x-api-key: <api-key>'import requests
url = "https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/impulses-detailed")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"impulses": [
{
"impulse": {
"id": 123,
"name": "<string>",
"inputBlocks": [
{
"id": 2,
"type": "time-series",
"name": "Time series",
"title": "Time series",
"axes": [
"accX"
],
"windowSizeMs": 2004,
"windowIncreaseMs": 123,
"frequencyHz": 60,
"classificationWindowIncreaseMs": 123,
"padZeros": true,
"labelingMethodMultiLabel": {
"type": "end-of-window",
"labels": [
"<string>"
],
"minPercentage": 123
},
"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",
"trainingProcessor": "cpu"
}
],
"postProcessingBlocks": [
{
"id": 2,
"type": "object-tracking",
"name": "Object tracking",
"title": "Object tracking",
"implementationVersion": 123,
"createdBy": "createImpulse",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"type": "default",
"datasetVersionId": 123
},
"metrics": [
{
"name": "<string>",
"type": "core",
"category": "impulseMetrics",
"description": "<string>",
"value": "<string>",
"filteringType": {
"type": "numeric",
"options": [
"<string>"
]
},
"title": "<string>",
"valueForSorting": 123,
"valueHint": "<string>"
}
],
"dspBlockConfigs": [
{
"blockId": 123,
"config": {
"dsp": {
"id": 1,
"name": "Spectral features",
"windowLength": 3000,
"type": "spectral-analysis",
"classes": [
"<string>"
],
"features": {
"generated": true,
"count": 123,
"labels": [
"<string>"
],
"classes": [
"<string>"
]
},
"expectedWindowCount": 123,
"inputAxes": [
"<string>"
],
"canCalculateFeatureImportance": true,
"calculateFeatureImportance": true,
"canNormalizeData": true,
"normalizeData": "none",
"classesPerKey": {},
"performance": {
"latency": 123,
"ram": 123,
"customDspString": "<string>"
},
"hasAutoTune": true,
"minimumVersionForAutotune": 123,
"hasAutotunerResults": true,
"usesState": true
},
"config": [
{
"group": "Scaling",
"items": [
{
"name": "Scale axes",
"defaultValue": "<string>",
"type": "text",
"param": "scale-axes",
"readonly": true,
"shouldShow": true,
"required": true,
"showClickToSet": true,
"value": "<string>",
"help": "Divide axes by this number",
"selectOptions": [
{
"value": "<string>",
"selected": true,
"optionLabel": "<string>",
"priority": 123,
"romEstimate": 123,
"needsOps": [
"<string>"
],
"needsFeatures": [
"<string>"
]
}
],
"showIf": {
"parameter": "<string>",
"operator": "eq",
"value": "<string>"
},
"invalidText": "<string>",
"section": "advanced",
"multiline": true,
"hint": "<string>",
"placeholder": "<string>",
"valid": [
{}
],
"items": {},
"properties": {},
"minVal": 123,
"maxVal": 123
}
]
}
],
"configError": "<string>"
},
"metadata": {
"created": "2023-11-07T05:31:56Z",
"generated": true,
"dspConfig": {},
"labels": [
"<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
}
},
"featureLabels": [
"<string>"
],
"fftUsed": [
123
],
"resamplingAlgorithmVersion": 123,
"featureExplorerJobId": 123,
"featureExplorerJobFailed": true,
"featureImportanceJobId": 123,
"featureImportanceJobFailed": true
}
}
],
"learnBlockKerasConfigs": [
{
"blockId": 123,
"config": {
"dependencies": {
"classes": [
"<string>"
],
"blockNames": [
"<string>"
],
"featureCount": 123,
"sampleCount": 123,
"outputClasses": [
"<string>"
],
"classesPerKey": {}
},
"trained": true,
"name": "<string>",
"script": "<string>",
"minimumConfidenceRating": 123,
"selectedModelType": "int8",
"mode": "visual",
"visualLayers": [
{
"type": "dense",
"neurons": 123,
"kernelSize": 123,
"dropoutRate": 123,
"columns": 123,
"stack": 123,
"enabled": true,
"organizationModelId": 123
}
],
"trainingCycles": 123,
"learningRate": 123,
"defaultBatchSize": 123,
"shape": "<string>",
"augmentationPolicyImage": "none",
"transferLearningModels": [
{
"name": "<string>",
"shortName": "<string>",
"description": "<string>",
"hasNeurons": true,
"hasDropout": true,
"type": "dense",
"learnBlockType": "anomaly",
"author": "<string>",
"blockType": "official",
"hasExpertMode": true,
"abbreviatedName": "<string>",
"defaultNeurons": 123,
"defaultDropout": 123,
"defaultLearningRate": 123,
"defaultTrainingCycles": 123,
"hasImageAugmentation": true,
"organizationModelId": 123,
"implementationVersion": 123,
"repositoryUrl": "<string>",
"customBlockRef": "<string>",
"customParameters": [
{
"name": "Scale axes",
"defaultValue": "<string>",
"type": "text",
"param": "scale-axes",
"readonly": true,
"shouldShow": true,
"required": true,
"showClickToSet": true,
"value": "<string>",
"help": "Divide axes by this number",
"selectOptions": [
{
"value": "<string>",
"selected": true,
"optionLabel": "<string>",
"priority": 123,
"romEstimate": 123,
"needsOps": [
"<string>"
],
"needsFeatures": [
"<string>"
]
}
],
"showIf": {
"parameter": "<string>",
"operator": "eq",
"value": "<string>"
},
"invalidText": "<string>",
"section": "advanced",
"multiline": true,
"hint": "<string>",
"placeholder": "<string>",
"valid": [
{}
],
"items": {},
"properties": {},
"minVal": 123,
"maxVal": 123
}
],
"displayCategory": "classical",
"blockNoLongerAvailable": {
"reasonMarkdown": "<string>",
"reasonHtml": "<string>"
}
}
],
"profileInt8": true,
"skipEmbeddingsAndMemory": true,
"showAdvancedTrainingSettings": true,
"showAugmentationTrainingSettings": true,
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"type": "anomaly",
"batchSize": 123,
"trainTestSplit": 123,
"autoClassWeights": true,
"useLearnedOptimizer": true,
"augmentationPolicySpectrogram": {
"enabled": true,
"warping": true,
"freqMasking": "none",
"timeMasking": "none",
"gaussianNoise": "none"
},
"akidaEdgeLearningConfig": {
"enabled": true,
"additionalClasses": 123,
"neuronsPerClass": 123
},
"customValidationMetadataKey": "<string>",
"customParameters": {},
"anomalyCapacity": "low",
"lastShownModelVariant": "int8",
"blockParameters": {
"backbone": "<string>",
"numLayers": 123,
"poolSize": 123,
"samplingRatio": 123,
"numNearestNeighbors": 123
},
"kFoldsValidationConfig": {
"numFolds": 123,
"includeFinalTrainingRun": true,
"extraEpochs": 123
},
"isMultiHead": true
},
"metadata": {
"created": "2023-11-07T05:31:56Z",
"layers": [
{
"input": {
"shape": 33,
"name": "x_input:0",
"type": "<dtype: 'float32'>"
},
"output": {
"shape": 20,
"name": "dense_1/Relu:0",
"type": "<dtype: 'float32'>"
}
}
],
"classNames": [
"<string>"
],
"labels": [
"<string>"
],
"availableModelTypes": [
"int8"
],
"recommendedModelType": "int8",
"modelValidationMetrics": [
{
"type": "int8",
"loss": 123,
"confusionMatrix": [
[
31,
1,
0
],
[
2,
27,
3
],
[
1,
0,
39
]
],
"report": {},
"onDevicePerformance": [
{
"mcu": "<string>",
"name": "<string>",
"isDefault": true,
"latency": 123,
"tflite": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"eon": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"hasPerformance": true,
"eon_ram_optimized": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"customMetrics": [
{
"name": "<string>",
"value": "<string>"
}
],
"profilingError": "<string>"
}
],
"visualization": "featureExplorer",
"isSupportedOnMcu": true,
"additionalMetrics": [
{
"name": "<string>",
"value": "<string>",
"fullPrecisionValue": 123,
"tooltipText": "<string>",
"link": "<string>"
}
],
"accuracy": 123,
"predictions": [
{
"sampleId": 123,
"startMs": 123,
"endMs": 123,
"prediction": "<string>",
"label": "<string>",
"predictionCorrect": true,
"expectedAnomalyOutcome": "<string>",
"f1Score": 123,
"anomalyScores": [
[
123
]
],
"boundingBoxes": [
{
"label": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"score": 123
}
],
"labelMapPredictions": {}
}
],
"mcuSupportError": "<string>",
"profilingJobId": 123,
"profilingJobFailed": true
}
],
"hasTrainedModel": true,
"mode": "classification",
"imageInputScaling": "0..1",
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"objectDetectionLastLayer": "mobilenet-ssd",
"tensorboardGraphs": [
{
"title": "<string>",
"data": [
{
"title": "<string>",
"values": [
123
]
}
],
"xLabel": "<string>",
"yLabel": "<string>",
"description": "<string>",
"hideInUI": true
}
],
"kFoldsMetadata": {
"folds": [
{
"created": "2023-11-07T05:31:56Z",
"layers": [
{
"input": {
"shape": 33,
"name": "x_input:0",
"type": "<dtype: 'float32'>"
},
"output": {
"shape": 20,
"name": "dense_1/Relu:0",
"type": "<dtype: 'float32'>"
}
}
],
"classNames": [
"<string>"
],
"labels": [
"<string>"
],
"availableModelTypes": [
"int8"
],
"recommendedModelType": "int8",
"modelValidationMetrics": [
{
"type": "int8",
"loss": 123,
"confusionMatrix": [
[
31,
1,
0
],
[
2,
27,
3
],
[
1,
0,
39
]
],
"report": {},
"onDevicePerformance": [
{
"mcu": "<string>",
"name": "<string>",
"isDefault": true,
"latency": 123,
"tflite": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"eon": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"hasPerformance": true,
"eon_ram_optimized": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"customMetrics": [
{
"name": "<string>",
"value": "<string>"
}
],
"profilingError": "<string>"
}
],
"visualization": "featureExplorer",
"isSupportedOnMcu": true,
"additionalMetrics": [
{
"name": "<string>",
"value": "<string>",
"fullPrecisionValue": 123,
"tooltipText": "<string>",
"link": "<string>"
}
],
"accuracy": 123,
"predictions": [
{
"sampleId": 123,
"startMs": 123,
"endMs": 123,
"prediction": "<string>",
"label": "<string>",
"predictionCorrect": true,
"expectedAnomalyOutcome": "<string>",
"f1Score": 123,
"anomalyScores": [
[
123
]
],
"boundingBoxes": [
{
"label": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"score": 123
}
],
"labelMapPredictions": {}
}
],
"mcuSupportError": "<string>",
"profilingJobId": 123,
"profilingJobFailed": true
}
],
"hasTrainedModel": true,
"mode": "classification",
"imageInputScaling": "0..1",
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"foldId": 1,
"foldName": "<string>",
"objectDetectionLastLayer": "mobilenet-ssd",
"tensorboardGraphs": [
{
"title": "<string>",
"data": [
{
"title": "<string>",
"values": [
123
]
}
],
"xLabel": "<string>",
"yLabel": "<string>",
"description": "<string>",
"hideInUI": true
}
]
}
],
"persistedFoldId": 123,
"persistedFoldName": "<string>",
"hasFinalRun": true,
"persistedFoldMetricType": "int8"
}
}
}
],
"learnBlockAnomalyConfigs": [
{
"blockId": 123,
"config": {
"dependencies": {
"classes": [
"<string>"
],
"blockNames": [
"<string>"
],
"featureCount": 123,
"sampleCount": 123,
"outputClasses": [
"<string>"
],
"classesPerKey": {}
},
"name": "<string>",
"axes": [
{
"ix": 123,
"label": "<string>",
"selected": true,
"favourite": true
}
],
"trained": true,
"selectedAxes": [
123
],
"minimumConfidenceRating": 123,
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"clusterCount": 123
},
"metadata": {
"created": "2023-11-07T05:31:56Z",
"scale": [
123
],
"mean": [
123
],
"clusters": [
{
"center": [
123
],
"maxError": 123
}
],
"axes": "`[ 0, 11, 22 ]`",
"defaultMinimumConfidenceRating": 123,
"thresholds": [
{
"key": "min_score",
"description": "Score threshold",
"helpText": "Threshold score for bounding boxes. If the score for a bounding box is below this the box will be discarded.",
"value": 0.5,
"suggestedValue": 123,
"suggestedValueText": "<string>",
"dropdownOptions": [
{
"description": "<string>",
"value": "<string>"
}
]
}
],
"availableModelTypes": [
"int8"
],
"recommendedModelType": "int8",
"modelValidationMetrics": [
{
"type": "int8",
"loss": 123,
"confusionMatrix": [
[
31,
1,
0
],
[
2,
27,
3
],
[
1,
0,
39
]
],
"report": {},
"onDevicePerformance": [
{
"mcu": "<string>",
"name": "<string>",
"isDefault": true,
"latency": 123,
"tflite": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"eon": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"hasPerformance": true,
"eon_ram_optimized": {
"ramRequired": 123,
"romRequired": 123,
"arenaSize": 123,
"modelSize": 123
},
"customMetrics": [
{
"name": "<string>",
"value": "<string>"
}
],
"profilingError": "<string>"
}
],
"visualization": "featureExplorer",
"isSupportedOnMcu": true,
"additionalMetrics": [
{
"name": "<string>",
"value": "<string>",
"fullPrecisionValue": 123,
"tooltipText": "<string>",
"link": "<string>"
}
],
"accuracy": 123,
"predictions": [
{
"sampleId": 123,
"startMs": 123,
"endMs": 123,
"prediction": "<string>",
"label": "<string>",
"predictionCorrect": true,
"expectedAnomalyOutcome": "<string>",
"f1Score": 123,
"anomalyScores": [
[
123
]
],
"boundingBoxes": [
{
"label": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"score": 123
}
],
"labelMapPredictions": {}
}
],
"mcuSupportError": "<string>",
"profilingJobId": 123,
"profilingJobFailed": true
}
],
"hasTrainedModel": true
},
"gmmMetadata": {
"means": [
[
123
]
],
"covariances": [
[
[
123
]
]
],
"weights": [
123
]
}
}
],
"postProcessingBlockConfigs": [
{
"blockId": 123,
"config": {
"enabled": true,
"parameters": [
{
"name": "Scale axes",
"defaultValue": "<string>",
"type": "text",
"param": "scale-axes",
"readonly": true,
"shouldShow": true,
"required": true,
"showClickToSet": true,
"value": "<string>",
"help": "Divide axes by this number",
"selectOptions": [
{
"value": "<string>",
"selected": true,
"optionLabel": "<string>",
"priority": 123,
"romEstimate": 123,
"needsOps": [
"<string>"
],
"needsFeatures": [
"<string>"
]
}
],
"showIf": {
"parameter": "<string>",
"operator": "eq",
"value": "<string>"
},
"invalidText": "<string>",
"section": "advanced",
"multiline": true,
"hint": "<string>",
"placeholder": "<string>",
"valid": [
{}
],
"items": {},
"properties": {},
"minVal": 123,
"maxVal": 123
}
],
"type": "object-tracking"
}
}
],
"isStale": true,
"configured": true,
"complete": true,
"tags": [
"<string>"
],
"pretrainedModelInfo": {
"fileName": "<string>"
},
"createdFromTunerTrialId": 123,
"createdByUser": {
"id": 123,
"name": "<string>",
"username": "<string>",
"photo": "<string>"
},
"datasetVersion": {
"id": 123,
"created": "2023-11-07T05:31:56Z",
"versionIndex": 123,
"description": "<string>",
"parentVersionId": 123,
"type": "auto_save",
"summary": {
"rawEventCountInWindow": 123,
"sampleChangesCount": 123,
"actionCounts": {
"insert": 123,
"update": 123,
"delete": 123
}
},
"windowStart": "2023-11-07T05:31:56Z",
"windowEnd": "2023-11-07T05:31:56Z",
"actors": [
{
"id": 123,
"name": "<string>",
"username": "<string>",
"type": "user",
"photo": "<string>"
}
],
"restoredFromDatasetVersionId": 123
}
}
],
"metricKeysByCategory": [
{
"category": "impulseMetrics",
"metricKeys": [
{
"name": "<string>",
"description": "<string>",
"type": "core",
"showInTable": true,
"filteringType": {
"type": "numeric",
"options": [
"<string>"
]
}
}
]
}
],
"extraTableColumns": [
"<string>"
],
"error": "<string>"
}Authorizations
ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2
Path Parameters
Project ID
Response
200 - application/json
OK
Whether the operation succeeded
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Which extra impulse information should be shown in the impulses table.
Optional error description (set if 'success' was false)
Was this page helpful?