Login
Recommender API v3.0

General notes

API detail

Application 3

This endpoint retrieves applications based on the specified search term, and pagination parameters.

version v3.0 (Optional) The API version
query {search term} (Optional) Search Term
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}}/application?version=v3.0&query={search term}&take=10&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/application?version=v3.0&query={search term}&take=10&skip=0 HTTP/1.1
Host:

This endpoint retrieves the model accuracy for a specific application.

version v3.0 (Optional) The API version
application_id 25 (Optional) The Application ID - Will use Token application if this is empty 
curl -X GET "{{recommender-api-url}}/application/model-accuracy?version=v3.0&application_id=25"
GET %7B%7Brecommender-api-url%7D%7D/application/model-accuracy?version=v3.0&application_id=25 HTTP/1.1
Host:

This endpoint retrieves information about the application stored in the JWT token.

version v3.0 (Optional) The API version 
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:
Auth 10

This endpoint is used to register a new user.

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 johndoe@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=johndoe@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=johndoe@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

This endpoint is used to log in a user.

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
    }
}

This endpoint is used to send the 2FA code to the API to authenticate the user trying to log in.

Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version
verification_code {verification_code} (Required) The verification code sent to your email 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "verification_code={verification_code}" "{{recommender-api-url}}/auth2fa?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/auth2fa?version=v3.0 HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Content-Type: application/x-www-form-urlencoded

verification_code={verification_code}
Status400 Bad Request
Content-Typeapplication/json
{
    "status_code": 400,
    "error": {
        "message": "Validation link has expired",
        "code": 302
    }
}
Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" "{{recommender-api-url}}/auth2fa/resend?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/auth2fa/resend?version=v3.0 HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Status400 Bad Request
Content-Typeapplication/json
{
    "status_code": 400,
    "error": {
        "message": "Validation link has expired",
        "code": 302
    }
}
Content-Type application/x-www-form-urlencoded
version v3.0 The API version (optional)
activation_code {activation_code} (Required) Activation code sent to users email 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Content-Type: application/x-www-form-urlencoded" -d "activation_code={activation_code}" "{{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={activation_code}
Content-Type application/x-www-form-urlencoded
version v3.0 The API version (optional)
email johndoe123@gmail.com (Required) Email to verify 
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 (Required) Users new password
token {{reset-password-jwt-token}} (Required) The JWT token from the users email 
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}}

Validates the Bearer token sent 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

