Sign in

v47

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

Increment a Number/Numeric Field/Key in a Document

Increment a Number/Numeric Field/Key in a Document. You can pass in the Document ID and the Field/Key that you want to increment and we will increment or decrement the value for you.

post/api/collections/data/increment

Request body

collectionstring

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

docIdstring

The ID of the Document that you want to update.

fieldstring

The Field/Key that you want to increment or decrement.

incrementinteger

The value that you want to increment or decrement the Field/Key by. You can pass in a negative value to decrement the Field/Key and a positive value to increment the Field/Key.

Example request

{
  "collection": "Users",
  "docId": "1234567890",
  "field": "age",
  "increment": 1
}

Response

Output from the Database Collection Edits 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,
    "documentId": "1234567890"
  }
}