Skip to main content
POST
/
api
/
data
/
upload
Upload Data
curl --request POST \
  --url https://ingest.ms.yarmill.com/api/data/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "originId": "<string>",
  "originType": "<string>",
  "operationType": "<string>",
  "metadata": {},
  "tags": [
    "<string>"
  ],
  "data": "<unknown>"
}
'

Authorizations

​
Authorization
string
header
required

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

Body

The data request model containing the data to be uploaded.

​
originId
string | null

Unique identifier. That is, an identifier that is unique within the source that triggered the operation. If not provided, the system will not be able to map changes to already uploaded identical objects. Example: 2be7d766-8848-46c9-ba31-22f5fab4641b

​
originType
string | null

The type of data being uploaded to Yarmill. The data type is usually the name of the entity on the source. It is mainly used for data categorization. The same type should have the same data structure. Example: user, result, full export, etc.

​
operationType
string | null

The type of operation performed. In combination with the originId, the system can detect whether it is a Create or Update. It can contain values: "C" (Create), "U" (Update), "D" (Delete).

​
metadata
object

Key-value object containing metadata that can be used to better understand the data. Metadata provides additional information, such as the source or version of the data. Example: { "source": "web", "version": "1" }

​
tags
string[] | null

Array of tags related to the data. Used for categorization or filtering of data. Example: ["new_user", "premium"]

​
data
any | null

Contains structured data in JSON format. This part can contain any JSON object or array of objects. Example: { "userId": "3422", "username": "johndoe", "email": "[email protected]", "age": 30 }

Response

200

OK