Refresh the Bearer token sent 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}}/refresh?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/refresh?version=v3.0 HTTP/1.1
Host: 
Authorization: Bearer  {{recommender_api_jwt}}
Content-Type: application/x-www-form-urlencoded
Billing 9
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:
Charts 3
version v3.0 (Optional) The API version
kpi {{kpi}} (Required) KPI of the graph. 'sales' | 'profit' | 'profit_margin' | 'quantity' | 'transactions' | 'average_transaction' | 'units_per_transaction' or ['sales', 'profit']
key[] profit (Optional) Sum for KPI. ['sales', 'profit']
format absolute (Required) Format of the graph. 'absolute'|'perc_share'|'yoy'|'yoy_lfl'
group_by {{kpi_group_by}} (Required) Grouping of the graph. 'item_segment'|'user_segment'|'location_segment'|'category_hierarchy'|'location_hierarchy'|'campaigns'|'date'|'widget'|'kpi'|'locations'|'categories'
interval_type {{kpi_interval_type}} (Required) Interval Type Used. 'monthly' | 'quarterly' | 'yearly' | 'weekly'|'custom'|'daily'
start_date {{kpi_start_date}} (Optional) Time interval in year '2016' | year + month number '201608' | year + quarter number '20162' | year + week number '201622' | year + month number + day number '20170410'
end_date {{kpi_end_date}} (Optional) Time interval in year '2016' | year + month number '201608' | year + quarter number '20162' | year + week number '201622' | year + month number + day number '20170410'
value_ids[] {{value_ids}} (Optional) Value Ids array
overlays[] {{overlays_1}} (Optional) Campaign Ids array to overlay if / when campaigns ran in a period
campaign_ids[] 5 (Optional) Campaign Ids array
location_ids[] {{location_ids}} (Optional) Location Ids array
location_ids[] 895 (Optional) Location Ids array
item_segments[] {{kpi_item_segments_1}} (Optional) Item Segments array
item_segments[] {{kpi_item_segments_2}} (Optional) Item Segments array
user_segments[] {{kpi_user_segments_1}} (Optional) User Segments array
user_segments[] {{kpi_user_segments_2}} (Optional) User Segments array
location_segments[] 1 (Optional) Location Segments array
widget_type {{widget_type}} (Optional) Grouping by widget type. 'campaigns' | 'locations' | 'categories' |'user_segments' | 'item_segments' | 'location_segments'
skip {{skip}} (Optional) Number of results to skip
take {{take}} (Optional) Number of results returned - Default = '10' 
curl -X GET "{{recommender-api-url}}/charts/kpi-data?version=v3.0&kpi={{kpi}}&format=absolute&group_by={{kpi_group_by}}&interval_type={{kpi_interval_type}}&start_date={{kpi_start_date}}&end_date={{kpi_end_date}}&overlays[]={{overlays_1}}&item_segments[]={{kpi_item_segments_1}}&item_segments[]={{kpi_item_segments_2}}&skip={{skip}}&take={{take}}"
GET %7B%7Brecommender-api-url%7D%7D/charts/kpi-data?version=v3.0&kpi={{kpi}}&format=absolute&group_by={{kpi_group_by}}&interval_type={{kpi_interval_type}}&start_date={{kpi_start_date}}&end_date={{kpi_end_date}}&overlays[]={{overlays_1}}&item_segments[]={{kpi_item_segments_1}}&item_segments[]={{kpi_item_segments_2}}&skip={{skip}}&take={{take}} HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "201209": {
            "interval": "201209",
            "series": {
                "user_segment_1": 5164585.97,
                "user_segment_2": 1670578.71,
                "user_segment_3": 5979016.63,
                "user_segment_4": 14533506.67,
                "user_segment_5": 9155214.59,
                "user_segment_6": 13037712.67
            }
        },
        "201210": {
            "interval": "201210",
            "series": {
                "user_segment_1": 5540023.83,
                "user_segment_2": 5131998.29,
                "user_segment_3": 6611917.06,
                "user_segment_4": 21822483.9,
                "user_segment_5": 12308672.62,
                "user_segment_6": 13424466.76
            }
        },
        "201211": {
            "interval": "201211",
            "series": {
                "user_segment_1": 4773252.07,
                "user_segment_2": 3407713.98,
                "user_segment_3": 7862240.9,
                "user_segment_4": 21781810.55,
                "user_segment_5": 13791517.28,
                "user_segment_6": 16677036.34
            }
        },
        "201212": {
            "interval": "201212",
            "series": {
                "user_segment_1": 2975140.46,
                "user_segment_2": 1731867.42,
                "user_segment_3": 3858366.17,
                "user_segment_4": 12222129.87,
                "user_segment_5": 9071645.86,
                "user_segment_6": 9057344.47
            }
        },
        "201301": {
            "interval": "201301",
            "series": {
                "user_segment_1": 2290268.05,
                "user_segment_2": 1231976.22,
                "user_segment_3": 4367058.65,
                "user_segment_4": 9957573.47,
                "user_segment_5": 7418715.55,
                "user_segment_6": 8017282.01
            }
        },
        "201302": {
            "interval": "201302",
            "series": {
                "user_segment_1": 3618771.46,
                "user_segment_2": 2411168.85,
                "user_segment_3": 6467663.75,
                "user_segment_4": 14755072.55,
                "user_segment_5": 9306493.65,
                "user_segment_6": 12579362.91
            }
        },
        "201303": {
            "interval": "201303",
            "series": {
                "user_segment_1": 4746931.37,
                "user_segment_2": 2724760.29,
                "user_segment_3": 8587713.17,
                "user_segment_4": 16261216.29,
                "user_segment_5": 12571052.93,
                "user_segment_6": 14249627.11
            }
        },
        "201304": {
            "interval": "201304",
            "series": {
                "user_segment_1": 4975628.27,
                "user_segment_2": 3730714.72,
                "user_segment_3": 8557592.62,
                "user_segment_4": 17844358.52,
                "user_segment_5": 13072365.27,
                "user_segment_6": 16440970.66
            }
        },
        "201305": {
            "interval": "201305",
            "series": {
                "user_segment_1": 5417650.42,
                "user_segment_2": 3754624.8,
                "user_segment_3": 8650606.11,
                "user_segment_4": 23354073.68,
                "user_segment_5": 13148027.24,
                "user_segment_6": 19299930.2
            }
        },
        "201306": {
            "interval": "201306",
            "series": {
                "user_segment_1": 4286991.09,
                "user_segment_2": 2748305.07,
                "user_segment_3": 7183413.89,
                "user_segment_4": 17406502.5,
                "user_segment_5": 11767575.38,
                "user_segment_6": 13822122.17
            }
        },
        "201307": {
            "interval": "201307",
            "series": {
                "user_segment_1": 4309513.37,
                "user_segment_2": 2016391.39,
                "user_segment_3": 9250600.1,
                "user_segment_4": 17467566.16,
                "user_segment_5": 11866029.05,
                "user_segment_6": 14542926.94
            }
        },
        "201308": {
            "interval": "201308",
            "series": {
                "user_segment_1": 4127361.03,
                "user_segment_2": 2390360.35,
                "user_segment_3": 7383616.7,
                "user_segment_4": 17200849.56,
                "user_segment_5": 11537047.62,
                "user_segment_6": 11002046.51
            }
        },
        "201309": {
            "interval": "201309",
            "series": {
                "user_segment_1": 10427762.84,
                "user_segment_2": 2437813.85,
                "user_segment_3": 6872518.88,
                "user_segment_4": 17003271.87,
                "user_segment_5": 11096889.9,
                "user_segment_6": 10715592.08
            }
        },
        "201310": {
            "interval": "201310",
            "series": {
                "user_segment_1": 4729156.17,
                "user_segment_2": 3203629.66,
                "user_segment_3": 8367512.34,
                "user_segment_4": 19529787.5,
                "user_segment_5": 13175744.96,
                "user_segment_6": 12772312.16
            }
        },
        "201311": {
            "interval": "201311",
            "series": {
                "user_segment_1": 4757226.79,
                "user_segment_2": 3728630.8,
                "user_segment_3": 10000532.78,
                "user_segment_4": 23156616.78,
                "user_segment_5": 13528491.75,
                "user_segment_6": 12819497.39
            }
        },
        "201312": {
            "interval": "201312",
            "series": {
                "user_segment_1": 3141523.57,
                "user_segment_2": 1682322.11,
                "user_segment_3": 6440485.79,
                "user_segment_4": 12630875.5,
                "user_segment_5": 7377291.64,
                "user_segment_6": 6749668.32
            }
        },
        "201401": {
            "interval": "201401",
            "series": {
                "user_segment_1": 2438692.49,
                "user_segment_2": 1409729.83,
                "user_segment_3": 6664889.49,
                "user_segment_4": 10139191.1,
                "user_segment_5": 8593474.37,
                "user_segment_6": 7266814.89
            }
        },
        "201402": {
            "interval": "201402",
            "series": {
                "user_segment_1": 3601014.26,
                "user_segment_2": 2611584.36,
                "user_segment_3": 8782846.27,
                "user_segment_4": 12585970.24,
                "user_segment_5": 12239847.07,
                "user_segment_6": 10241778.99
            }
        },
        "201403": {
            "interval": "201403",
            "series": {
                "user_segment_1": 4117361.23,
                "user_segment_2": 2491097.16,
                "user_segment_3": 13754901.24,
                "user_segment_4": 14280204.04,
                "user_segment_5": 15268777.47,
                "user_segment_6": 12001421.84
            }
        },
        "201404": {
            "interval": "201404",
            "series": {
                "user_segment_1": 3629822.25,
                "user_segment_2": 3095377.2,
                "user_segment_3": 9864446.81,
                "user_segment_4": 14845533.24,
                "user_segment_5": 12737553.89,
                "user_segment_6": 10995522.14
            }
        },
        "201405": {
            "interval": "201405",
            "series": {
                "user_segment_1": 4184090.43,
                "user_segment_2": 2932444.25,
                "user_segment_3": 12532230.62,
                "user_segment_4": 15584633.57,
                "user_segment_5": 19796430.23,
                "user_segment_6": 12614014.56
            }
        },
        "201406": {
            "interval": "201406",
            "series": {
                "user_segment_1": 4471134.09,
                "user_segment_2": 3132924.85,
                "user_segment_3": 11527897.72,
                "user_segment_4": 15546886.18,
                "user_segment_5": 15766401.3,
                "user_segment_6": 13117050
            }
        },
        "201407": {
            "interval": "201407",
            "series": {
                "user_segment_1": 4904109.46,
                "user_segment_2": 3523788.21,
                "user_segment_3": 9878843.53,
                "user_segment_4": 18075888.03,
                "user_segment_5": 17495506.85,
                "user_segment_6": 12170939.26
            }
        },
        "201408": {
            "interval": "201408",
            "series": {
                "user_segment_1": 4895733.2,
                "user_segment_2": 3021263.99,
                "user_segment_3": 9849104.69,
                "user_segment_4": 18230495.46,
                "user_segment_5": 15816949.86,
                "user_segment_6": 10111760.11
            }
        },
        "201409": {
            "interval": "201409",
            "series": {
                "user_segment_1": 4448831.97,
                "user_segment_2": 4703947.92,
                "user_segment_3": 14113237.43,
                "user_segment_4": 17132945.66,
                "user_segment_5": 18037149.58,
                "user_segment_6": 11666466.39
            }
        },
        "201410": {
            "interval": "201410",
            "series": {
                "user_segment_1": 4761001.15,
                "user_segment_2": 5055723.1,
                "user_segment_3": 12331901.89,
                "user_segment_4": 19682342.1,
                "user_segment_5": 20960601,
                "user_segment_6": 14096993.37
            }
        },
        "201411": {
            "interval": "201411",
            "series": {
                "user_segment_1": 4590518.96,
                "user_segment_2": 4412956.12,
                "user_segment_3": 11996528.89,
                "user_segment_4": 18665302.4,
                "user_segment_5": 21001817.56,
                "user_segment_6": 12638254.59
            }
        },
        "201412": {
            "interval": "201412",
            "series": {
                "user_segment_1": 3462610.45,
                "user_segment_2": 4259481.95,
                "user_segment_3": 7416426.54,
                "user_segment_4": 13093393.48,
                "user_segment_5": 12925803.58,
                "user_segment_6": 7985099.44
            }
        },
        "201501": {
            "interval": "201501",
            "series": {
                "user_segment_1": 2121164.12,
                "user_segment_2": 1859243.46,
                "user_segment_3": 6977750.88,
                "user_segment_4": 8133146.98,
                "user_segment_5": 12478199.17,
                "user_segment_6": 6294457.32
            }
        },
        "201502": {
            "interval": "201502",
            "series": {
                "user_segment_1": 4107978.66,
                "user_segment_2": 3692304.01,
                "user_segment_3": 11447541.52,
                "user_segment_4": 14016050.39,
                "user_segment_5": 16460545.82,
                "user_segment_6": 11569062.58
            }
        },
        "201503": {
            "interval": "201503",
            "series": {
                "user_segment_1": 5861255.95,
                "user_segment_2": 5222599.93,
                "user_segment_3": 15439798.84,
                "user_segment_4": 17392007.98,
                "user_segment_5": 22039813.48,
                "user_segment_6": 14458078.6
            }
        },
        "201504": {
            "interval": "201504",
            "series": {
                "user_segment_1": 4762413.44,
                "user_segment_2": 4984435.88,
                "user_segment_3": 13022681.79,
                "user_segment_4": 14845231.47,
                "user_segment_5": 22194164.59,
                "user_segment_6": 12295353.18
            }
        },
        "201505": {
            "interval": "201505",
            "series": {
                "user_segment_1": 4651465.14,
                "user_segment_2": 5584066.99,
                "user_segment_3": 12977214.71,
                "user_segment_4": 14818525.93,
                "user_segment_5": 22486243.9,
                "user_segment_6": 14193068.89
            }
        },
        "201506": {
            "interval": "201506",
            "series": {
                "user_segment_1": 5305322.64,
                "user_segment_2": 5538335.22,
                "user_segment_3": 14078363.06,
                "user_segment_4": 17530731.24,
                "user_segment_5": 24286088.34,
                "user_segment_6": 15812543.75
            }
        },
        "201507": {
            "interval": "201507",
            "series": {
                "user_segment_1": 5373147.07,
                "user_segment_2": 5894609.92,
                "user_segment_3": 15781988.33,
                "user_segment_4": 20200946.7,
                "user_segment_5": 22043670.66,
                "user_segment_6": 14006289.05
            }
        },
        "201508": {
            "interval": "201508",
            "series": {
                "user_segment_1": 4486876.01,
                "user_segment_2": 6072423.91,
                "user_segment_3": 11097706.61,
                "user_segment_4": 15145611.42,
                "user_segment_5": 19858070.05,
                "user_segment_6": 10666746.11
            }
        },
        "201509": {
            "interval": "201509",
            "series": {
                "user_segment_1": 4263703.63,
                "user_segment_2": 7015816.05,
                "user_segment_3": 12563890.93,
                "user_segment_4": 15206352.46,
                "user_segment_5": 21306277.81,
                "user_segment_6": 11039320.93
            }
        },
        "201510": {
            "interval": "201510",
            "series": {
                "user_segment_1": 3853590.65,
                "user_segment_2": 5180217.23,
                "user_segment_3": 11314839.55,
                "user_segment_4": 14480225.54,
                "user_segment_5": 24227979.8,
                "user_segment_6": 13145836.51
            }
        },
        "201511": {
            "interval": "201511",
            "series": {
                "user_segment_1": 4253209.56,
                "user_segment_2": 6966037.96,
                "user_segment_3": 13639270.66,
                "user_segment_4": 18213933.57,
                "user_segment_5": 25086411.01,
                "user_segment_6": 12671785.89
            }
        },
        "201512": {
            "interval": "201512",
            "series": {
                "user_segment_1": 2984184.95,
                "user_segment_2": 5400161.2,
                "user_segment_3": 6392335.28,
                "user_segment_4": 14178937.21,
                "user_segment_5": 15271040.55,
                "user_segment_6": 6662526.71
            }
        },
        "201601": {
            "interval": "201601",
            "series": {
                "user_segment_1": 2247111.62,
                "user_segment_2": 4002009.51,
                "user_segment_3": 6897538.28,
                "user_segment_4": 7898838.13,
                "user_segment_5": 16268431.92,
                "user_segment_6": 7522873.24
            }
        },
        "201602": {
            "interval": "201602",
            "series": {
                "user_segment_1": 4261209.14,
                "user_segment_2": 7446151.1,
                "user_segment_3": 14225872.06,
                "user_segment_4": 14352871.78,
                "user_segment_5": 27445705.36,
                "user_segment_6": 12857389.39
            }
        },
        "201603": {
            "interval": "201603",
            "series": {
                "user_segment_1": 4904033.71,
                "user_segment_2": 9167600.57,
                "user_segment_3": 16899762.5,
                "user_segment_4": 13907096.28,
                "user_segment_5": 29271072.49,
                "user_segment_6": 12383853.89
            }
        },
        "201604": {
            "interval": "201604",
            "series": {
                "user_segment_1": 4901032.44,
                "user_segment_2": 12089835.13,
                "user_segment_3": 13565993.46,
                "user_segment_4": 16985161.69,
                "user_segment_5": 34093044.39,
                "user_segment_6": 13859007.99
            }
        },
        "201605": {
            "interval": "201605",
            "series": {
                "user_segment_1": 4444778.7,
                "user_segment_2": 13351236.27,
                "user_segment_3": 14613848.79,
                "user_segment_4": 15356486.34,
                "user_segment_5": 37017448.47,
                "user_segment_6": 14293291.29
            }
        },
        "201606": {
            "interval": "201606",
            "series": {
                "user_segment_1": 4499131.14,
                "user_segment_2": 14719246.03,
                "user_segment_3": 15457085.74,
                "user_segment_4": 17965557.67,
                "user_segment_5": 33364558.28,
                "user_segment_6": 14849541.28
            }
        },
        "201607": {
            "interval": "201607",
            "series": {
                "user_segment_1": 3550091.46,
                "user_segment_2": 10702363.98,
                "user_segment_3": 11271776.67,
                "user_segment_4": 12983558.05,
                "user_segment_5": 34894070.03,
                "user_segment_6": 11518098.07
            }
        },
        "201608": {
            "interval": "201608",
            "series": {
                "user_segment_1": 3339631.13,
                "user_segment_2": 12909470.15,
                "user_segment_3": 12975584.47,
                "user_segment_4": 12749843.89,
                "user_segment_5": 48919866.18,
                "user_segment_6": 9142043.21
            }
        },
        "201609": {
            "interval": "201609",
            "series": {
                "user_segment_1": 7931364.96,
                "user_segment_2": 11653816.65,
                "user_segment_3": 13604765.56,
                "user_segment_4": 13633584.4,
                "user_segment_5": 35728400.7,
                "user_segment_6": 10948145.02
            }
        },
        "201610": {
            "interval": "201610",
            "series": {
                "user_segment_1": 3563658.36,
                "user_segment_2": 10476119.75,
                "user_segment_3": 14190888.97,
                "user_segment_4": 12622210.73,
                "user_segment_5": 34032527.2,
                "user_segment_6": 10927459.73
            }
        },
        "201611": {
            "interval": "201611",
            "series": {
                "user_segment_1": 3739989.21,
                "user_segment_2": 13126117.27,
                "user_segment_3": 14555301.77,
                "user_segment_4": 14492619.66,
                "user_segment_5": 43493036.56,
                "user_segment_6": 12550124.06
            }
        },
        "201612": {
            "interval": "201612",
            "series": {
                "user_segment_1": 2072864.42,
                "user_segment_2": 8198914.12,
                "user_segment_3": 9119755.66,
                "user_segment_4": 8228822.48,
                "user_segment_5": 22683855.04,
                "user_segment_6": 6645589.92
            }
        },
        "201701": {
            "interval": "201701",
            "series": {
                "user_segment_1": 1711492.82,
                "user_segment_2": 7026350.71,
                "user_segment_3": 8348047.08,
                "user_segment_4": 7121179.11,
                "user_segment_5": 22478596.35,
                "user_segment_6": 7112278.62
            }
        }
    }
}
version v3.0
kpi sales (Required) KPI of the graph. 'sales' | 'profit' | 'profit_margin' | 'quantity' or ['sales', 'profit']
group_by item_segment (Required) Grouping of the graph. 'item_segment'|'user_segment'|'location_segment'|'campaigns'| 'locations'| 'categories'|'date'|'widget'
interval_type yearly (Required) Interval Type Used. 'monthly' | 'quarterly' | 'yearly' | 'weekly'
start_date 2012 (Optional) Time interval in year '2016'
end_date 2015 (Optional) Time interval in year '2016'
intervals[] 1 (Optional) Intervals array. Quarter number [1 - 4], month number [1 -12], week number [1- 53]
intervals[] 2
user_segments[] 2 (Optional) User Segments array
user_segments[] 6
item_segments[] 2 (Optional) Item Segments array
item_segments[] 4
location_segments[] 1 (Optional) Location Segments array
compare_type lfl (Optional) Compare Type. 'lfl' | 'yoy'
widget_type item_segments (Optional) Grouping by widget type. 'campaigns' | 'locations' | 'categories' |'user_segments' | 'item_segments' 
curl -X GET "{{recommender-api-url}}/charts/kpi-compare/?version=v3.0&kpi=sales&group_by=item_segment&interval_type=yearly&start_date=2012&end_date=2015&intervals[]=1&intervals[]=2&user_segments[]=2&user_segments[]=6&item_segments[]=2&item_segments[]=4&location_segments[]=1&compare_type=lfl&widget_type=item_segments"
GET %7B%7Brecommender-api-url%7D%7D/charts/kpi-compare/?version=v3.0&kpi=sales&group_by=item_segment&interval_type=yearly&start_date=2012&end_date=2015&intervals[]=1&intervals[]=2&user_segments[]=2&user_segments[]=6&item_segments[]=2&item_segments[]=4&location_segments[]=1&compare_type=lfl&widget_type=item_segments HTTP/1.1
Host:
version v3.0 (Optional) The API version
interval_type weekly (Required) Interval Type Used. 'monthly' | 'quarterly' | 'yearly' | 'weekly'|'custom'
start_date 201806 (Optional) Time interval in year '2016' | year + month number '201608' | year + quarter number '20162' | year + week number '201622'
end_date 201810 (Optional) Time interval in year '2016' | year + month number '201608' | year + quarter number '20162' | year + week number '201622'
value_ids[] 281305 (Optional) Value Ids array
campaign_ids[] 5 (Optional) Campaign Ids array
location_ids[] 112 (Optional) Location Ids array
location_ids[] 895 (Optional) Location Ids array
item_segments[] 11 (Optional) Item Segments array
item_segments[] 10 (Optional) Item Segments array
user_segments[] 2 (Optional) User Segments array
user_segments[] 3 (Optional) User Segments array
location_segments[] 1 (Optional) Location Segments array
group_by widget
widget_type categories
value_ids[] 260335 
curl -X GET "{{recommender-api-url}}/charts/demand-forecasts?version=v3.0&interval_type=weekly&start_date=201806&end_date=201810&location_ids[]=112&group_by=widget&widget_type=categories"
GET %7B%7Brecommender-api-url%7D%7D/charts/demand-forecasts?version=v3.0&interval_type=weekly&start_date=201806&end_date=201810&location_ids[]=112&group_by=widget&widget_type=categories HTTP/1.1
Host:
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "response": {
        "201209": {
            "interval": "201209",
            "series": {
                "user_segment_1": 5164585.97,
                "user_segment_2": 1670578.71,
                "user_segment_3": 5979016.63,
                "user_segment_4": 14533506.67,
                "user_segment_5": 9155214.59,
                "user_segment_6": 13037712.67
            }
        },
        "201210": {
            "interval": "201210",
            "series": {
                "user_segment_1": 5540023.83,
                "user_segment_2": 5131998.29,
                "user_segment_3": 6611917.06,
                "user_segment_4": 21822483.9,
                "user_segment_5": 12308672.62,
                "user_segment_6": 13424466.76
            }
        },
        "201211": {
            "interval": "201211",
            "series": {
                "user_segment_1": 4773252.07,
                "user_segment_2": 3407713.98,
                "user_segment_3": 7862240.9,
                "user_segment_4": 21781810.55,
                "user_segment_5": 13791517.28,
                "user_segment_6": 16677036.34
            }
        },
        "201212": {
            "interval": "201212",
            "series": {
                "user_segment_1": 2975140.46,
                "user_segment_2": 1731867.42,
                "user_segment_3": 3858366.17,
                "user_segment_4": 12222129.87,
                "user_segment_5": 9071645.86,
                "user_segment_6": 9057344.47
            }
        },
        "201301": {
            "interval": "201301",
            "series": {
                "user_segment_1": 2290268.05,
                "user_segment_2": 1231976.22,
                "user_segment_3": 4367058.65,
                "user_segment_4": 9957573.47,
                "user_segment_5": 7418715.55,
                "user_segment_6": 8017282.01
            }
        },
        "201302": {
            "interval": "201302",
            "series": {
                "user_segment_1": 3618771.46,
                "user_segment_2": 2411168.85,
                "user_segment_3": 6467663.75,
                "user_segment_4": 14755072.55,
                "user_segment_5": 9306493.65,
                "user_segment_6": 12579362.91
            }
        },
        "201303": {
            "interval": "201303",
            "series": {
                "user_segment_1": 4746931.37,
                "user_segment_2": 2724760.29,
                "user_segment_3": 8587713.17,
                "user_segment_4": 16261216.29,
                "user_segment_5": 12571052.93,
                "user_segment_6": 14249627.11
            }
        },
        "201304": {
            "interval": "201304",
            "series": {
                "user_segment_1": 4975628.27,
                "user_segment_2": 3730714.72,
                "user_segment_3": 8557592.62,
                "user_segment_4": 17844358.52,
                "user_segment_5": 13072365.27,
                "user_segment_6": 16440970.66
            }
        },
        "201305": {
            "interval": "201305",
            "series": {
                "user_segment_1": 5417650.42,
                "user_segment_2": 3754624.8,
                "user_segment_3": 8650606.11,
                "user_segment_4": 23354073.68,
                "user_segment_5": 13148027.24,
                "user_segment_6": 19299930.2
            }
        },
        "201306": {
            "interval": "201306",
            "series": {
                "user_segment_1": 4286991.09,
                "user_segment_2": 2748305.07,
                "user_segment_3": 7183413.89,
                "user_segment_4": 17406502.5,
                "user_segment_5": 11767575.38,
                "user_segment_6": 13822122.17
            }
        },
        "201307": {
            "interval": "201307",
            "series": {
                "user_segment_1": 4309513.37,
                "user_segment_2": 2016391.39,
                "user_segment_3": 9250600.1,
                "user_segment_4": 17467566.16,
                "user_segment_5": 11866029.05,
                "user_segment_6": 14542926.94
            }
        },
        "201308": {
            "interval": "201308",
            "series": {
                "user_segment_1": 4127361.03,
                "user_segment_2": 2390360.35,
                "user_segment_3": 7383616.7,
                "user_segment_4": 17200849.56,
                "user_segment_5": 11537047.62,
                "user_segment_6": 11002046.51
            }
        },
        "201309": {
            "interval": "201309",
            "series": {
                "user_segment_1": 10427762.84,
                "user_segment_2": 2437813.85,
                "user_segment_3": 6872518.88,
                "user_segment_4": 17003271.87,
                "user_segment_5": 11096889.9,
                "user_segment_6": 10715592.08
            }
        },
        "201310": {
            "interval": "201310",
            "series": {
                "user_segment_1": 4729156.17,
                "user_segment_2": 3203629.66,
                "user_segment_3": 8367512.34,
                "user_segment_4": 19529787.5,
                "user_segment_5": 13175744.96,
                "user_segment_6": 12772312.16
            }
        },
        "201311": {
            "interval": "201311",
            "series": {
                "user_segment_1": 4757226.79,
                "user_segment_2": 3728630.8,
                "user_segment_3": 10000532.78,
                "user_segment_4": 23156616.78,
                "user_segment_5": 13528491.75,
                "user_segment_6": 12819497.39
            }
        },
        "201312": {
            "interval": "201312",
            "series": {
                "user_segment_1": 3141523.57,
                "user_segment_2": 1682322.11,
                "user_segment_3": 6440485.79,
                "user_segment_4": 12630875.5,
                "user_segment_5": 7377291.64,
                "user_segment_6": 6749668.32
            }
        },
        "201401": {
            "interval": "201401",
            "series": {
                "user_segment_1": 2438692.49,
                "user_segment_2": 1409729.83,
                "user_segment_3": 6664889.49,
                "user_segment_4": 10139191.1,
                "user_segment_5": 8593474.37,
                "user_segment_6": 7266814.89
            }
        },
        "201402": {
            "interval": "201402",
            "series": {
                "user_segment_1": 3601014.26,
                "user_segment_2": 2611584.36,
                "user_segment_3": 8782846.27,
                "user_segment_4": 12585970.24,
                "user_segment_5": 12239847.07,
                "user_segment_6": 10241778.99
            }
        },
        "201403": {
            "interval": "201403",
            "series": {
                "user_segment_1": 4117361.23,
                "user_segment_2": 2491097.16,
                "user_segment_3": 13754901.24,
                "user_segment_4": 14280204.04,
                "user_segment_5": 15268777.47,
                "user_segment_6": 12001421.84
            }
        },
        "201404": {
            "interval": "201404",
            "series": {
                "user_segment_1": 3629822.25,
                "user_segment_2": 3095377.2,
                "user_segment_3": 9864446.81,
                "user_segment_4": 14845533.24,
                "user_segment_5": 12737553.89,
                "user_segment_6": 10995522.14
            }
        },
        "201405": {
            "interval": "201405",
            "series": {
                "user_segment_1": 4184090.43,
                "user_segment_2": 2932444.25,
                "user_segment_3": 12532230.62,
                "user_segment_4": 15584633.57,
                "user_segment_5": 19796430.23,
                "user_segment_6": 12614014.56
            }
        },
        "201406": {
            "interval": "201406",
            "series": {
                "user_segment_1": 4471134.09,
                "user_segment_2": 3132924.85,
                "user_segment_3": 11527897.72,
                "user_segment_4": 15546886.18,
                "user_segment_5": 15766401.3,
                "user_segment_6": 13117050
            }
        },
        "201407": {
            "interval": "201407",
            "series": {
                "user_segment_1": 4904109.46,
                "user_segment_2": 3523788.21,
                "user_segment_3": 9878843.53,
                "user_segment_4": 18075888.03,
                "user_segment_5": 17495506.85,
                "user_segment_6": 12170939.26
            }
        },
        "201408": {
            "interval": "201408",
            "series": {
                "user_segment_1": 4895733.2,
                "user_segment_2": 3021263.99,
                "user_segment_3": 9849104.69,
                "user_segment_4": 18230495.46,
                "user_segment_5": 15816949.86,
                "user_segment_6": 10111760.11
            }
        },
        "201409": {
            "interval": "201409",
            "series": {
                "user_segment_1": 4448831.97,
                "user_segment_2": 4703947.92,
                "user_segment_3": 14113237.43,
                "user_segment_4": 17132945.66,
                "user_segment_5": 18037149.58,
                "user_segment_6": 11666466.39
            }
        },
        "201410": {
            "interval": "201410",
            "series": {
                "user_segment_1": 4761001.15,
                "user_segment_2": 5055723.1,
                "user_segment_3": 12331901.89,
                "user_segment_4": 19682342.1,
                "user_segment_5": 20960601,
                "user_segment_6": 14096993.37
            }
        },
        "201411": {
            "interval": "201411",
            "series": {
                "user_segment_1": 4590518.96,
                "user_segment_2": 4412956.12,
                "user_segment_3": 11996528.89,
                "user_segment_4": 18665302.4,
                "user_segment_5": 21001817.56,
                "user_segment_6": 12638254.59
            }
        },
        "201412": {
            "interval": "201412",
            "series": {
                "user_segment_1": 3462610.45,
                "user_segment_2": 4259481.95,
                "user_segment_3": 7416426.54,
                "user_segment_4": 13093393.48,
                "user_segment_5": 12925803.58,
                "user_segment_6": 7985099.44
            }
        },
        "201501": {
            "interval": "201501",
            "series": {
                "user_segment_1": 2121164.12,
                "user_segment_2": 1859243.46,
                "user_segment_3": 6977750.88,
                "user_segment_4": 8133146.98,
                "user_segment_5": 12478199.17,
                "user_segment_6": 6294457.32
            }
        },
        "201502": {
            "interval": "201502",
            "series": {
                "user_segment_1": 4107978.66,
                "user_segment_2": 3692304.01,
                "user_segment_3": 11447541.52,
                "user_segment_4": 14016050.39,
                "user_segment_5": 16460545.82,
                "user_segment_6": 11569062.58
            }
        },
        "201503": {
            "interval": "201503",
            "series": {
                "user_segment_1": 5861255.95,
                "user_segment_2": 5222599.93,
                "user_segment_3": 15439798.84,
                "user_segment_4": 17392007.98,
                "user_segment_5": 22039813.48,
                "user_segment_6": 14458078.6
            }
        },
        "201504": {
            "interval": "201504",
            "series": {
                "user_segment_1": 4762413.44,
                "user_segment_2": 4984435.88,
                "user_segment_3": 13022681.79,
                "user_segment_4": 14845231.47,
                "user_segment_5": 22194164.59,
                "user_segment_6": 12295353.18
            }
        },
        "201505": {
            "interval": "201505",
            "series": {
                "user_segment_1": 4651465.14,
                "user_segment_2": 5584066.99,
                "user_segment_3": 12977214.71,
                "user_segment_4": 14818525.93,
                "user_segment_5": 22486243.9,
                "user_segment_6": 14193068.89
            }
        },
        "201506": {
            "interval": "201506",
            "series": {
                "user_segment_1": 5305322.64,
                "user_segment_2": 5538335.22,
                "user_segment_3": 14078363.06,
                "user_segment_4": 17530731.24,
                "user_segment_5": 24286088.34,
                "user_segment_6": 15812543.75
            }
        },
        "201507": {
            "interval": "201507",
            "series": {
                "user_segment_1": 5373147.07,
                "user_segment_2": 5894609.92,
                "user_segment_3": 15781988.33,
                "user_segment_4": 20200946.7,
                "user_segment_5": 22043670.66,
                "user_segment_6": 14006289.05
            }
        },
        "201508": {
            "interval": "201508",
            "series": {
                "user_segment_1": 4486876.01,
                "user_segment_2": 6072423.91,
                "user_segment_3": 11097706.61,
                "user_segment_4": 15145611.42,
                "user_segment_5": 19858070.05,
                "user_segment_6": 10666746.11
            }
        },
        "201509": {
            "interval": "201509",
            "series": {
                "user_segment_1": 4263703.63,
                "user_segment_2": 7015816.05,
                "user_segment_3": 12563890.93,
                "user_segment_4": 15206352.46,
                "user_segment_5": 21306277.81,
                "user_segment_6": 11039320.93
            }
        },
        "201510": {
            "interval": "201510",
            "series": {
                "user_segment_1": 3853590.65,
                "user_segment_2": 5180217.23,
                "user_segment_3": 11314839.55,
                "user_segment_4": 14480225.54,
                "user_segment_5": 24227979.8,
                "user_segment_6": 13145836.51
            }
        },
        "201511": {
            "interval": "201511",
            "series": {
                "user_segment_1": 4253209.56,
                "user_segment_2": 6966037.96,
                "user_segment_3": 13639270.66,
                "user_segment_4": 18213933.57,
                "user_segment_5": 25086411.01,
                "user_segment_6": 12671785.89
            }
        },
        "201512": {
            "interval": "201512",
            "series": {
                "user_segment_1": 2984184.95,
                "user_segment_2": 5400161.2,
                "user_segment_3": 6392335.28,
                "user_segment_4": 14178937.21,
                "user_segment_5": 15271040.55,
                "user_segment_6": 6662526.71
            }
        },
        "201601": {
            "interval": "201601",
            "series": {
                "user_segment_1": 2247111.62,
                "user_segment_2": 4002009.51,
                "user_segment_3": 6897538.28,
                "user_segment_4": 7898838.13,
                "user_segment_5": 16268431.92,
                "user_segment_6": 7522873.24
            }
        },
        "201602": {
            "interval": "201602",
            "series": {
                "user_segment_1": 4261209.14,
                "user_segment_2": 7446151.1,
                "user_segment_3": 14225872.06,
                "user_segment_4": 14352871.78,
                "user_segment_5": 27445705.36,
                "user_segment_6": 12857389.39
            }
        },
        "201603": {
            "interval": "201603",
            "series": {
                "user_segment_1": 4904033.71,
                "user_segment_2": 9167600.57,
                "user_segment_3": 16899762.5,
                "user_segment_4": 13907096.28,
                "user_segment_5": 29271072.49,
                "user_segment_6": 12383853.89
            }
        },
        "201604": {
            "interval": "201604",
            "series": {
                "user_segment_1": 4901032.44,
                "user_segment_2": 12089835.13,
                "user_segment_3": 13565993.46,
                "user_segment_4": 16985161.69,
                "user_segment_5": 34093044.39,
                "user_segment_6": 13859007.99
            }
        },
        "201605": {
            "interval": "201605",
            "series": {
                "user_segment_1": 4444778.7,
                "user_segment_2": 13351236.27,
                "user_segment_3": 14613848.79,
                "user_segment_4": 15356486.34,
                "user_segment_5": 37017448.47,
                "user_segment_6": 14293291.29
            }
        },
        "201606": {
            "interval": "201606",
            "series": {
                "user_segment_1": 4499131.14,
                "user_segment_2": 14719246.03,
                "user_segment_3": 15457085.74,
                "user_segment_4": 17965557.67,
                "user_segment_5": 33364558.28,
                "user_segment_6": 14849541.28
            }
        },
        "201607": {
            "interval": "201607",
            "series": {
                "user_segment_1": 3550091.46,
                "user_segment_2": 10702363.98,
                "user_segment_3": 11271776.67,
                "user_segment_4": 12983558.05,
                "user_segment_5": 34894070.03,
                "user_segment_6": 11518098.07
            }
        },
        "201608": {
            "interval": "201608",
            "series": {
                "user_segment_1": 3339631.13,
                "user_segment_2": 12909470.15,
                "user_segment_3": 12975584.47,
                "user_segment_4": 12749843.89,
                "user_segment_5": 48919866.18,
                "user_segment_6": 9142043.21
            }
        },
        "201609": {
            "interval": "201609",
            "series": {
                "user_segment_1": 7931364.96,
                "user_segment_2": 11653816.65,
                "user_segment_3": 13604765.56,
                "user_segment_4": 13633584.4,
                "user_segment_5": 35728400.7,
                "user_segment_6": 10948145.02
            }
        },
        "201610": {
            "interval": "201610",
            "series": {
                "user_segment_1": 3563658.36,
                "user_segment_2": 10476119.75,
                "user_segment_3": 14190888.97,
                "user_segment_4": 12622210.73,
                "user_segment_5": 34032527.2,
                "user_segment_6": 10927459.73
            }
        },
        "201611": {
            "interval": "201611",
            "series": {
                "user_segment_1": 3739989.21,
                "user_segment_2": 13126117.27,
                "user_segment_3": 14555301.77,
                "user_segment_4": 14492619.66,
                "user_segment_5": 43493036.56,
                "user_segment_6": 12550124.06
            }
        },
        "201612": {
            "interval": "201612",
            "series": {
                "user_segment_1": 2072864.42,
                "user_segment_2": 8198914.12,
                "user_segment_3": 9119755.66,
                "user_segment_4": 8228822.48,
                "user_segment_5": 22683855.04,
                "user_segment_6": 6645589.92
            }
        },
        "201701": {
            "interval": "201701",
            "series": {
                "user_segment_1": 1711492.82,
                "user_segment_2": 7026350.71,
                "user_segment_3": 8348047.08,
                "user_segment_4": 7121179.11,
                "user_segment_5": 22478596.35,
                "user_segment_6": 7112278.62
            }
        }
    }
}
Clusters 3
version v3.0 (Optional) The API version
type user (Required) Cluster type
take 40 (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=user&take=40&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/clusters?version=v3.0&type=user&take=40&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 item (Required) Cluster Type
take 40 (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=item&take=40&skip=0"
GET %7B%7Brecommender-api-url%7D%7D/info/clusters?version=v3.0&type=item&take=40&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:
ChatGPT 7
version v3.0 (Optional) The API version
session_id {session_id} (Required) Fetch chat session history for this session_id 
curl -X GET "{{recommender-api-url}}/chatgpt?version=v3.0&session_id={session_id}"
GET %7B%7Brecommender-api-url%7D%7D/chatgpt?version=v3.0&session_id={session_id} HTTP/1.1
Host:

Lists all active charts for clusters

version v3.0 
curl -X GET "{{recommender-api-url}}/ask-ai?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/ask-ai?version=v3.0 HTTP/1.1
Host:
version v3.0 
curl -X GET "{{recommender-api-url}}/chatgpt/sessions?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/chatgpt/sessions?version=v3.0 HTTP/1.1
Host:

Lists all active charts for clusters

version v3.0
message which categories underperformed for item segment 1 in 2016 Why did item category G 1076 SCH APPAREL AND BAGS underperform?
session_id {session_id} 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "message=which categories underperformed for item segment 1 in 2016&session_id=test11223414&=" "{{recommender-api-url}}/chatgpt/chat-completion?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/chatgpt/chat-completion?version=v3.0 HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded

message=which categories underperformed for item segment 1 in 2016&session_id=test11223414&=
Status200 OK
Content-Typeapplication/json
version v3.0
chatgpt_session_id 1 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "chatgpt_session_id=1" "{{recommender-api-url}}/chatgpt/delete?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/chatgpt/delete?version=v3.0 HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded

chatgpt_session_id=1
version v3.0
chatgpt_session_id 1
session_name New Session Name 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "chatgpt_session_id=1&session_name=New Session Name" "{{recommender-api-url}}/chatgpt/update-session-name?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/chatgpt/update-session-name?version=v3.0 HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded

chatgpt_session_id=1&session_name=New Session Name
Interactions 6

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:

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
type cluster (Required) ID type - item|user
cluster_type item
cluster 1
field quantity
order desc
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0'
query quantity (Optional) Interactions type query.
difference absolute 
curl -X GET "{{recommender-api-url}}/info/get-cluster-interactions/?version=v3.0&type=cluster&cluster_type=item&cluster=1&field=quantity&order=desc&take=10&skip=0&difference=absolute"
GET %7B%7Brecommender-api-url%7D%7D/info/get-cluster-interactions/?version=v3.0&type=cluster&cluster_type=item&cluster=1&field=quantity&order=desc&take=10&skip=0&difference=absolute HTTP/1.1
Host:

Returns user interactions based on filters

version v3.0
type cluster (Required) ID type - item|user
cluster_type user
cluster 1
field quantity
order desc
take 10 (Optional) Number of results returned - Default = '10'
skip 0 (Optional) Number of results to skip - Default = '0'
query quantity (Optional) Interactions type query.
difference absolute 
curl -X GET "{{recommender-api-url}}/info/get-cluster-interactions/?version=v3.0&type=cluster&cluster_type=user&cluster=1&field=quantity&order=desc&take=10&skip=0&difference=absolute"
GET %7B%7Brecommender-api-url%7D%7D/info/get-cluster-interactions/?version=v3.0&type=cluster&cluster_type=user&cluster=1&field=quantity&order=desc&take=10&skip=0&difference=absolute HTTP/1.1
Host:
version v3.0
start_date {{interactions_start_date}} (Required-Chart Specific) Query start date. "yyyy-mm-dd"
end_date {{interactions_end_date}} (Required-Chart Specific) Query end date. "yyyy-mm-dd"
location_ids[] {{interactions_location_ids}} (Optionnal) Location Ids array
location_ids[] 119 (Optionnal) Location Ids array
user_ids[] 10555570 (Optional) User Ids array
user_ids[] 1637630 (Optional) User Ids array 
curl -X GET "{{recommender-api-url}}/interactions/active-users-in-period?version=v3.0&start_date={{interactions_start_date}}&end_date={{interactions_end_date}}&location_ids[]={{interactions_location_ids}}"
GET %7B%7Brecommender-api-url%7D%7D/interactions/active-users-in-period?version=v3.0&start_date={{interactions_start_date}}&end_date={{interactions_end_date}}&location_ids[]={{interactions_location_ids}} HTTP/1.1
Host:
version v3.0
start_date {{interactions_start_date}} (Required-Chart Specific) Query start date. "yyyy-mm-dd"
end_date {{interactions_end_date}} (Required-Chart Specific) Query start date. "yyyy-mm-dd"
location_ids[] {{interactions_location_ids}} (Optionnal) Location Ids array
location_ids[] 119 (Optionnal) Location Ids array
user_ids[] 10555570 (Optional) User Ids array
user_ids[] 1637630 (Optional) User Ids array 
curl -X GET "{{recommender-api-url}}/interactions/user-average-spend?version=v3.0&start_date={{interactions_start_date}}&end_date={{interactions_end_date}}&location_ids[]={{interactions_location_ids}}"
GET %7B%7Brecommender-api-url%7D%7D/interactions/user-average-spend?version=v3.0&start_date={{interactions_start_date}}&end_date={{interactions_end_date}}&location_ids[]={{interactions_location_ids}} HTTP/1.1
Host:
Items 4
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
take {{take}} (Optional) Number of results returned - Default = '10'
skip {{skip}} (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={{take}}&skip={{skip}}"
GET %7B%7Brecommender-api-url%7D%7D/info/items?version=v3.0&take={{take}}&skip={{skip}} 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
Organization 12
version v3.0 (Optional) The API version 
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 (Optional) The API version
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
currency USD (Required) Currency for the application 
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}¤cy=USD" "{{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}¤cy=USD
version v3.0 (Optional) The API version
application_id 12 (Required) The Application ID
name New App Name (Optional) New Application name
description App Description (Optional) The description of the application
domain https://domain.com (Optional) The domain where the application will run
aws_access_key {AWS_ACCESS_KEY} (Optional) Your AWS S3 Access Key for your S3 Bucket
currency USD (Optional) Currency for the application 
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}¤cy=USD" "{{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}¤cy=USD
version v3.0 (Optional) The API version
first_name John (Required) First Name of the new user
last_name Doe (Required) Last Name of the new user
email user@example.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=John&last_name=Doe&email=user@example.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=John&last_name=Doe&email=user@example.com&user_type=Org-Admin
version v3.0 (Optional) The API version
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 (Optional) The API version
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 3
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
Content-Type application/x-www-form-urlencoded
version v3.0 (Optional) The API version
first_name John (Optional) User first name
last_name Doe (Optional) User last name
email (Optional) User email
telephone 55555555555 (Optional) User telephone 
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=&telephone=55555555555" "{{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&email=&telephone=55555555555
Recommender Builder 15

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
aws_secret_key {{aws_secret_key}} (Required) AWS S3 Secret Key
aws_bucket xineoh-movielens-bucket (Required) AWS S3 Bucket
application_id 20 (Optional) The Application ID - Will use Token application if this is empty 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "aws_secret_key={{aws_secret_key}}&aws_bucket=xineoh-movielens-bucket&application_id=20" "{{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={{aws_secret_key}}&aws_bucket=xineoh-movielens-bucket&application_id=20
Status200 OK
Content-Typeapplication/json
{
    "status_code": 200,
    "success": "We will notify you when it's finished",
    "process_id": 668
}

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
automate 0 (Optional) If the rest of the steps should be automated, defaults to 1
application_id 20 (Optional) The Application ID - Will use Token application if this is empty 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "application_id=20" "{{recommender-api-url}}/builder/build?version=v3.0&automate=0"
POST %7B%7Brecommender-api-url%7D%7D/builder/build?version=v3.0&automate=0 HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded

application_id=20

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" "{{recommender-api-url}}/builder/train?version=v3.0&automate=0&continue_in_background=true"
POST %7B%7Brecommender-api-url%7D%7D/builder/train?version=v3.0&automate=0&continue_in_background=true HTTP/1.1
Host:

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" "{{recommender-api-url}}/builder/test?version=v3.0&automate=0&continue_in_background=true"
POST %7B%7Brecommender-api-url%7D%7D/builder/test?version=v3.0&automate=0&continue_in_background=true HTTP/1.1
Host:

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
max_iter 10 (Optional) Maximum number of iterations to run the meta param optimization. (Min: 5, Max: 100)
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "max_iter=10&automate=0&continue_in_background=true" "{{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=10&automate=0&continue_in_background=true

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
clusters_min 4 (Required) Minimum amount of clusters to do for a given cluster type (Min:2)
clusters_max 8 (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
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "clusters_min=4&clusters_max=8&cluster_type=user&automate=0&continue_in_background=true" "{{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=4&clusters_max=8&cluster_type=user&automate=0&continue_in_background=true

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
clusters_min 1 (Required) Minimum amount of clusters to do for a given cluster type (Min:2)
clusters_max 3 (Required) Maximum amount of clusters to do for a given cluster type (Max:100)
cluster_type location (Required) Which category to cluster - user or item
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "clusters_min=1&clusters_max=3&cluster_type=location&automate=0&continue_in_background=true" "{{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=1&clusters_max=3&cluster_type=location&automate=0&continue_in_background=true

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 6 (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
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "clusters_min=2&clusters_max=6&cluster_type=item&automate=0&continue_in_background=true" "{{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=6&cluster_type=item&automate=0&continue_in_background=true
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 6 (Required) Chosen number of clusters to use for a given cluster type
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "cluster_type=user&cluster_amount=6&automate=0&continue_in_background=true" "{{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=6&automate=0&continue_in_background=true
version v3.0 (Optional) The API version
graph trade_off (Required) Graph Type
type locations (Required) Trade off type. 'users'|'items' 
curl -X GET "{{recommender-api-url}}/charts/graph?version=v3.0&graph=trade_off&type=locations"
GET %7B%7Brecommender-api-url%7D%7D/charts/graph?version=v3.0&graph=trade_off&type=locations 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 location (Required) Which category of cluster to save the cluster info for
cluster_amount 2 (Required) Chosen number of clusters to use for a given cluster type
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "cluster_type=location&cluster_amount=2&automate=0&continue_in_background=true" "{{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=location&cluster_amount=2&automate=0&continue_in_background=true
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 4 (Required) Chosen number of clusters to use for a given cluster type
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "cluster_type=item&cluster_amount=4&automate=0&continue_in_background=true" "{{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=4&automate=0&continue_in_background=true

Start building a model of recommender
Admin users only

version v3.0 (Optional) The API version
clusters_min 2 (Optional) Minimum amount of clusters to do for a given cluster type (Min:2)
clusters_max 6 (Optional) Maximum amount of clusters to do for a given cluster type (Max:100)
cluster_type item (Optional) Which category to cluster - user, location or item - if not sent through will cluster all types
automate 0 (Optional) If the rest of the steps should be automated
continue_in_background true 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "clusters_min=2&clusters_max=6&cluster_type=item&automate=0&continue_in_background=true" "{{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=6&cluster_type=item&automate=0&continue_in_background=true
Recommender Builder Process Info 3
version v3.0 (Optional) The API version
process_id 360 (Required) Process ID recieved from one of the Builder endpoints
application_id 20 (Optional) The Application ID - Will use Token application if this is empty 
curl -X GET "{{recommender-api-url}}/process?version=v3.0&process_id=360&application_id=20"
GET %7B%7Brecommender-api-url%7D%7D/process?version=v3.0&process_id=360&application_id=20 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 batch (Required) Process ID recieved from one of the Builder endpoints
application_id 20 (Optional) The Application ID - Will use Token application if this is empty 
curl -X GET "{{recommender-api-url}}/process?version=v3.0&process=batch&application_id=20"
GET %7B%7Brecommender-api-url%7D%7D/process?version=v3.0&process=batch&application_id=20 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
application_id 20 (Optional) The Application ID - Will use Token application if this is empty 
curl -X GET "{{recommender-api-url}}/process/latest?version=v3.0&application_id=20"
GET %7B%7Brecommender-api-url%7D%7D/process/latest?version=v3.0&application_id=20 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 16
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type user_segment (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_segment&id=1"
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=user_segment&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_segment (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_segment&id=1"
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=item_segment&id=1 HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type location_segment (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=location_segment&id=1"
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=location_segment&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 600427543 (Required) Id of the item you want to get recommendations for 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/similar?version=v3.0&type=item&id=600427543"
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=item&id=600427543 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 ycg44Yo2kpb8jPqMeAiC0w== (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=ycg44Yo2kpb8jPqMeAiC0w=="
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=user&id=ycg44Yo2kpb8jPqMeAiC0w== HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
type location (Required) Type of recommendations to return
id rn7hS1WalYi6U8RUDpvK8g== (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=location&id=rn7hS1WalYi6U8RUDpvK8g=="
GET %7B%7Brecommender-api-url%7D%7D/recommender/similar?version=v3.0&type=location&id=rn7hS1WalYi6U8RUDpvK8g== HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
id_type user_segment (Required) Type of recommendations to return
id 1 (Required) Cluster/Segment Id.
recommendation_type item 
curl -X GET "{{recommender-api-url}}/recommender/recommendations?version=v3.0&id_type=user_segment&id=1&recommendation_type=item"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&id_type=user_segment&id=1&recommendation_type=item HTTP/1.1
Host:
Authorization Bearer {{recommender_api_jwt}}
Content-Type application/json
version v3.0 (Optional) The API version
id_type item_segment (Required) Type of recommendations to return
id 1 (Required) Cluster/Segment Id.
recommendation_type item 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" -H "Content-Type: application/json" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&id_type=item_segment&id=1&recommendation_type=item"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&id_type=item_segment&id=1&recommendation_type=item HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
Content-Type: application/json
Authorization Bearer {{recommender_api_jwt}}
Content-Type application/json
version v3.0 (Optional) The API version
id_type location_segment (Required) Type of recommendations to return
id 1 (Required) Cluster/Segment Id.
recommendation_type item 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" -H "Content-Type: application/json" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&id_type=location_segment&id=1&recommendation_type=item"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&id_type=location_segment&id=1&recommendation_type=item 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
id_type user (Required) Type of recommendations to return
id ycg44Yo2kpb8jPqMeAiC0w== (Required) User id to get recommendations for
size 20 (Optional) Will default to 20 if not included
recommendation_type item 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&id_type=user&id=ycg44Yo2kpb8jPqMeAiC0w==&size=20&recommendation_type=item"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&id_type=user&id=ycg44Yo2kpb8jPqMeAiC0w==&size=20&recommendation_type=item HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
id_type item (Required) Type of recommendations to return
id 600427543 (Required) User id to get recommendations for
size 20 (Optional) Will default to 20 if not included
recommendation_type user 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&id_type=item&id=600427543&size=20&recommendation_type=user"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&id_type=item&id=600427543&size=20&recommendation_type=user HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
id_type location (Required) Type of recommendations to return
id rn7hS1WalYi6U8RUDpvK8g== (Required) User id to get recommendations for
size 20 (Optional) Will default to 20 if not included
recommendation_type user 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&id_type=location&id=rn7hS1WalYi6U8RUDpvK8g==&size=20&recommendation_type=user"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&id_type=location&id=rn7hS1WalYi6U8RUDpvK8g==&size=20&recommendation_type=user 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 ycg44Yo2kpb8jPqMeAiC0w== (Required) User id to get recommendations for
size 20 (Optional) Will default to 20 if not included
recommendation_type item 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&type=user&id=ycg44Yo2kpb8jPqMeAiC0w==&size=20&recommendation_type=item"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&type=user&id=ycg44Yo2kpb8jPqMeAiC0w==&size=20&recommendation_type=item 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 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
recommendation_type item 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&type=user&id=138176&filter={"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}}&size=20&recommendation_type=item"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&type=user&id=138176&filter={"includes": {"genres": "Adventure"}, "excludes": {"genres": "Action"}}&size=20&recommendation_type=item 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 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
recommendation_type item 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/recommendations?version=v3.0&type=user&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&recommendation_type=item"
GET %7B%7Brecommender-api-url%7D%7D/recommender/recommendations?version=v3.0&type=user&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&recommendation_type=item HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
Authorization Bearer {{recommender_api_jwt}}
version v3.0 (Optional) The API version
containing_entity lds denim (Required) The id of the containing entity that gets the performance delta report. | set to "all" when containing entity type is all
containing_entity_type categories (Required) The type of the containing_entity. 'categories', 'item_segment', 'user_segment', 'location_segment', 'campaign', 'all'
secondary_entity item_segment (Optional) The type of the secondary_entity. Used if the user only wants to see the performance of only one secondary entity for a containing containing_entity_type 'categories', 'item_segment', 'user_segment', 'location_segment', 'campaign'
interval_type monthly (Optional) The type of interval the report will partition the secondary entities into. Defaults to monthly. 'monthly' | 'quarterly' | 'yearly' | 'weekly'
start_date 201601 (Optional) Start date of the report in the format of of the interval type. Defaults to 3 years ago.
end_date 201912 (Optional) End date of the report in the format of the interval type. Defaults to current date or latest date for which there is data.
report_type all (Optional) all | summary
kpi sales 
curl -X GET -H "Authorization: Bearer {{recommender_api_jwt}}" "{{recommender-api-url}}/recommender/performance-delta?version=v3.0&containing_entity=lds denim&containing_entity_type=categories&secondary_entity=item_segment&interval_type=monthly&start_date=201601&end_date=201912&report_type=all&kpi=sales"
GET %7B%7Brecommender-api-url%7D%7D/recommender/performance-delta?version=v3.0&containing_entity=lds denim&containing_entity_type=categories&secondary_entity=item_segment&interval_type=monthly&start_date=201601&end_date=201912&report_type=all&kpi=sales HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
Schemas 5
version v3.0 (Optional) The API version
schema item_meta_data 
curl -X GET "{{recommender-api-url}}/schemas/schema-settings?version=v3.0&schema=item_meta_data"
GET %7B%7Brecommender-api-url%7D%7D/schemas/schema-settings?version=v3.0&schema=item_meta_data HTTP/1.1
Host:
version v3.0 (Optional) The API version 
curl -X GET "{{recommender-api-url}}/schemas/list-schemas?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/schemas/list-schemas?version=v3.0 HTTP/1.1
Host:
version v3.0 (Optional) The API version 
curl -X GET "{{recommender-api-url}}/schemas/list-schema-data-types?version=v3.0"
GET %7B%7Brecommender-api-url%7D%7D/schemas/list-schema-data-types?version=v3.0 HTTP/1.1
Host:
version v3.0 (Optional) The API version
schema_id 31 (Required) The schema_id you want info of
application_id 25 (Optional) Will use the JWT application_id if omitted 
curl -X GET "{{recommender-api-url}}/schemas?version=v3.0&schema_id=31&application_id=25"
GET %7B%7Brecommender-api-url%7D%7D/schemas?version=v3.0&schema_id=31&application_id=25 HTTP/1.1
Host:
Authorization Bearer {{recommender_api_jwt}}
Content-Type application/json
version v3.0 (Optional) The API version
schema item_meta_data
fields[0] {"name":"item_id","label":"sku","type":"integer"}
fields[1] {"name":"meta_data_1","label":"title","type":"string","categorical":false,"hierarchy_level":null}
fields[2] {"name":"meta_data_2","label":"description","type":"string","categorical":false,"hierarchy_level":null}
fields[3] {"name":"meta_data_3","label":"category","type":"string","categorical":false,"hierarchy_level":1}
fields[4] {"name":"meta_data_4","label":"range","type":"string","categorical":false,"hierarchy_level":2}
fields[5] {"name":"created_dt","type":"timestamp"} 
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Bearer {{recommender_api_jwt}}" -H "Content-Type: application/json" -d "schema=item_meta_data&fields[0]={"name":"item_id","label":"sku","type":"integer"}&fields[1]={"name":"meta_data_1","label":"title","type":"string","categorical":false,"hierarchy_level":null}&fields[2]={"name":"meta_data_2","label":"description","type":"string","categorical":false,"hierarchy_level":null}&fields[3]={"name":"meta_data_3","label":"category","type":"string","categorical":false,"hierarchy_level":1}&fields[4]={"name":"meta_data_4","label":"range","type":"string","categorical":false,"hierarchy_level":2}&fields[5]={"name":"created_dt","type":"timestamp"}" "{{recommender-api-url}}/schemas?version=v3.0"
POST %7B%7Brecommender-api-url%7D%7D/schemas?version=v3.0 HTTP/1.1
Host: 
Authorization: Bearer {{recommender_api_jwt}}
Content-Type: application/json
Content-Type: application/x-www-form-urlencoded

schema=item_meta_data&fields[0]={"name":"item_id","label":"sku","type":"integer"}&fields[1]={"name":"meta_data_1","label":"title","type":"string","categorical":false,"hierarchy_level":null}&fields[2]={"name":"meta_data_2","label":"description","type":"string","categorical":false,"hierarchy_level":null}&fields[3]={"name":"meta_data_3","label":"category","type":"string","categorical":false,"hierarchy_level":1}&fields[4]={"name":"meta_data_4","label":"range","type":"string","categorical":false,"hierarchy_level":2}&fields[5]={"name":"created_dt","type":"timestamp"}
Users 4

Returns a paginated list of users

version v3.0 (Optional) The API version
take {{take}} (Optional) Number of results returned - Default = '10'
skip {{skip}} (Optional) Number of results to skip - Default = '0' 
curl -X GET "{{recommender-api-url}}/info/users?version=v3.0&take={{take}}&skip={{skip}}"
GET %7B%7Brecommender-api-url%7D%7D/info/users?version=v3.0&take={{take}}&skip={{skip}} 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 a 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"
            }
        ]
    }
}
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