Get project sample metadata filter options

Get project sample metadata filter options

get

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

projectIdintegerRequired

Project ID

Query parameters

categorystring · enumRequired

Which of the three acquisition categories to retrieve data from

Possible values:

limitintegerOptional

Maximum number of results

offsetintegerOptional

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

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/api/{projectId}/raw-data/metadata-filter-options HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "error": "text",
  "totalCount": 1,
  "count": 1,
  "optionsList": [
    {
      "key": "locationId",
      "options": [
        "buildingA",
        "buildingB"
      ]
    }
  ]
}