Login
Recommender API v3.0

General notes

API detail

Application 3
version v3.0 (Optional) The API version
query test (Optional) Search Term
take 2 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/application?version=v3.0&query=test&take=2&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/application?version=v3.0&query=test&take=2&skip=0 HTTP/1.1
Host:
version v3.0 (Optional) The API version
query test Search Term 
curl -X GET "{{recommender-api-url}}/application/model-accuracy?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/application/model-accuracy?version=v3.0 HTTP/1.1
Host:
version v3.0 (Optional) The API version
query test Search Term 
curl -X GET "{{recommender-api-url}}/application/info?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/application/info?version=v3.0 HTTP/1.1
Host:
Organization 12
version v3.0 
curl -X GET "{{recommender-api-url}}/organization/applications?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/organization/applications?version=v3.0 HTTP/1.1
Host:
version v3.0 
curl -X GET "{{recommender-api-url}}/organization/stats?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/organization/stats?version=v3.0 HTTP/1.1
Host:
version v3.0 (Optional) The API version
query John (Optional) Search term to filter users
take 20 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/organization/users?version=v3.0&take=20&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/organization/users?version=v3.0&take=20&skip=0 HTTP/1.1
Host:
version v3.0 (Optional) The API version
application_id 26 (Required) Application ID
query John (Optional) Search term to filter users
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/organization/application-users?version=v3.0&application_id=26&take=10&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/organization/application-users?version=v3.0&application_id=26&take=10&skip=0 HTTP/1.1
Host:
version v3.0
name New App Name (Required) New Application name
description App Description (Required) The description of the application
domain https://domain.com (Required) The domain where the application will run
application_type other (Required) One of three options: media,retail or other
aws_access_key {AWS_ACCESS_KEY} (Optional) Your AWS S3 Access Key for your S3 Bucket 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "name=New App Name&description=App Description&domain=https://domain.com&application_type=other&aws_access_key={AWS_ACCESS_KEY}" "{{recommender-api-url}}/organization/create-application?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/organization/create-application?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

name=New App Name&description=App Description&domain=https://domain.com&application_type=other&aws_access_key={AWS_ACCESS_KEY}
version v3.0
application_id 12 (Required) The Application ID
name New App Name (Required) New Application name
description App Description (Required) The description of the application
domain https://domain.com (Required) The domain where the application will run
aws_access_key {AWS_ACCESS_KEY} (Optional) Your AWS S3 Access Key for your S3 Bucket 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "application_id=12&name=New App Name&description=App Description&domain=https://domain.com&aws_access_key={AWS_ACCESS_KEY}" "{{recommender-api-url}}/organization/edit-application?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/organization/edit-application?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

application_id=12&name=New App Name&description=App Description&domain=https://domain.com&aws_access_key={AWS_ACCESS_KEY}
version v3.0
first_name Rochelle (Required) First Name of the new user
last_name Botha (Required) Last Name of the new user
email roch1@gmail.com (Required) Email of the new user
user_type Org-Admin (Required) One of 4 values: Org-Owner, Org-Admin, Org-Billing or App-User 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "first_name=Rochelle&last_name=Botha&email=roch1@gmail.com&user_type=Org-Admin" "{{recommender-api-url}}/organization/create-user?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/organization/create-user?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

first_name=Rochelle&last_name=Botha&email=roch1@gmail.com&user_type=Org-Admin
version v3.0
user_id 10 (Required) Auth User ID 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "user_id=10" "{{recommender-api-url}}/organization/delete-user?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/organization/delete-user?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

user_id=10
version v3.0
user_id 10 (Required) Auth User ID
application_id 10 (Required) The Application ID 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "user_id=10&application_id=10" "{{recommender-api-url}}/organization/delete-user-application?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/organization/delete-user-application?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

user_id=10&application_id=10
version v3.0
user_id 111 (Required) Auth User ID
first_name John (Required) The first name of the existing user
last_name Doe (Required) The last name of the existing user
email johndoe@gmail.com (Required) The email of the existing user
user_type App-User (Required) One of 3 values: Org-Admin, Org-Billing or App-User 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "user_id=111&first_name=John&last_name=Doe&email=johndoe@gmail.com&user_type=App-User" "{{recommender-api-url}}/organization/edit-user?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/organization/edit-user?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

user_id=111&first_name=John&last_name=Doe&email=johndoe@gmail.com&user_type=App-User
version v3.0
application_id 12 (Required) Application ID belonging to the Organization
user_id 90 (Required) User ID belonging to the Organization 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "application_id=12&user_id=90" "{{recommender-api-url}}/organization/add-user-application?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/organization/add-user-application?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

application_id=12&user_id=90
version v3.0
application_id 12 (Required) The application you want to use 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "application_id=12" "{{recommender-api-url}}/organization/change-application?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/organization/change-application?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

application_id=12
Organization Users 4

List of all users in application
Admin users only

version v3.0 (Optional) The API version 
curl -X GET "{{recommender-api-url}}/user?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/user?version=v3.0 HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": [
        {
            "user_id": "89",
            "account": "email",
            "user_status_id": "1",
            "user_status": "Active",
            "user_type": "User",
            "first_name": "Reuben",
            "last_name": "Tester",
            "email": "rubytest@xineoh.com",
            "username": null,
            "oauth_id": null,
            "shopify_id": null,
            "telephone": null,
            "dob": "2022-01-21",
            "gender": "male",
            "profile_pic_url": null,
            "created_dt": null,
            "updated_dt": null,
            "application_id": "19",
            "application_app_id": "WhiteRabbitApi2",
            "application": "White Rabbit Api 2",
            "application_type": "retail",
            "token": "ac2aa4c67f6caa3061b4ca826ecdcd29"
        }
    ]
}

