Query Dataset

Detailed information about DQL can be found at https://docs.dataloop.ai/docs/dql

Request
path Parameters
id
required
string

Dataset to be queried

Request Body schema: application/json

Query JSON

filter
required
object (Dictionary)
limit
number <double>
object (JoinQuery)
object (ReferenceQuery)
sort
object (SortQuery)
select
object (SelectQuery)
update
object (Dictionary)
delete
boolean
user
string
systemSpace
boolean
queryEngine
string
Enum: "mongo" "elasticsearch" "sql" "json"
resource
string (QueryResource)
Enum: "items" "annotations" "datasets" "tasks" "assignments" "feature_sets" "feature_vectors" "items" "annotations" "datasets" "tasks" "assignments" "feature_sets" "feature_vectors" "models" "metrics" "executions" "services" "settings" "setting"
skip
number <double>
datasets
Array of strings
projects
Array of strings
page
number <double>
pageSize
number <double>
collectMetrics
boolean
countTotal
boolean
object
property name*
additional property
any
Responses
200

Ok

post/datasets/{id}/query
Request samples
application/json
{
  • "filter": {
    },
  • "limit": 0,
  • "join": {
    },
  • "references": {
    },
  • "sort": {
    },
  • "select": {
    },
  • "update": {
    },
  • "delete": true,
  • "user": "string",
  • "systemSpace": true,
  • "queryEngine": "mongo",
  • "resource": "items",
  • "skip": 0,
  • "datasets": [
    ],
  • "projects": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "collectMetrics": true,
  • "countTotal": true,
  • "sign": {
    }
}
Response samples
application/json
{
  • "totalItemsCount": 0,
  • "items": [
    ],
  • "totalPagesCount": 0,
  • "hasNextPage": true
}