POST
/
api
/
{projectId}
/
raw-data
/
batch
/
clear-metadata-by-key
Clear metadata by key (multiple samples)
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/clear-metadata-by-key \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "metadataKey": "<string>"
}'
{
  "success": true,
  "error": "<string>"
}

Authorizations

​
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,
post-processing
​
labels
string

Only include samples with a label within the given list of labels, given as a JSON string

Example:

"[\"idle\", \"snake\"]"

​
filename
string

Only include samples whose filename includes the given filename

​
maxLength
integer

Only include samples shorter than the given length, in milliseconds

​
minLength
integer

Only include samples longer than the given length, in milliseconds

​
minFrequency
number

Only include samples with higher frequency than given frequency, in hertz

​
maxFrequency
number

Only include samples with lower frequency than given frequency, in hertz

​
signatureValidity
enum<string>

Include samples with either valid or invalid signatures

Available options:
both,
valid,
invalid
​
includeDisabled
enum<string>

Include only enabled or disabled samples (or both)

Available options:
both,
enabled,
disabled
​
ids
string

Only include samples with an ID within the given list of IDs, given as a JSON string

Example:

"[1, 2, 3]"

​
excludeIds
string

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example:

"[4, 5, 6]"

​
minLabel
number

Only include samples with a label >= this value

​
maxLabel
number

Only include samples with a label < this value

​
search
string

Search query

Example:

"<id> <name>"

​
dataType
enum<string>

Include only samples with a particular data type

Available options:
audio,
image
​
minId
number

Include only samples with an ID >= this value

​
maxId
number

Include only samples with an ID < this value

​
metadata
string

Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { "no_metadata": true }.

Example:
[
  "[{ \"key\": \"locationId\", \"op\": \"eq\", \"values\": [\"buildingA\"] }, { \"key\": \"deviceId\", \"op\": \"neq\", \"values\": [\"val1\", \"val2\"] }]",
  "[{ \"key\": \"distance\", \"op\": \"eq\", \"values\": [\"1.5\", \"2.9\"], \"key\": \"comments\", exclude: [\"faulty\"] }]",
  "[{ \"key\": \"nullKeyExample\", \"op\": \"eq\" }]",
  "[{ \"key\": \"presentKeyExample\", \"op\": \"neq\" }]",
  "[{ \"no_metadata\": true }]"
]
​
minDate
string<date-time>

Only include samples that where added after the date given

Example:

"2023-01-01T00:00:00.000Z"

​
maxDate
string<date-time>

Only include samples that were added before the date given

Example:

"2024-12-31T00:00:00.000Z"

Body

application/json

Response

200 - application/json

OK

The response is of type object.