EDedgeimpulse
Raw data

List samples

Retrieve all raw data by category.

get/api/{projectId}/raw-data

Request

Path parameters

projectIdinteger required

Project ID

Query parameters

category'training' | 'testing' | 'validation' | 'post-processing' | 'all' required

Which of the three acquisition categories to retrieve data from

limitinteger

Maximum number of results

offsetinteger

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

excludeSensorsboolean

Whether to exclude sensors in the response (as these can slow down requests when you have large pages).

labelsstring
Example:["idle", "snake"]

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

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

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

maxFrequencynumber

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

signatureValidity'both' | 'valid' | 'invalid'

Include samples with either valid or invalid signatures

includeDisabled'both' | 'enabled' | 'disabled'

Include only enabled or disabled samples (or both)

minLabelnumber

Only include samples with a label >= this value

maxLabelnumber

Only include samples with a label < this value

searchstring
Example:<id> <name>

Search query

proposedActionsJobIdinteger

Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.

truncateStructuredLabelsboolean

If true, only a slice of labels will be returned for samples with multiple labels.

sortBy'id-desc' | 'random'

If not specified, "id-desc" is used.

dataType'audio' | 'image'

Include only samples with a particular data type

minIdinteger

Include only samples with an ID >= this value

maxIdinteger

Include only samples with an ID < this value

metadatastring
Example:Example 1: returns samples where metadata key "foo" is 'bar' or 'baz' AND metadata key "k" is "v". [ { "no_metadata": true }, { "filters_combinator": "and" }, { "key": "foo", "op": "eq", "values": ["bar", "baz"] }, { "key": "k", "op": "eq", "values": ["v"] } ] Example 2: returns samples where metadata key "foo" is not 'bar'. Samples without any metadata are filtered out. [ { "no_metadata": false }, { "filters_combinator": "or" }, { "key": "foo", "op": "neq", "values": ["bar"] } ]

Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties: - "key": Metadata key to filter on. - "op": Operator ("eq" for positive match, "neq" for negative match). - "values": (optional) Array of values to match/exclude. If omitted or empty, matches/excludes all values for the key. In addition to filter objects, the following option objects can be specified: - { "no_metadata": boolean } - If true, include samples without any metadata - { "filters_combinator": ("and" | "or") } - Specifies the combinator and matching mode: - "and": All filter items must match (logical AND). - "or": Any filter item may match (logical OR); samples with metadata keys not present in the filters are included.

minDatestring date-time
Example:2023-01-01T00:00:00.000Z

Only include samples that where added after the date given

maxDatestring date-time
Example:2024-12-31T00:00:00.000Z

Only include samples that were added before the date given

datasetVersionIdinteger

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

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

totalCountinteger required

Example response

{
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "label": "healthy-machine",
      "intervalMs": 16,
      "frequency": 62.5,
      "originalIntervalMs": 16,
      "originalFrequency": 62.5,
      "sensors": [
        {
          "name": "accX"
        }
      ],
      "datastreams": [
        {
          "sensors": [
            {
              "name": "accX"
            }
          ]
        }
      ]
    }
  ]
}

Changes

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