DB.SEARCH

POST 

To search of one or multiple documents in a collection using keywords

Request

application/json

Body

action stringrequired

Default value: db.search

The action name

collection stringrequired

The collection name

matches objectrequired

The matches criteria

query stringrequired

The query search for

Responses

200

Query response

application/json

Schema

Schema

data object[]
meta object
pagination object
page integer
per_page integer
total_pages integer
size integer
count integer
has_next boolean
next_page integer
has_prev boolean
prev_page integer
page_showing_start integer
page_showing_end integer

Example (from schema)

{
  "data": [
    {}
  ],
  "meta": {
    "pagination": {
      "page": 0,
      "per_page": 0,
      "total_pages": 0,
      "size": 0,
      "count": 0,
      "has_next": true,
      "next_page": 0,
      "has_prev": true,
      "prev_page": 0,
      "page_showing_start": 0,
      "page_showing_end": 0
    }
  }
}

Loading...