Admin user can add extra users, system generates password for user that can be changed
Admin users only

Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version
email user@example.com (Required) New user email
first_name John (Required) New user's first name
last_name Doe (Required) New user's last name 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "email=user@example.com&first_name=John&last_name=Doe" "{{recommender-api-url}}/user/addUser?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/user/addUser?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

email=user@example.com&first_name=John&last_name=Doe

Admin user can add extra users, system generates password for user that can be changed
Admin users only

Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version
current_password 098f6bcd4621d373cade4e832627b4f7 (Required) Current user password
new_password 098f6bcd4621d373cade4e832627b4f6 (Required) New user password
confirm_new_password 098f6bcd4621d373cade4e832627b4f6 (Required) New user password 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "current_password=098f6bcd4621d373cade4e832627b4f7&new_password=098f6bcd4621d373cade4e832627b4f6&confirm_new_password=098f6bcd4621d373cade4e832627b4f6" "{{recommender-api-url}}/user/change-password?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/user/change-password?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

current_password=098f6bcd4621d373cade4e832627b4f7&new_password=098f6bcd4621d373cade4e832627b4f6&confirm_new_password=098f6bcd4621d373cade4e832627b4f6

Admin user can add extra users, system generates password for user that can be changed
Admin users only

Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version
first_name John (Required) User first name
last_name Doe (Required) User last name 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "first_name=John&last_name=Doe" "{{recommender-api-url}}/user/update?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/user/update?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

first_name=John&last_name=Doe
Auth 8

Login User request

Login user request

this is the api documentation {{api_variable}}

Content-Type application/x-www-form-urlencoded
version v3.0 The API version (optional)
first_name John (Required) First Name of the user
last_name Doe (Required) Last Name of the user
email johndoe123@gmail.com (Required) Email address of te user
password 098f6bcd4621d373cade4e832627b4f6 (Required) MD5 encrypted string of your password
retype_password 098f6bcd4621d373cade4e832627b4f6 (Required) MD5 encrypted string of your password
organization Example Organization (Required) Organization 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "first_name=John&last_name=Doe&email=johndoe123@gmail.com&password=098f6bcd4621d373cade4e832627b4f6&retype_password=098f6bcd4621d373cade4e832627b4f6&organization=Example Organization" "{{recommender-api-url}}/register?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/register?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

first_name=John&last_name=Doe&email=johndoe123@gmail.com&password=098f6bcd4621d373cade4e832627b4f6&retype_password=098f6bcd4621d373cade4e832627b4f6&organization=Example Organization
Status401 Unauthorized
Content-Typeapplication/json
{
    "status_code": 401,
    "error": {
        "message": "Login failed",
        "code": 33
    }
}
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "session_id": 4624,
        "user_id": 254,
        "user_status": "Active",
        "user_type": "Manager",
        "email": "johndoe@example.com",
        "username": "johndoe",
        "gender": null,
        "dob": null,
        "profile_pic": null,
        "application": "Movie Lens Sample Data",
        "application_id": 24,
        "refresh_token": "{{jwt-token}}",
        "theme": null
    }
}
Status0

Login User request

Login user request

this is the api documentation {{api_variable}}

Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version
username johndoe123@gmail.com (Required) User email address
password 098f6bcd4621d373cade4e832627b4f6 (Required) MD5 generated string of the user's password 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "username=johndoe123@gmail.com&password=098f6bcd4621d373cade4e832627b4f6" "{{recommender-api-url}}/login?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/login?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

username=johndoe123@gmail.com&password=098f6bcd4621d373cade4e832627b4f6
Status401 Unauthorized
Content-Typeapplication/json
{
    "status_code": 401,
    "error": {
        "message": "Login failed",
        "code": 33
    }
}
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "session_id": 4624,
        "user_id": 254,
        "user_status": "Active",
        "user_type": "Manager",
        "email": "johndoe@example.com",
        "username": "johndoe",
        "gender": null,
        "dob": null,
        "profile_pic": null,
        "application": "Movie Lens Sample Data",
        "application_id": 24,
        "refresh_token": "{{jwt-token}}",
        "theme": null
    }
}

Login User request

Login user request

this is the api documentation {{api_variable}}

Content-Type application/x-www-form-urlencoded
version v3.0 The API version (optional)
activation_code 23ed9640a51d538ac8c034f59dba81de2139431fca47134e3f1d88003219 Activation code from email (required) 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "activation_code=23ed9640a51d538ac8c034f59dba81de2139431fca47134e3f1d88003219" "{{recommender-api-url}}/verify?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/verify?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

activation_code=23ed9640a51d538ac8c034f59dba81de2139431fca47134e3f1d88003219

Login User request

Login user request

this is the api documentation {{api_variable}}

Content-Type application/x-www-form-urlencoded
version v3.0 The API version (optional)
email johndoe123@gmail.com Email to verify (required) 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "email=johndoe123@gmail.com" "{{recommender-api-url}}/verify/resend?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/verify/resend?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

