Get diversity metrics data

Get diversity metrics data

Obtain metrics that describe the similarity and diversity of a dataset. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/diversity

Path parameters

projectId*integer

Project ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

dataarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "error": "text",
  "data": [
    {
      "labelId": 0,
      "maxDistance": 0,
      "clusterInfos": [
        {
          "idx": 0,
          "indexes": [
            0
          ],
          "windows": [
            [
              0
            ]
          ],
          "samples": [
            {
              "id": 2,
              "filename": "idle01.d8Ae",
              "signatureValidate": true,
              "signatureMethod": "HS256",
              "signatureKey": "text",
              "created": "2024-12-21T11:38:15.040Z",
              "lastModified": "2024-12-21T11:38:15.040Z",
              "category": "training",
              "coldstorageFilename": "text",
              "label": "healthy-machine",
              "intervalMs": 16,
              "frequency": 62.5,
              "originalIntervalMs": 16,
              "originalFrequency": 62.5,
              "deviceName": "text",
              "deviceType": "text",
              "sensors": [
                {
                  "name": "accX",
                  "units": "text"
                }
              ],
              "valuesCount": 0,
              "totalLengthMs": 0,
              "added": "2024-12-21T11:38:15.040Z",
              "boundingBoxes": [
                {
                  "label": "text",
                  "x": 0,
                  "y": 0,
                  "width": 0,
                  "height": 0
                }
              ],
              "boundingBoxesType": "object_detection",
              "chartType": "chart",
              "thumbnailVideo": "text",
              "thumbnailVideoFull": "text",
              "isDisabled": false,
              "isProcessing": false,
              "processingJobId": 0,
              "processingError": false,
              "processingErrorString": "text",
              "isCropped": false,
              "projectId": 0,
              "projectOwnerName": "text",
              "projectName": "text",
              "projectLabelingMethod": "single_label",
              "sha256Hash": "text",
              "structuredLabels": [
                {
                  "startIndex": 0,
                  "endIndex": 0,
                  "label": "text"
                }
              ],
              "structuredLabelsList": [
                "text"
              ],
              "createdBySyntheticDataJobId": 0,
              "imageDimensions": {
                "width": 0,
                "height": 0
              }
            }
          ],
          "vendiScore": 0,
          "vendiRatio": 0,
          "count": 0,
          "distance": 0,
          "leftIdx": 0,
          "rightIdx": 0
        }
      ]
    }
  ]
}