Recomms AI

Record an interaction

POST

https://api.recomms.ai/{database}/interactions

Interactions

Record a new interaction between a user and an item. Supported interaction types:

detailviews: Record time spent viewing an item

purchases: Record a purchase of an item

ratings: Record a user's rating of an item

cartadditions: Record adding an item to the cart

bookmarks: Record bookmarking an item

viewportions: Record the portion of an item viewed

Request

Path Params

database

string

required

The ID of the database to operate on

Body Params application/json

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.recomms.ai//interactions' \
--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:

success

timestamp

integer

optional

Example

{
    "status": "success",
    "timestamp": 0
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-03-13 16:59:32

Reset users

Get interactions