Raw data

Get project dataset metadata

Get the raw data metadata for this project

get/api/{projectId}/raw-data/project-metadata

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/raw-data/project-metadata/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Query parameters

datasetVersionIdinteger

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

truncateLabelsboolean

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

includeDisabled'both' | 'enabled'

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

Response

successboolean required

Whether the operation succeeded

errorstring

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

Example response

{
  "metadata": {
    "training": {
      "metadataFilterOptions": {
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "labels": [
        {
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    },
    "testing": {
      "metadataFilterOptions": {
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "labels": [
        {
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    },
    "validation": {
      "metadataFilterOptions": {
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "labels": [
        {
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    },
    "postProcessing": {
      "metadataFilterOptions": {
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "labels": [
        {
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    },
    "all": {
      "metadataFilterOptions": {
        "optionsList": [
          {
            "key": "locationId",
            "options": [
              "buildingA",
              "buildingB"
            ]
          }
        ]
      },
      "labels": [
        {
          "totalLength": 189152,
          "totalLengthStr": "3m 9s",
          "dataCount": 19
        }
      ]
    }
  }
}

Changes

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