email=johndoe123@gmail.com
Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version
email johndoe@example.com (Required) Email of the user 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "email=johndoe@example.com" "{{recommender-api-url}}/reset/password?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/reset/password?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

email=johndoe@example.com
Content-Type application/json
version v3.0 (Optional) The API version
password 5a105e8b9d40e1329780d62ea2265d8a
token {{reset-password-jwt-token}} 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/json" -d "password=5a105e8b9d40e1329780d62ea2265d8a&token={{reset-password-jwt-token}}" "{{recommender-api-url}}/reset/change?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/reset/change?version=v3.0 HTTP/1.1
Host:
Content-Type: application/json
Content-Type: application/x-www-form-urlencoded

password=5a105e8b9d40e1329780d62ea2265d8a&token={{reset-password-jwt-token}}
Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version
user_id 1 (Required) Id of the user you wish to get a JWT generated token for 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "user_id=1" "{{recommender-api-url}}/generate?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/generate?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

user_id=1

Validates the Bearer token send in the request header.

Authorization Bearer {{recommender_api_jwt}}
Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version 
curl -X POST -H "Authorization: Bearer  {{recommender_api_jwt}}" -H "Content-Type: application/x-www-form-urlencoded" "{{recommender-api-url}}/validate?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/validate?version=v3.0 HTTP/1.1
Host:
Authorization: Bearer  {{recommender_api_jwt}}
Content-Type: application/x-www-form-urlencoded
Billing 10
version v3.0
company Example Company (Required) Company name
contact_first_name John (Required) Billing First Name
contact_last_name Doe (Required) Billing Last Name
contact_phone_country_code +27 (Optional)
contact_phone_number 123456789 (Optional)
address_1st_line Address Line 1 (Optional)
address_2nd_line Address Line 2 (Optional)
address_3rd_line Address Line 3 (Optional)
country South Africa (Optional)
email billing@company.co.za (Optional) 
curl -X POST "{{recommender-api-url}}/billing/info?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/billing/info?version=v3.0 HTTP/1.1
Host:
version v3.0
recommendations 100 Number of recommendations
active_users 100 Number of active users
data_size 100mb Total size of your data 
curl -X POST "{{recommender-api-url}}/billing/quotation?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/billing/quotation?version=v3.0 HTTP/1.1
Host:

Returns info about query transactions for a day.

Type Results Index Example
Query Id query 29408
Username username johndoe@example.com
Transaction Status status success
Time of Transaction time 2020-07-03 10:27:15
version v3.0 (Optional) The API version
date 2018-05-21 (Required) Date. Format is "year-month-day". E.g. "2020-04-20"
page 1 (Optional) Results page number/index
size 2 (Optional) Number of results returned 
curl -X GET "{{recommender-api-url}}/billing/query?version=v3.0&date=2018-05-21&page=1&size=2"
GET %7B%7Brecommender-api-url%7D%7D/billing/query?version=v3.0&date=2018-05-21&page=1&size=2 HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "currentPage": 1,
        "totalPages": 6,
        "totalResults": 12,
        "results": [
            {
                "query": 29408,
                "username": "johndoe@example.com",
                "status": "success",
                "time": "2020-07-03 10:27:15"
            },
            {
                "query": 29409,
                "username": "johndoen@example.com",
                "status": "success",
                "time": "2020-07-03 10:28:19"
            }
        ]
    }
}

Returns statement based on filters

version v3.0 (Optional) The API version
start_date 2022-08-01 (Required) Start date of statement query. Format is "year-month-day". E.g. "2020-04-20"
end_date 2022-08-25 (Required) End date of statement query. Format is "year-month-day". E.g. "2020-04-20" 
curl -X GET "{{recommender-api-url}}/billing/statement?version=v3.0&start_date=2022-08-01&end_date=2022-08-25"
GET %7B%7Brecommender-api-url%7D%7D/billing/statement?version=v3.0&start_date=2022-08-01&end_date=2022-08-25 HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": [
        {
            "day": "2020-07-01",
            "deposit": [],
            "queries": {
                "api_calls": 0,
                "cost": "0.00"
            }
        },
        {
            "day": "2020-07-02",
            "deposit": [],
            "queries": {
                "api_calls": 0,
                "cost": "0.00"
            }
        }
    ]
}

Returns usage stats of current month

version v3.0 (Optional) The API version
start_date 2018-05-01 (Required) Start date of stats query. Format is "year-month-day". E.g. "2020-04-20"
end_date 2018-05-03 (Required) End date of stats query. Format is "year-month-day". E.g. "2020-04-20" 
curl -X GET "{{recommender-api-url}}/billing/stats?version=v3.0&start_date=2018-05-01&end_date=2018-05-03"
GET %7B%7Brecommender-api-url%7D%7D/billing/stats?version=v3.0&start_date=2018-05-01&end_date=2018-05-03 HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "api_calls": 12,
        "deposits": "0.00"
    }
}
version v3.0 
curl -X GET "{{recommender-api-url}}/billing?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/billing?version=v3.0 HTTP/1.1
Host:
version v3.0 
curl -X GET "{{recommender-api-url}}/billing/selected-plan?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/billing/selected-plan?version=v3.0 HTTP/1.1
Host:
version v3.0 
curl -X GET "{{recommender-api-url}}/billing/plans?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/billing/plans?version=v3.0 HTTP/1.1
Host:
version v3.0 
curl -X GET "{{recommender-api-url}}/billing/account-statement?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/billing/account-statement?version=v3.0 HTTP/1.1
Host:

