Skip to main content
POST
/
api
/
v1
/
typesense
/
collections
/
{collection}
/
documents
/
search
Buscar documentos em uma coleção
curl --request POST \
  --url https://services.pref.rio/go/v1/api/v1/typesense/collections/{collection}/documents/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "exclude_fields": "<string>",
  "facet_by": "<string>",
  "facet_query": "<string>",
  "filter_by": "<string>",
  "highlight_fields": "<string>",
  "highlight_full_fields": "<string>",
  "include_fields": "<string>",
  "max_facet_values": 123,
  "num_typos": 123,
  "page": 123,
  "per_page": 123,
  "prefix": true,
  "q": "<string>",
  "query_by": "<string>",
  "sort_by": "<string>"
}'
{
  "found": 123,
  "hits": [
    {}
  ],
  "page": 123,
  "request_params": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
collection
string
required

Nome da coleção

Body

application/json

Parâmetros de busca

​
exclude_fields
string
​
facet_by
string
​
facet_query
string
​
filter_by
string
​
highlight_fields
string
​
highlight_full_fields
string
​
include_fields
string
​
max_facet_values
integer
​
num_typos
integer
​
page
integer
​
per_page
integer
​
prefix
boolean
​
q
string
​
query_by
string
​
sort_by
string

Response

OK

​
found
integer
​
hits
object[]
​
page
integer
​
request_params
object