POST
/
api
/
collections
/
data
/
increment
Authorization
Body
curl --request POST \
  --url https://api.worqhat.com/api/collections/data/increment \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collection": "Users",
  "docId": "1234567890",
  "field": "age",
  "increment": 1
}'
{
  "data": {
    "collection": "Users",
    "databaseId": "1234567890",
    "documentId": "1234567890",
    "elapsed_time": 800
  },
  "processing_count": 6554,
  "processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
  "processing_time": 888,
  "status": "success"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
collection
string

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

docId
string

The ID of the Document that you want to update.

field
string

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

increment
integer

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.

Response

200 - application/json
data
object
processing_count
integer

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.

processing_id
string

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

processing_time
integer

The time taken to process the request, in milliseconds.

status
string

Status indicating the success of the text moderation.