Get project sample metadata filter options

Get a list of unique key value pairs across all samples in a project that can be applied as filters to the /api//raw-data endpoint

GET /api/{projectId}/raw-data/metadata-filter-options

Get project sample metadata filter options

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/metadata-filter-options \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "totalCount": 123,
  "count": 123,
  "optionsList": [
    {
      "key": "locationId",
      "options": [
        "buildingA",
        "buildingB"
      ]
    }
  ],
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Query Parameters

category · enum<string> · required

Which of the three acquisition categories to retrieve data from

Available options: training, testing, validation, post-processing, all

limit · integer

Maximum number of results

offset · integer

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

totalCount · integer · required

count · integer · required

optionsList · object[] · required

Available metadata filter options that can be supplied to the /raw-data/ endpoint to filter samples

Show child attributes

error · string

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