Recomms AI
  1. Interactions
Recomms AI
  • Documentation
  • Recomms AI SDK
  • Items
    • Create an item
      POST
    • Update an item
      PATCH
    • Get items
      GET
    • Get item by ID
      GET
    • Delete item
      DELETE
    • Get item side info
      GET
    • Create item side info
      POST
    • Delete item side info
      DELETE
    • Reset items
      POST
  • Users
    • Create a user
      POST
    • Update a user
      PATCH
    • Get users
      GET
    • Get user by ID
      GET
    • Delete user
      DELETE
    • Get user side info
      GET
    • Create user side info
      POST
    • Delete user side info
      DELETE
    • Reset users
      POST
  • Interactions
    • Record an interaction
      POST
    • Get interactions
      GET
    • Delete an interaction
      DELETE
    • Record multiple interactions
      POST
    • Reset interactions
      POST
  • Business Rules
    • Create a new business rule
      POST
    • List business rules
      GET
    • Get business rule by ID
      GET
    • Update business rule
      PATCH
    • Delete business rule
      DELETE
  • Recommendations
    • Get item recommendations for a user
    • Get user recommendations for an item
    • Get similar users
    • Predict scores for user-item pairs
    • Predict scores for a batch of user-item combinations
    • Search for items
    • Search for users
    • Get top items
  1. Interactions

Get interactions

GET
https://api.recomms.ai/{database}/interactions
Interactions
Retrieve a list of interactions from the specified database with pagination and filtering options.

Request

Path Params
database
string 
required
The ID of the database to operate on
Query Params
page
integer 
optional
Page number for pagination
>= 1
Default:
1
page_size
integer 
optional
Number of items per page
>= 1<= 100
Default:
20
order
enum<string> 
optional
Order of results
Allowed values:
ASCDESC
Default:
DESC
action
string 
optional
Filter interactions by action type

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.recomms.ai//interactions?page&page_size&order&action'

Responses

🟢200OK
application/json
Successful operation
Body
array of:
user_id
string 
optional
item_id
string 
optional
action
string 
optional
values
object 
optional
Additional values specific to the interaction type
rating
number 
optional
date_created
string <date-time>
optional
timestamp
integer 
optional
Example
[
  {
    "user_id": "string",
    "item_id": "string",
    "action": "string",
    "values": {},
    "rating": 0,
    "date_created": "2019-08-24T14:15:22Z",
    "timestamp": 0
  }
]
🟠401Unauthorized
Previous
Record an interaction
Next
Delete an interaction
Built with