Verifies payment from paypal / credit card / wire and adds funds to account
Pending

version v3.0 (Optional) The API version 
curl -X POST "{{recommender-api-url}}/billing/payment?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/billing/payment?version=v3.0 HTTP/1.1
Host:
Recommender Builder 11

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
aws_secret_key SdMVa47GlNKrbH//ZpKGnxgMTcb68+bHMRAZ4BWr (Required) AWS S3 Secret Key
aws_bucket xineoh-movielens-bucket (Required) AWS S3 Bucket 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "aws_secret_key=SdMVa47GlNKrbH//ZpKGnxgMTcb68+bHMRAZ4BWr&aws_bucket=xineoh-movielens-bucket" "{{recommender-api-url}}/builder/batch?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/batch?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

aws_secret_key=SdMVa47GlNKrbH//ZpKGnxgMTcb68+bHMRAZ4BWr&aws_bucket=xineoh-movielens-bucket

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" "{{recommender-api-url}}/builder/build?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/build?version=v3.0 HTTP/1.1
Host:

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" "{{recommender-api-url}}/builder/train?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/train?version=v3.0 HTTP/1.1
Host:

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" "{{recommender-api-url}}/builder/test?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/test?version=v3.0 HTTP/1.1
Host:

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
max_iter 30 (Required) Maximum number of iterations to run the meta param optimization. (Min: 5, Max: 100) 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "max_iter=30" "{{recommender-api-url}}/builder/optimize?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/optimize?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

max_iter=30

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
clusters_min 2 (Required) Minimum amount of clusters to do for a given cluster type (Min:2)
clusters_max 10 (Required) Maximum amount of clusters to do for a given cluster type (Max:100)
cluster_type user (Required) Which category to cluster - user or item 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "clusters_min=2&clusters_max=10&cluster_type=user" "{{recommender-api-url}}/builder/cluster?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/cluster?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

clusters_min=2&clusters_max=10&cluster_type=user

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
clusters_min 2 (Required) Minimum amount of clusters to do for a given cluster type (Min:2)
clusters_max 10 (Required) Maximum amount of clusters to do for a given cluster type (Max:100)
cluster_type item (Required) Which category to cluster - user or item 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "clusters_min=2&clusters_max=10&cluster_type=item" "{{recommender-api-url}}/builder/cluster?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/cluster?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

clusters_min=2&clusters_max=10&cluster_type=item
version v3.0 (Optional) The API version
graph trade_off (Required) Graph Type
type users (Required) Trade off data type. 'users'|'items' 
curl -X GET "{{recommender-api-url}}/charts/graph?version=v3.0&graph=trade_off&type=users"
GET %7B%7Brecommender-api-url%7D%7D/charts/graph?version=v3.0&graph=trade_off&type=users HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": [
        {
            "number_of_clusters": "2",
            "mse": "31824.90"
        },
        {
            "number_of_clusters": "3",
            "mse": "30556.59"
        },
        {
            "number_of_clusters": "4",
            "mse": "29532.38"
        },
        {
            "number_of_clusters": "5",
            "mse": "28702.58"
        },
        {
            "number_of_clusters": "6",
            "mse": "27914.87"
        },
        {
            "number_of_clusters": "7",
            "mse": "27288.29"
        },
        {
            "number_of_clusters": "8",
            "mse": "26805.86"
        },
        {
            "number_of_clusters": "9",
            "mse": "26389.04"
        },
        {
            "number_of_clusters": "10",
            "mse": "25940.89"
        },
        {
            "number_of_clusters": "11",
            "mse": "25497.67"
        },
        {
            "number_of_clusters": "12",
            "mse": "25157.47"
        },
        {
            "number_of_clusters": "13",
            "mse": "24815.04"
        },
        {
            "number_of_clusters": "14",
            "mse": "24496.50"
        },
        {
            "number_of_clusters": "15",
            "mse": "24245.73"
        },
        {
            "number_of_clusters": "16",
            "mse": "24058.61"
        },
        {
            "number_of_clusters": "17",
            "mse": "23879.36"
        },
        {
            "number_of_clusters": "18",
            "mse": "23684.18"
        },
        {
            "number_of_clusters": "19",
            "mse": "23539.99"
        },
        {
            "number_of_clusters": "20",
            "mse": "23431.13"
        }
    ]
}

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
cluster_type user (Required) Which category of cluster to save the cluster info for
cluster_amount 10 (Required) Chosen number of clusters to use for a given cluster type 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "cluster_type=user&cluster_amount=10" "{{recommender-api-url}}/builder/cluster_choose?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/cluster_choose?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

