---
title: "Get data summary"
method: GET
path: "/api/{projectId}/data-summary"
tags: ["Projects"]
---

# Get data summary

`GET /api/{projectId}/data-summary`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/data-summary`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - 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)

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.

## Path parameters

- `projectId` integer, required

## Query parameters

- `includeDisabled` boolean
- `includeNotProcessed` boolean
- `datasetVersionId` integer
- `truncateLabels` boolean

## Response `200`

OK

- ProjectTrainingDataSummaryResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `dataSummary` object, required
    - `labels` string[], required: Labels in the training set
    - `totalLabels` integer, required: Total number of distinct labels in the training set.
    - `min` integer: Minimum regression value. Only set for regression datasets.
    - `max` integer: Maximum regression value. Only set for regression datasets.
    - `mean` number: Mean regression value. Only set for regression datasets.
    - `dataCount` integer, required
    - `hasTimeseriesDataWithMultipleLabels` boolean, required: Whether there are samples in the training dataset that are both time-series data and have multiple labels
    - `labelsPerKey` object: For labelmap datasets, this property provides a breakdown of labels per attribute or key.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)