Find segments

Find start and end times for all non-noise events in a sample. If you have multiple datastreams and OptionalDatastreamIndexParameter is not passed in, the first datastream is used.

POST /api/{projectId}/raw-data/{sampleId}/find-segments

Find segments

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/find-segments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "shiftSegments": true,
  "segmentLengthMs": 123
}
'

200

{
  "success": true,
  "segments": [
    {
      "startMs": 123,
      "endMs": 123
    }
  ],
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

sampleId · integer · required

Sample ID

Query Parameters

datastreamIndex · integer

Datastream index (defaults to 0)

Body

application/json

shiftSegments · boolean · required

If set, the segments are automatically shifted randomly, to make the dataset distribution more uniform.

segmentLengthMs · integer · required

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

segments · object[] · required

Show child attributes

error · string

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