cluster_type=user&cluster_amount=10
version v3.0 (Optional) The API version
graph trade_off (Required) Graph Type
type items (Required) Trade off type. 'users'|'items' 
curl -X GET "{{recommender-api-url}}/charts/graph?version=v3.0&graph=trade_off&type=items"
GET %7B%7Brecommender-api-url%7D%7D/charts/graph?version=v3.0&graph=trade_off&type=items HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": [
        {
            "number_of_clusters": "2",
            "mse": "162584.55"
        },
        {
            "number_of_clusters": "3",
            "mse": "158518.19"
        },
        {
            "number_of_clusters": "4",
            "mse": "155479.15"
        },
        {
            "number_of_clusters": "5",
            "mse": "152717.84"
        },
        {
            "number_of_clusters": "6",
            "mse": "150644.99"
        },
        {
            "number_of_clusters": "7",
            "mse": "148901.17"
        },
        {
            "number_of_clusters": "8",
            "mse": "147307.51"
        },
        {
            "number_of_clusters": "9",
            "mse": "146243.97"
        },
        {
            "number_of_clusters": "10",
            "mse": "145347.56"
        },
        {
            "number_of_clusters": "11",
            "mse": "144468.26"
        },
        {
            "number_of_clusters": "12",
            "mse": "143672.38"
        },
        {
            "number_of_clusters": "13",
            "mse": "142966.35"
        },
        {
            "number_of_clusters": "14",
            "mse": "142319.23"
        },
        {
            "number_of_clusters": "15",
            "mse": "141754.99"
        },
        {
            "number_of_clusters": "16",
            "mse": "141220.43"
        },
        {
            "number_of_clusters": "17",
            "mse": "140714.97"
        },
        {
            "number_of_clusters": "18",
            "mse": "140277.15"
        },
        {
            "number_of_clusters": "19",
            "mse": "139878.46"
        },
        {
            "number_of_clusters": "20",
            "mse": "139461.73"
        }
    ]
}

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
cluster_type item (Required) Which category of cluster to save the cluster info for
cluster_amount 10 (Required) Chosen number of clusters to use for a given cluster type 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "cluster_type=item&cluster_amount=10" "{{recommender-api-url}}/builder/cluster_choose?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/builder/cluster_choose?version=v3.0 HTTP/1.1
Host:
Content-Type: application/x-www-form-urlencoded

