Perform Simple and Compound queries
curl --request POST \
--url https://api.worqhat.com/api/collections/data/fetch/query \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"collection": "Users",
"compounding": "and",
"limit": 10,
"orderBy": "age",
"orderType": "desc",
"queries": [
{
"field": "name",
"operator": "equal to",
"value": "Alex"
},
{
"field": "age",
"operator": "greater than",
"value": 18
}
],
"startAfter": 5
}'
{
"data": {
"collection": "Users",
"data": [
{
"sampleDbContent": "This is a sample content",
"sampleDbContent2": "This is a sample content 2"
},
{
"sampleDbContent": "This is a sample content",
"sampleDbContent2": "This is a sample content 2"
}
],
"databaseId": "1234567890",
"elapsed_time": 800
},
"processing_count": 6554,
"processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
"processing_time": 888,
"status": "success"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The Name of the Collection or the Group where you want to store all your data.
The Compounding Operator that you want to run the query with. This is optional. By default we will run the query with the and
operator if you pass multiple queries. If you add a compounding
parameter, we will run the query with that Compounding Operator.
and
, or
The Limit of the number of Documents that you want to fetch. This is optional. By default we will fetch all the Documents that match the query. If you add a limit
Field/Key, we will limit the response by that number.
The Field/Key that you want to sort the response by. This is optional. By default we will sort it by the Field/Key that you pass in as default orderBy value when collection was created. If you add a orderBy
Field/Key, we will sort the response by that Field/Key.
The Order Type that you want to sort the response by. This is optional. By default we will sort it in asc
order. If you add a orderType
Field/Key, we will sort the response by that Order Type on the orderBy
Field/Key.
asc
, desc
The Queries that you want to run on the Collection. You can run a simple WHERE
query or a compound AND
or OR
using the join
query parameter on a Collection.
The number of documents to skip. This is optional. By default we will not skip any documents. If you add a startAfter
value, we will skip the number of documents that you pass in.
Response
The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.
A universally unique identifier for the request. This can be used to track the request in the logs.
The time taken to process the request, in milliseconds.
Status indicating the success of the text moderation.
Was this page helpful?
curl --request POST \
--url https://api.worqhat.com/api/collections/data/fetch/query \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"collection": "Users",
"compounding": "and",
"limit": 10,
"orderBy": "age",
"orderType": "desc",
"queries": [
{
"field": "name",
"operator": "equal to",
"value": "Alex"
},
{
"field": "age",
"operator": "greater than",
"value": 18
}
],
"startAfter": 5
}'
{
"data": {
"collection": "Users",
"data": [
{
"sampleDbContent": "This is a sample content",
"sampleDbContent2": "This is a sample content 2"
},
{
"sampleDbContent": "This is a sample content",
"sampleDbContent2": "This is a sample content 2"
}
],
"databaseId": "1234567890",
"elapsed_time": 800
},
"processing_count": 6554,
"processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
"processing_time": 888,
"status": "success"
}