Get data summary

Get summary of all data present in the training set. This returns the number of data items, the total length of all data, and the labels. This is similar to dataSummary in ProjectInfoResponse but allows you to exclude disabled items or items that are still processing.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/data-summary

Path parameters

projectId*integer

Project ID

Query parameters

includeDisabledboolean

Whether to include disabled samples. Defaults to true

includeNotProcessedboolean

Whether to include non-processed samples. Defaults to true

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

dataSummary*object

labels*array of string

Labels in the training set

itemsstring

dataCount*integer

Example: "Number of files in the training set"

Request

Response

Get data summary

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/data-summary

Path parameters

projectId*integer

Project ID

Query parameters

includeDisabledboolean

Whether to include disabled samples. Defaults to true

includeNotProcessedboolean

Whether to include non-processed samples. Defaults to true

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

dataSummary*object

labels*array of string

Labels in the training set

itemsstring

dataCount*integer

Example: "Number of files in the training set"

Request

Response

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

{
  "success": false,
  "error": "text",
  "dataSummary": {
    "labels": [
      "text"
    ],
    "dataCount": "Number of files in the training set"
  }
}