cluster_type=item&cluster_amount=10
Recommender Builder Process Info 2
version v3.0 (Optional) The API version
process_id 235 (Required) Process ID recieved from one of the Builder endpoints 
curl -X GET "{{recommender-api-url}}/process?version=v3.0&process_id=235"
GET %7B%7Brecommender-api-url%7D%7D/process?version=v3.0&process_id=235 HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": [
        {
            "number_of_clusters": "2",
            "mse": "31824.90"
        },
        {
            "number_of_clusters": "3",
            "mse": "30556.59"
        },
        {
            "number_of_clusters": "4",
            "mse": "29532.38"
        },
        {
            "number_of_clusters": "5",
            "mse": "28702.58"
        },
        {
            "number_of_clusters": "6",
            "mse": "27914.87"
        },
        {
            "number_of_clusters": "7",
            "mse": "27288.29"
        },
        {
            "number_of_clusters": "8",
            "mse": "26805.86"
        },
        {
            "number_of_clusters": "9",
            "mse": "26389.04"
        },
        {
            "number_of_clusters": "10",
            "mse": "25940.89"
        },
        {
            "number_of_clusters": "11",
            "mse": "25497.67"
        },
        {
            "number_of_clusters": "12",
            "mse": "25157.47"
        },
        {
            "number_of_clusters": "13",
            "mse": "24815.04"
        },
        {
            "number_of_clusters": "14",
            "mse": "24496.50"
        },
        {
            "number_of_clusters": "15",
            "mse": "24245.73"
        },
        {
            "number_of_clusters": "16",
            "mse": "24058.61"
        },
        {
            "number_of_clusters": "17",
            "mse": "23879.36"
        },
        {
            "number_of_clusters": "18",
            "mse": "23684.18"
        },
        {
            "number_of_clusters": "19",
            "mse": "23539.99"
        },
        {
            "number_of_clusters": "20",
            "mse": "23431.13"
        }
    ]
}
version v3.0 (Optional) The API version
process optimize (Required) Process ID recieved from one of the Builder endpoints 
curl -X GET "{{recommender-api-url}}/process?version=v3.0&process=optimize"
GET %7B%7Brecommender-api-url%7D%7D/process?version=v3.0&process=optimize HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": [
        {
            "number_of_clusters": "2",
            "mse": "31824.90"
        },
        {
            "number_of_clusters": "3",
            "mse": "30556.59"
        },
        {
            "number_of_clusters": "4",
            "mse": "29532.38"
        },
        {
            "number_of_clusters": "5",
            "mse": "28702.58"
        },
        {
            "number_of_clusters": "6",
            "mse": "27914.87"
        },
        {
            "number_of_clusters": "7",
            "mse": "27288.29"
        },
        {
            "number_of_clusters": "8",
            "mse": "26805.86"
        },
        {
            "number_of_clusters": "9",
            "mse": "26389.04"
        },
        {
            "number_of_clusters": "10",
            "mse": "25940.89"
        },
        {
            "number_of_clusters": "11",
            "mse": "25497.67"
        },
        {
            "number_of_clusters": "12",
            "mse": "25157.47"
        },
        {
            "number_of_clusters": "13",
            "mse": "24815.04"
        },
        {
            "number_of_clusters": "14",
            "mse": "24496.50"
        },
        {
            "number_of_clusters": "15",
            "mse": "24245.73"
        },
        {
            "number_of_clusters": "16",
            "mse": "24058.61"
        },
        {
            "number_of_clusters": "17",
            "mse": "23879.36"
        },
        {
            "number_of_clusters": "18",
            "mse": "23684.18"
        },
        {
            "number_of_clusters": "19",
            "mse": "23539.99"
        },
        {
            "number_of_clusters": "20",
            "mse": "23431.13"
        }
    ]
}
Recommendations 9
version v3.0 (Optional) The API version
type cluster_recommendations (Required) Type of recommendations to return
cluster_type user (Required) Cluster/Segment type. 'user' | 'item'
id 1 (Required) Cluster/Segment Id. 
curl -X GET "{{recommender-api-url}}/recommender/recommendations?version=v3.0&type=cluster_recommendations&cluster_type=user&id=1"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&type=cluster_recommendations&cluster_type=user&id=1 HTTP/1.1
Host:
Authorization Bearer {{recommender_api_jwt}}
Content-Type application/json
version v3.0 (Optional) The API version
type cluster_recommendations (Required) Type of recommendations to return
cluster_type item (Required) Cluster/Segment type. 'user' | 'item'
id 1 (Required) Cluster/Segment Id. 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" -H "Content-Type: application/json" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&type=cluster_recommendations&cluster_type=item&id=1"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&type=cluster_recommendations&cluster_type=item&id=1 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Content-Type: application/json
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type user_closest_clusters (Required) Type of recommendations to return
id 1 (Required) Cluster/Segment Id. 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/similar?version=v3.0&type=user_closest_clusters&id=1"
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=user_closest_clusters&id=1 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type item_closest_clusters (Required) Type of recommendations to return
id 1 (Required) Cluster/Segment Id. 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/similar?version=v3.0&type=item_closest_clusters&id=1"
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=item_closest_clusters&id=1 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type item (Required) Type of recommendations to return
id 372785 (Required) Id of the item you want to get recommendations for
filter {"includes": {"category": "Apparel"}, "excludes": {"category": "Gifting"}} (Optional) Filter to include and exclude items based on meta data field values 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/similar?version=v3.0&type=item&id=372785&filter={"includes": {"category": "Apparel"}, "excludes": {"category": "Gifting"}}"
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=item&id=372785&filter={"includes": {"category": "Apparel"}, "excludes": {"category": "Gifting"}} HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type user (Required) Type of recommendations to return
id 382015 (Required) Id of the user you want to get recommendations for 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/similar?version=v3.0&type=user&id=382015"
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=user&id=382015 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type user_recommendations (Required) Type of recommendations to return
id 138176 (Required) User id to get recommendations for
session_id a79dc177-91dc-435a-abbf-1d21189f5151 (Optional) Session ID - (Required) for session based recommendations
context alone (Optional) Session Context
device tablet (Optional) Session Device (mobile|desktop|tablet)
geolocation North America (Optional) Session Geolocation
event_type rating (Optional) Event Type
filter {"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}} (Optional) Filter to include and exclude items based on meta data field values
size 20 (Optional) Will default to 20 if not included 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&type=user_recommendations&id=138176&size=20"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&type=user_recommendations&id=138176&size=20 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type user_recommendations (Required) Type of recommendations to return
id 138176 (Required) User id to get recommendations for
filter {"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}} (Optional) Filter to include and exclude items based on meta data field values
size 20 (Optional) Will default to 20 if not included 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&type=user_recommendations&id=138176&filter={"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}}&size=20"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&type=user_recommendations&id=138176&filter={"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}}&size=20 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type user_recommendations (Required) Type of recommendations to return
id 138176 (Required) User id to get recommendations for
session_id a79dc177-91dc-435a-abbf-1d21189f5151 (Required) for session based recommendations
context alone (Optional) Session Context - context will be taken into consideration when making session based recommendations
device tablet (Optional) Session Device (mobile|desktop|tablet)
geolocation North America (Optional) Session Geolocation
event_type rating (Optional) Event Type - event type will be taken into consideration when making session based recommendations
filter {"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}} (Optional) Filter to include and exclude items based on meta data field values
size 20 (Optional) Will default to 20 if not included 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&type=user_recommendations&id=138176&session_id=a79dc177-91dc-435a-abbf-1d21189f5151&context=alone&device=tablet&geolocation=North America&event_type=rating&filter={"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}}&size=20"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&type=user_recommendations&id=138176&session_id=a79dc177-91dc-435a-abbf-1d21189f5151&context=alone&device=tablet&geolocation=North America&event_type=rating&filter={"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}}&size=20 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Clusters 3
version v3.0 (Optional) The API version
type users (Required) Cluster type
take 20 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/info/clusters?version=v3.0&type=users&take=20&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/clusters?version=v3.0&type=users&take=20&skip=0 HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "total": "20",
        "data": [
            {
                "cluster": "1"
            },
            {
                "cluster": "2"
            },
            {
                "cluster": "3"
            },
            {
                "cluster": "4"
            },
            {
                "cluster": "5"
            },
            {
                "cluster": "6"
            },
            {
                "cluster": "7"
            },
            {
                "cluster": "8"
            },
            {
                "cluster": "9"
            },
            {
                "cluster": "10"
            },
            {
                "cluster": "11"
            },
            {
                "cluster": "12"
            },
            {
                "cluster": "13"
            },
            {
                "cluster": "14"
            },
            {
                "cluster": "15"
            },
            {
                "cluster": "16"
            },
            {
                "cluster": "17"
            },
            {
                "cluster": "18"
            },
            {
                "cluster": "19"
            },
            {
                "cluster": "20"
            }
        ]
    }
}
version v3.0 (Optional) The API version
type items (Required) Cluster Type
take 20 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/info/clusters?version=v3.0&type=items&take=20&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/clusters?version=v3.0&type=items&take=20&skip=0 HTTP/1.1
Host:

Returns cluster interactions based on filters

version v3.0 (Optional) The API version
cluster_type user
cluster 7
order desc
take 10
skip 0 
curl -X GET "{{recommender-api-url}}/info/activeUsers?version=v3.0&cluster_type=user&cluster=7&order=desc&take=10&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/activeUsers?version=v3.0&cluster_type=user&cluster=7&order=desc&take=10&skip=0 HTTP/1.1
Host:
Interactions 3

Returns user interactions based on filters

version v3.0 (Optional) The API version
type user (Required) ID type - item|user
id 1001 (Required) User|Item Id
query quantity (Optional) Interactions type query.
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/info/interactions/?version=v3.0&type=user&id=1001&take=10&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/interactions/?version=v3.0&type=user&id=1001&take=10&skip=0 HTTP/1.1
Host:

Returns user interactions based on filters

version v3.0 (Optional) The API version
type item (Required) ID type - item|user
id 517 (Required) User|Item Id
query quantity (Optional) Interactions type query.
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/info/interactions/?version=v3.0&type=item&id=517&take=10&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/interactions/?version=v3.0&type=item&id=517&take=10&skip=0 HTTP/1.1
Host:

Post interaction data, can be single interactions or in bulk
Can send api user_id or your user id (internal_user_id) - user_id is preferred
Can send api item_id or your item id (internal_item_id) - item_id is preferred
6MB is the maximum amount of data that can be sent at once
Admin users only

Content-Type application/json
version v3.0 (Optional) The API version 
curl -X POST -H "Content-Type: application/json" -d '{
  "interactions": [{
      "user_id": 41499,
      "item_id": 98,
      "event_value": "10",
      "event_type": "quantity",
      "event_meta_data_1": 25
    },
    {
      "user_id": 1,
      "item_id": 1,
      "event_value": "8",
      "event_type": "quantity",
      "event_meta_data_1": 25,
      "event_meta_data_2": 10,
      "event_date": "2018-04-24 17:00:00"
    }
  ]
}' "{{recommender-api-url}}/data/interactions?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/data/interactions?version=v3.0 HTTP/1.1
Host:
Content-Type: application/json

{
  "interactions": [{
      "user_id": 41499,
      "item_id": 98,
      "event_value": "10",
      "event_type": "quantity",
      "event_meta_data_1": 25
    },
    {
      "user_id": 1,
      "item_id": 1,
      "event_value": "8",
      "event_type": "quantity",
      "event_meta_data_1": 25,
      "event_meta_data_2": 10,
      "event_date": "2018-04-24 17:00:00"
    }
  ]
}
Items 4
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/info/items?version=v3.0&take=10&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/items?version=v3.0&take=10&skip=0 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}

Operators:

Operator Comparative Logic
startswith LIKE {value} %%
contains LIKE %%{value}%%
doesnotcontain NOT LIKE %%{value}%%
endswith LIKE %%{value}
eq \=
gt >
lt <
gte >=
lte <=
neg <>
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0'
filter[filters][0][field] id (Required) Field to use for filter
filter[filters][0][operator] eq (Required) Operator to use for filter. 'startswith'|'contains'|doesnotcontain'|'endswith'|'eq'|'gt'|'lt'|'gte'|'lte'|'neg'
filter[filters][0][value] 260335 (Required) Value to use for filter.
filter[logic] and (Required) Multiple Filters combination logic. 'and'|'or' 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/info/items?version=v3.0&take=10&skip=0&filter[filters][0][field]=id&filter[filters][0][operator]=eq&filter[filters][0][value]=260335&filter[logic]=and"
GET %7B%7Brecommender-api-url%7D%7D/info/items?version=v3.0&take=10&skip=0&filter[filters][0][field]=id&filter[filters][0][operator]=eq&filter[filters][0][value]=260335&filter[logic]=and HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}

Create new meta data entry for user or item and specify if it will be used for the recommender and date it got added
Admin users only

Authorization Bearer {{recommender_api_jwt}}
Content-Type application/json
version v3.0 (Optional) The API version 
curl -X POST -H "Authorization: Bearer {{recommender_api_jwt}}" -H "Content-Type: application/json" -d '{
    "action" : "create",
    "type" : "item",
    "meta_data": {
        "id": {
            "value" : 123456785,
            "date_created": "2022-06-16 15:11:14"
        },
        "description": {
            "value" : "Birds Eye Golfer (BE)",
            "date_created": "2022-06-16 15:11:14"
        },
        "brand": {
            "value" : "Barron"
        },
        "category": {
            "value" : "Apparel"
        },
        "type": {
            "value" : "Golf Shirts"
        },
        "garment_type": {
            "value" : "Classic Range"
        }
    }
}' "{{recommender-api-url}}/data/meta_data?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/data/meta_data?version=v3.0 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Content-Type: application/json

{
    "action" : "create",
    "type" : "item",
    "meta_data": {
        "id": {
            "value" : 123456785,
            "date_created": "2022-06-16 15:11:14"
        },
        "description": {
            "value" : "Birds Eye Golfer (BE)",
            "date_created": "2022-06-16 15:11:14"
        },
        "brand": {
            "value" : "Barron"
        },
        "category": {
            "value" : "Apparel"
        },
        "type": {
            "value" : "Golf Shirts"
        },
        "garment_type": {
            "value" : "Classic Range"
        }
    }
}

Create new meta data entry for user or item and specify if it will be used for the recommender and date it got added
Admin users only

Authorization Bearer {{recommender_api_jwt}}
Content-Type application/json
version v3.0 (Optional) The API version
item_ids[] 1 An array of item id's to be deleted
item_ids[] 2 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Bearer {{recommender_api_jwt}}" -H "Content-Type: application/json" -d "item_ids[]=1&item_ids[]=2" "{{recommender-api-url}}/data/item-delete?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/data/item-delete?version=v3.0 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Content-Type: application/json
Content-Type: application/x-www-form-urlencoded

item_ids[]=1&item_ids[]=2
Users 4

Returns paginated list of users

version v3.0 (Optional) The API version
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/info/users?version=v3.0&take=10&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/users?version=v3.0&take=10&skip=0 HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "total": "17304",
        "data": [
            {
                "user_id": "338038",
                "cluster": "18"
            },
            {
                "user_id": "338039",
                "cluster": "6"
            },
            {
                "user_id": "338040",
                "cluster": "16"
            },
            {
                "user_id": "338041",
                "cluster": "3"
            },
            {
                "user_id": "338043",
                "cluster": "9"
            },
            {
                "user_id": "338044",
                "cluster": "1"
            },
            {
                "user_id": "338045",
                "cluster": "10"
            },
            {
                "user_id": "338046",
                "cluster": "5"
            },
            {
                "user_id": "338047",
                "cluster": "6"
            },
            {
                "user_id": "338051",
                "cluster": "10"
            }
        ]
    }
}

