Query Fields
Datasets
Basic Fields
| Name | Aliases | Description | Comparators | Sortable |
|---|---|---|---|---|
created |
N/A | ISO8601 timestamp when the dataset was created. | =, !=, <, <=, >, >= |
True |
created_by |
N/A | User who created the dataset. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
dataset_id |
id |
A ds_ prefixed unique ID for the dataset. |
=, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
description |
N/A | Human-readable description of the dataset. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
device_id |
N/A | The unique ID of the device which created the dataset, or null if created by a human user. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
metadata |
N/A | Custom key-value pairs added by users to categorize the dataset. Filter on a key with a dotted path — metadata.<key> = "value". |
Other - See (1) | False |
modified |
N/A | ISO8601 timestamp when the dataset was last modified. | =, !=, <, <=, >, >= |
True |
modified_by |
N/A | User who last modified the dataset. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
name |
N/A | A short name for this dataset. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
org_id |
N/A | Org which owns the dataset. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
tags |
N/A | Custom string tags added by users to categorize the dataset. | CONTAINS, NOT_CONTAINS |
False |
- Metadata queries require you to continue the field with
.keyname, and the supported comparators depend on the type of the metadata value.
Entity References
files[0] - A file belonging to the dataset
topics[0] - A topic belonging to any file in the dataset
Files
Basic Fields
| Name | Aliases | Description | Comparators | Sortable |
|---|---|---|---|---|
association_id |
dataset_id, collection_id |
Unique ID of the resource which the file belongs to. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
created |
N/A | ISO8601 timestamp when the file was uploaded. | =, !=, <, <=, >, >= |
True |
created_by |
N/A | User who uploaded the file. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
description |
N/A | Human-readable description of the file and its contents. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
device_id |
N/A | The unique ID of the device which uploaded the file, or null if uploaded by a human user. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
file_id |
id |
Unique ID for the file. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
ingestion_status |
N/A | Ingestion state of the file. | =, !=, IS_NULL, IS_NOT_NULL |
False |
metadata |
N/A | Custom key-value pairs added by users to categorize the file. Filter on a key with a dotted path — metadata.<key> = "value". |
Other - See (1) | False |
modified |
N/A | ISO8601 timestamp when the file was last modified. | =, !=, <, <=, >, >= |
True |
modified_by |
N/A | User who last modified the file. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
name |
N/A | The name of the file. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
org_id |
N/A | Org which owns the file. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
origination |
N/A | Identifies the client and user that uploaded the file. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
relative_path |
path |
Full path to the file in the context of its associated resource. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
size |
N/A | File size in bytes | =, !=, <, <=, >, >= |
True |
status |
N/A | Lifecycle status of the file. | =, != |
False |
tags |
N/A | Custom string tags added by users to categorize the file. | CONTAINS, NOT_CONTAINS |
False |
upload_id |
N/A | Unique ID of the upload transaction responsible for this file. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
uri |
N/A | The URI of the file. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
- Metadata queries require you to continue the field with
.keyname, and the supported comparators depend on the type of the metadata value.
Entity References
dataset - The dataset the file belongs to
topics[0] - A topic belonging to the file
Topics
Basic Fields
| Name | Aliases | Description | Comparators | Sortable |
|---|---|---|---|---|
association_id |
file_id |
Unique ID of the resource which the topic belongs to. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
association_type |
N/A | Type of the resource which the topic belongs to. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
created |
N/A | ISO8601 timestamp when the topic was created. | =, !=, <, <=, >, >= |
True |
created_by |
N/A | User who created the topic. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
end_time |
N/A | Epoch nanosecond timestamp of the last message in the topic. | =, !=, <, <=, >, >= |
True |
message_count |
N/A | The number of messages in the topic. | =, !=, <, <=, >, >= |
True |
metadata |
N/A | Custom key-value pairs added by users to categorize the topic. Filter on a key with a dotted path — metadata.<key> = "value". |
Other - See (1) | False |
modified |
N/A | ISO8601 timestamp when the topic was last modified. | =, !=, <, <=, >, >= |
True |
modified_by |
N/A | User who last modified the topic. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
msgpaths |
fields |
Reference a single property within a topic, e.g. sensor.imu.x. |
Other - See (2) | True |
org_id |
N/A | Org which owns the topic. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
schema_checksum |
N/A | Checksum that uniquely identifies a schema version. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
schema_name |
N/A | Name of the schema used to serialize messages in the topic. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
schema_version |
N/A | Monotonically increasing version of a schema. | =, !=, <, <=, >, >= |
False |
start_time |
N/A | Epoch nanosecond timestamp of the first message in the topic. | =, !=, <, <=, >, >= |
True |
topic_id |
id |
Unique numeric ID for the topic. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
topic_name |
name |
Name for the topic. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
- Metadata queries require you to continue the field with
.keyname, and the supported comparators depend on the type of the metadata value. - Message paths follow entity reference syntax
Entity References
dataset - The dataset the topic belongs to
file - The file the topic belongs to
msgpaths[topic_name.full.message.path] - An individual field within a topic. A property must be specified at the end, such as min, mean, or max: msgpaths[cpuload.load].mean > 0
Message Paths
Basic Fields
| Name | Aliases | Description | Comparators | Sortable |
|---|---|---|---|---|
canonical_data_type |
N/A | Data type normalized to a common representation across frameworks and serialization formats. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
created |
N/A | ISO8601 timestamp when the message path was created. | =, !=, <, <=, >, >= |
True |
created_by |
N/A | User who created the message path. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
data_type |
N/A | Framework-specific data type of the attribute at this path, e.g. float32, uint8[], geometry_msgs/Pose, string. |
=, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
message_path |
name, path, field |
Dot-delimited path to an attribute within a topic datum record. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
message_path_id |
id |
Unique numeric ID for the message path. | =, !=, <, <=, >, >= |
True |
metadata |
N/A | Custom key-value pairs added by users to categorize the message path. Filter on a key with a dotted path — metadata.<key> = "value". |
Other - See (1) | False |
modified |
N/A | ISO8601 timestamp when the message path was last modified. | =, !=, <, <=, >, >= |
True |
modified_by |
N/A | User who last modified the message path. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
topic_id |
N/A | Unique numeric ID for the topic to which this message path is associated. | =, !=, <, <=, >, >= |
True |
- Metadata queries require you to continue the field with
.keyname, and the supported comparators depend on the type of the metadata value.
Pre-computed statistics for message paths can also be accessed via the metadata field, for example metadata.max and metadata.mean.
Entity References
dataset - The dataset the message path belongs to
file - The file the message path belongs to
topic - The topic the message path belongs to
Events
Basic Fields
| Name | Aliases | Description | Comparators | Sortable |
|---|---|---|---|---|
created |
created_at |
ISO8601 timestamp when the event was created. | =, !=, <, <=, >, >= |
True |
created_by |
N/A | User who created the event. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
description |
N/A | Free-text description of the event. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
False |
end_time |
N/A | UTC timestamp of the end of the event. Supply as Unix epoch nanoseconds or an ISO8601 string. | =, !=, <, <=, >, >= |
True |
event_id |
id |
Unique ID for the event. | =, != |
False |
metadata |
N/A | Custom key-value pairs added by users to categorize the event. Filter on a key with a dotted path — metadata.<key> = "value". |
Other - See (1) | False |
modified |
modified_at, updated_at |
ISO8601 timestamp when the event was last modified. | =, !=, <, <=, >, >= |
True |
modified_by |
N/A | User who last modified the event. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
name |
event_name |
Display name for the event. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE |
True |
org_id |
N/A | Org which owns the event. | =, != |
False |
start_time |
N/A | UTC timestamp of the start of the event. Supply as Unix epoch nanoseconds or an ISO8601 string. | =, !=, <, <=, >, >= |
True |
tags |
N/A | Custom string tags added by users to categorize the event. | CONTAINS, NOT_CONTAINS |
False |
- Metadata queries require you to continue the field with
.keyname, and the supported comparators depend on the type of the metadata value.
Entity References
collection.collection_id / collection.id - Filter to events belonging to a specific collection
Collections
Basic Fields
| Name | Aliases | Description | Comparators | Sortable |
|---|---|---|---|---|
collection_id |
id |
Unique cl_ prefixed identifier for the collection. |
=, != |
True |
created |
N/A | ISO8601 timestamp when the collection was created. | =, !=, <, <=, >, >=, IS_NULL, IS_NOT_NULL |
True |
created_by |
N/A | User who created the collection. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE, IS_NULL, IS_NOT_NULL |
True |
description |
N/A | Freetext human-readable description of the collection. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE, IS_NULL, IS_NOT_NULL |
False |
name |
N/A | Short display name for the collection. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE, IS_NULL, IS_NOT_NULL |
True |
resource_count |
N/A | Number of resources the collection holds. | =, !=, <, <=, >, >=, IS_NULL, IS_NOT_NULL |
True |
resource_type |
N/A | Primary resource type stored in this collection (File, Dataset, Event, or Session). | =, !=, IS_NULL, IS_NOT_NULL |
True |
tags |
N/A | Custom string tags added by users to categorize the collection. | CONTAINS, NOT_CONTAINS |
False |
updated |
N/A | ISO8601 timestamp when the collection was last modified. | =, !=, <, <=, >, >=, IS_NULL, IS_NOT_NULL |
True |
updated_by |
N/A | User who last modified the collection. | =, !=, CONTAINS, NOT_CONTAINS, LIKE, NOT_LIKE, IS_NULL, IS_NOT_NULL |
True |
Entity References
No entity references are defined for Collections.