v47

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-06-17465244.2 KB

Database Management

Fetch the Unique Values of a Field/Key in a Collection (Sortable)

Fetch the Unique Values of a Field/Key in a Collection. You can also sort the response in a specific order of asc or desc on the basis of the Field/Key that you pass in.

post/api/collections/data/fetch/unique

Request body

collectionstring

The Name of the Collection or the Group where you want to store all your data.

keystring

The Field/Key that you want to check unique values for.

orderBystring

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 key. If you add a orderBy Field/Key, we will sort the response by that Field/Key.

orderType'asc' | 'desc'

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.

Example request

{
  "collection": "Users",
  "key": "name",
  "orderBy": "age",
  "orderType": "desc"
}

Response

Output from the Database Collection Fetch Process

statusstring

Status indicating the success of the text moderation.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_countinteger

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.

Example response

{
  "status": "success",
  "processing_time": 888,
  "processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
  "processing_count": 6554,
  "data": {
    "databaseId": "1234567890",
    "collection": "Users",
    "elapsed_time": 800,
    "data": [
      {
        "sampleDbContent": "This is a sample content",
        "sampleDbContent2": "This is a sample content 2"
      }
    ]
  }
}