Projects

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

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/data-summary/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Query parameters

includeDisabledboolean

Whether to include disabled samples. Defaults to true

includeNotProcessedboolean

Whether to include non-processed samples. Defaults to true

datasetVersionIdinteger

Dataset version ID. If not set, the current mutable dataset is used

truncateLabelsboolean

If true, only a slice of labels will be returned.

Response

successboolean required

Whether the operation succeeded

errorstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.