REST API examples and queries

Querying your database is an essential part of any application. uses plain URLs with simple parameters and JSON documents to query your database. In this section we will give you plenty of REST API examples using MongoDB like query syntax.

Query language

Database queries are created as valid JSON documents. A query object consists of fields and operators that make up a complete query. Please note that query fields are case sensitive.

A simple query example:{"status": "GOLD"}

Which is the same as asking the database: fetch all records with status GOLD

Simple queries

Match a single field (find Joe):{"name": "Joe"}

Match multiple fields (find Joe who's 17):{"name": "Joe", "age": 17}

In addition to query simple fields, you can use special operators to perform more advanced queries.

Logic operators

$not operator

Return documents not matching the query.{"name" : {"$not" : "Joe"}}

$in operator

Return documents matching any values.{"name" : {"$in" : ["Joe", "Jane", "Donald"]}}

$nin operator

Return documents not matching any of the values.{"name" : {"$nin" : ["Joe", "Jane", "Donald"]}}

$regex operator

Match a regular expression against field.{"name" : {"$regex" : ".Joe*"}}

$or operator

Return documents that matches one or the other field.{{"$or": [{"name": "Jane"}, {"name": "Donald"}]}}

$and operator

Return documents both fields.{{"$and": [{"name": "Jane"}, {"last-name": "Cassidy"}]}}

Logical operators overview

$notNegation logical operator{"field" : {"$not" : val}}
$inMatch any value in array{"field" : {"$in" : [value1, value2, ...]}}
$ninNot match any value in array{"field" : {"$nin" : [value1, value2, ...]}}
$regexMatch field{"field" : {"$regex" : ".*"}}
$orLogical operator{"$or": [{"status": "GOLD"}, {"status": "SILVER"}]}
$andLogical operator{"$and": [{"status": "GOLD"}, {"sales": 1000}]}

Conditional operators

$gt>{"salary": {"$gt": 10000}}
$gte>={"salary": {"$gte": 10000}}
$lt<{"salary": {"$lt": 10000}}
$lte<={"salary": {"$lte": 10000}}
$bt>= value <={"salary": {"$bt": [5000, 7500]}}
$existsCheck if field exists{"field": {"$exists": true|false}}
$exists (array)Check if array field exists or is empty{"field.0": {"$exists": true|false}}
$elemMatchArray element matching{"contact":{"$elemMatch":{"name":"Anderson", age:35}}}
$distinctArray with unique element values{"$distinct": "name"}

Date operator

Querying based on dates are done using the $date operator combined with ISO date strings. For example:

// between two dates

Dynamic date variables

To enable more dynamic queries using the $date operator, like "get all records this month", we have added a number of predefined date variables.

// older than the time just now
$nowjust now
$currentMinutestart of last minute
$currentHourstart of last hour
$currentDatestart of current day
$todaystart of current day
$tomorrowstart of next day
$yesterdaystart of day before
$currentWeekstart of this week (sunday)
$currentMonthstart of this month
$currentYearstart of this year
$nextWeekstart of next week (sunday)
$nextMonthstart of next month
$nextYearstart of next year

We also support MomentJS. Check out their docs and compose the date variable like this:


Sort operator

The $orderbyoperator lets you sort the result from a query. You can sort on single or multiple fields within the same query. We use the URL parameter hint h={..} to specify sorting.

E.g. query all records from peopleand sort the result set by name in ascending order, and then by age in descending order.{}&h={"$orderby": {"name": 1, "age": -1}}

URL Parameters overview

As part of the REST API, has a number of parameters that we can use. They are added to the REST URLs as query parameters shown below:


The following table shows all valid URL parameters to a database REST endpoint:

qDatabase query
Example: GET "Karen Johnston, age 39":{"firstname":"Karen", "lastname":"Johnson", age: 39}
hQuery hints to specify: fields, max, skip and orderby. Aggregation parameters can also be specified as hints, read more here
Example: Return title, only 10 records, forward to the item and sort result set by the body field:{}&h={"$fields":{"title":1},"$max":10,"$skip":5,"$orderby":{"body":1}}
filterPerforms a text search and retrieves all matching documents
sortSpecifies which field(s) should be used to sort the result. You can add multiple fields by simply adding another sort parameter. Default sort=_id
dirSort direction. Allowed values are 1 (ascending) and -1 (descending). Used together with sort. Multiple dir parameters can be used in conjunction with sort.
skipWhere to start in the result set. Used for paging.
maxMaximum number of records retrieved.
totals&totals=true returns an object with both data and total count. Totals equals to max parameter or default 1000
Example: output from query ->{data: [ … ], totals: { total: 100, count: 40, skip: 0, max: 1000}}
totals and count&totals=true&count=true returns an object with no data and just the total count
Example: output from query -> {data: [], totals: { count: 42}}
metafieldsDisplays internal fields (_keywords, _tags, _version, _created, _createdby, _mock)
groupbyGroup output from query by a field
aggregatePerform aggregation function on data groups. Useful together with groupby parameter. Avaliable functions; SUM, AVG, MIN, MAX and COUNT Docs
formatOutput format from request. .html returns a standard markup for all fields. .js (Javascript) returns a script that can be included in a web page for search engine indexing. .json standard JSON format
apikeyA valid apikey, full access key or a CORS enabled key
Not recommended for production. Use header field x-apikey instead
idtolinkInserts canonical URLs for image references and object references
flattenUsed together with idtolink. Extract links as properties on root object
referencedbyReturn all items that refers to a record. Requires a record _id in the query or path
fetchmediadataReplace media ID's with a full record from the media archive
fetchchildrenInsert records from parent-child relation on parent record

Query examples

The following table shows some examples on how to query

Get items that have status = "pro" and title="yay"q={"status”:"pro","title”:”yay"}
Get items that have status = "pro" or "basic"q={"$or":[{"status”:"pro"},{“status”:”basic"}]}
Get items that have status like "basic" (regular expression)q={"status":{"$regex”: ”basic"}}
Get all items updated within date interval (use ISOString or dates that can be converted to ISOString)q={"_changed":{"$gt":{"$date":"2016-08-01"},"$lt":{"$date":"2016-08-05"}}}
Get items created this month, i.e. newer than 00:00 AM this monthq={"_created":{"$gt":{"$date":"$currentMonth"}}}
Get all items with a score > 900, and group them by categoryh={"$groupby":["category"]}&q={"score":{"$gt": 900}}
Get all metadata for a database
Get an image thumbnail from the media archive<img src="">

Comprehensive code examples for various languages

SQL to NoSQL mapping

The following table shows how traditional SQL statements are expressed as RestDB Queries.

SELECT * FROM usershttps://<db-name>{}
SELECT id, user_id, status FROM users/rest/users?q={}&h={"$fields": {"user_id": 1, "status": 1} }
SELECT * FROM users WHERE status = "A"/rest/users?q={ "status": "A" }
SELECT * FROM users WHERE status != "A"/rest/users?q={"status":{"$not":"A"}}
SELECT * FROM users WHERE status = "A" AND age = 50/rest/users?q={ "status": "A", "age": 50 }
SELECT * FROM users WHERE status = "A" OR age = 50/rest/users?q={ "$or": [ { "status": "A" } ,{ "age": 50 } ] }
SELECT * FROM users WHERE age > 25/rest/users?q={ "age": { "$gt": 25 } }
SELECT * FROM users WHERE age < 25/rest/users?q={ "age": { "$lt": 25 } }
SELECT * FROM users WHERE age > 25 AND age <= 50/rest/users?q={ "age": { "$gt": 25, "$lte": 50 } }
SELECT * FROM users WHERE user_id like "%bc%"/rest/users?q={ "user_id": {"$regex" :"bc"}}
SELECT * FROM users WHERE user_id like "bc%"/rest/users?q={ "user_id": {"$regex" :"^bc"}}
SELECT * FROM users WHERE status = "A" ORDER BY user_id ASC/rest/users?q={ "status": "A" }&sort=user_id&dir=1
SELECT * FROM users WHERE status = "A" ORDER BY user_id DESC/rest/users?q={ "status": "A" }&sort=user_id&dir=-1
SELECT COUNT(*) FROM users/rest/users?q={}&h={"$aggregate":["COUNT:"]}
SELECT COUNT(*) FROM users WHERE age > 30/rest/users?q={"age":{"$gt": 30}}&h={"$aggregate":["COUNT:"]}
SELECT * FROM users LIMIT 1/rest/users?q={}&max=1
SELECT * FROM users LIMIT 5 SKIP 10/rest/users?q={}&max=5&skip=10