Record multiple interactions

Request

Path Params

database

string

required

The ID of the database to operate on

Body Params application/json

array of:

user_id

string

required

item_id

string

required

action

enum<string>

required

Allowed values:

detailviewspurchasesratingscartadditionsbookmarksviewportions

timestamp

integer

optional

Unix timestamp of the interaction

cascadeCreate

boolean

optional

If true, creates missing users or items

duration

number

optional

Duration of the interaction (for detailviews)

price

number

optional

Price of the item (for purchases and cartadditions)

amount

integer

optional

Amount of items (for purchases and cartadditions)

rating

number

optional

Rating value (for ratings)

>= -1<= 1

portion

number

optional

Portion of the item viewed (for viewportions)

>= 0<= 1

Example

[
    {
        "user_id": "string",
        "item_id": "string",
        "action": "detailviews",
        "timestamp": 0,
        "cascadeCreate": true,
        "duration": 0,
        "price": 0,
        "amount": 0,
        "rating": -1,
        "portion": 0
    }
]

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.recomms.ai//interactions/bulk' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "user_id": "string",
        "item_id": "string",
        "action": "detailviews",
        "timestamp": 0,
        "cascadeCreate": true,
        "duration": 0,
        "price": 0,
        "amount": 0,
        "rating": -1,
        "portion": 0
    }
]'

Responses

🟢200OK

application/json

Successful operation

Body

status

enum<string>

optional

Allowed value:

completed

total

integer

optional

successful

integer

optional

failed

integer

optional

results

object

optional

success

array[object (InteractionResponse) {2}]

optional

errors

array [object {2}]

optional

Example

{
    "status": "completed",
    "total": 0,
    "successful": 0,
    "failed": 0,
    "results": {
        "success": [
            {
                "status": "success",
                "timestamp": 0
            }
        ],
        "errors": [
            {
                "error": "string",
                "interaction": {
                    "user_id": "string",
                    "item_id": "string",
                    "action": "detailviews",
                    "timestamp": 0,
                    "cascadeCreate": true,
                    "duration": 0,
                    "price": 0,
                    "amount": 0,
                    "rating": -1,
                    "portion": 0
                }
            }
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized