Get data summary

PreviousGet data axes summary NextGet the interval (in ms) of the training data

Last updated 10 months ago

Was this helpful?

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.

get

/api/{projectId}/data-summary

Authorizations

Path parameters

projectIdintegerrequired

Project ID

Query parameters

includeDisabledboolean

Whether to include disabled samples. Defaults to true

includeNotProcessedboolean

Whether to include non-processed samples. Defaults to true

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/data-summary' \
  --header 'x-api-key: YOUR_API_KEY'

200

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