Skip to main content
GET
/
api
/
{projectId}
/
raw-data
/
project-metadata
Get project dataset metadata
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/project-metadata \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "metadata": {
    "ratio": {
      "hasValidationCategory": true,
      "count": {
        "training": 123,
        "testing": 123,
        "validation": 123
      }
    },
    "labelQueueCount": 123,
    "totalItemCount": 123,
    "training": {
      "totalLength": "<string>",
      "totalLengthNumber": 123,
      "maxLengthMs": 123,
      "minLengthMs": 123,
      "minFrequency": 123,
      "maxFrequency": 123,
      "itemCount": 123,
      "isTimeseries": true,
      "isFeatures": true,
      "metadataFilterOptions": {
        "totalCount": 123,
        "count": 123,
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "fullLabelCount": 123,
      "labels": [
        {
          "label": "<string>",
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    },
    "testing": {
      "totalLength": "<string>",
      "totalLengthNumber": 123,
      "maxLengthMs": 123,
      "minLengthMs": 123,
      "minFrequency": 123,
      "maxFrequency": 123,
      "itemCount": 123,
      "isTimeseries": true,
      "isFeatures": true,
      "metadataFilterOptions": {
        "totalCount": 123,
        "count": 123,
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "fullLabelCount": 123,
      "labels": [
        {
          "label": "<string>",
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    },
    "validation": {
      "totalLength": "<string>",
      "totalLengthNumber": 123,
      "maxLengthMs": 123,
      "minLengthMs": 123,
      "minFrequency": 123,
      "maxFrequency": 123,
      "itemCount": 123,
      "isTimeseries": true,
      "isFeatures": true,
      "metadataFilterOptions": {
        "totalCount": 123,
        "count": 123,
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "fullLabelCount": 123,
      "labels": [
        {
          "label": "<string>",
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    },
    "postProcessing": {
      "totalLength": "<string>",
      "totalLengthNumber": 123,
      "maxLengthMs": 123,
      "minLengthMs": 123,
      "minFrequency": 123,
      "maxFrequency": 123,
      "itemCount": 123,
      "isTimeseries": true,
      "isFeatures": true,
      "metadataFilterOptions": {
        "totalCount": 123,
        "count": 123,
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "fullLabelCount": 123,
      "labels": [
        {
          "label": "<string>",
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    },
    "all": {
      "totalLength": "<string>",
      "totalLengthNumber": 123,
      "maxLengthMs": 123,
      "minLengthMs": 123,
      "minFrequency": 123,
      "maxFrequency": 123,
      "itemCount": 123,
      "isTimeseries": true,
      "isFeatures": true,
      "metadataFilterOptions": {
        "totalCount": 123,
        "count": 123,
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "fullLabelCount": 123,
      "labels": [
        {
          "label": "<string>",
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    }
  },
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
integer
required

Project ID

Query Parameters

includeDisabled
enum<string>

Whether to include enabled-only samples, or both enabled and disabled samples (defaults to both).

Available options:
both,
enabled

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

metadata
object
required

Overall dataset metadata info

error
string

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