Returns paginated list of users

Operators:

Operator Comparative Logic
startswith LIKE {value} %%
contains LIKE %%{value}%%
doesnotcontain NOT LIKE %%{value}%%
endswith LIKE %%{value}
eq \=
gt >
lt <
gte >=
lte <=
neg <>
version v3.0 (Optional) The API version
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0'
filter[filters][0][field] id (Required) Field to use for filter
filter[filters][0][operator] eq (Required) Operator to use for filter. 'startswith'|'contains'|doesnotcontain'|'endswith'|'eq'|'gt'|'lt'|'gte'|'lte'|'neg'
filter[filters][0][value] 338041 (Required) Value to use for filter.
filter[logic] and (Required) Multiple Filters combination logic. 'and'|'or'
filter[filters][1][field] id
filter[filters][1][operator] eq
filter[filters][1][value] 338040 
curl -X GET "{{recommender-api-url}}/info/users?version=v3.0&take=10&skip=0&filter[filters][0][field]=id&filter[filters][0][operator]=eq&filter[filters][0][value]=338041&filter[logic]=and&filter[filters][1][field]=id&filter[filters][1][operator]=eq&filter[filters][1][value]=338040"
GET %7B%7Brecommender-api-url%7D%7D/info/users?version=v3.0&take=10&skip=0&filter[filters][0][field]=id&filter[filters][0][operator]=eq&filter[filters][0][value]=338041&filter[logic]=and&filter[filters][1][field]=id&filter[filters][1][operator]=eq&filter[filters][1][value]=338040 HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "total": "2",
        "data": [
            {
                "user_id": "338040",
                "cluster": "16"
            },
            {
                "user_id": "338041",
                "cluster": "3"
            }
        ]
    }
}

Create new meta data entry for user or item and specify if it will be used for the recommender and date it got added
Admin users only

Authorization Bearer {{recommender_api_jwt}}
Content-Type application/json
version v3.0 (Optional) The API version 
curl -X POST -H "Authorization: Bearer {{recommender_api_jwt}}" -H "Content-Type: application/json" -d '{
    "action" : "create",
    "type" : "user",
    "meta_data": {
        "id": {
          "value" : 1,
          "date_created" : "2018-04-24 14:15:00"
        }
  }
}
' "{{recommender-api-url}}/data/meta_data?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/data/meta_data?version=v3.0 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Content-Type: application/json

{
    "action" : "create",
    "type" : "user",
    "meta_data": {
        "id": {
          "value" : 1,
          "date_created" : "2018-04-24 14:15:00"
        }
  }
}

Create new meta data entry for user or item and specify if it will be used for the recommender and date it got added
Admin users only

Authorization Bearer {{recommender_api_jwt}}
Content-Type application/json
version v3.0 (Optional) The API version
user_ids[] 1 An array of user id's to be deleted
user_ids[] 2 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Bearer {{recommender_api_jwt}}" -H "Content-Type: application/json" -d "user_ids[]=1&user_ids[]=2" "{{recommender-api-url}}/data/user-delete?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/data/user-delete?version=v3.0 HTTP/1.1
Host:
Authorization: Bearer {{recommender_api_jwt}}
Content-Type: application/json
Content-Type: application/x-www-form-urlencoded

user_ids[]=1&user_ids[]=2