Appearance
Recommendations API (v1)
Recommendation methods can recommend items given a user or recommend items given an item, leveraging LYNX's AI prediction engine.
Current version: v1.
INFO
All API endpoints are accessible via https and are located at ai.kickdynamic.cloud
Recommended for you
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/for-you
Based on the user's past behavior, recommends items that are most likely to spark the interest of a given user {userId}.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| Query parameters | Type | Description |
|---|---|---|
| {userId} | REQUIRED string | User ID |
| {daysSpan} | string | The number of days considered in the recommendation. Default value is 30 |
| {topN} | integer | Specifies the max number of items to be returned |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
| {filter} | string | An expression that allows to filter items based on the values of their attributes |
Similar items
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/{itemId}/similar
Recommends items that are similar to {itemId}. The returned items are sorted by similarity.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| {itemId} | REQUIRED string | The id of the item for which you want to find similar items |
| Query parameters | Type | Description |
|---|---|---|
| {topN} | integer | Specifies the max number of items to be returned |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
| {filter} | string | An expression that allows to filter items based on the values of their attributes |
Frequently bought together items
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/{itemId}/bought-together
Recommends items that are typically complementary to {itemId} or have been purchased at the same time, on the same order, by other customers.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| {itemId} | REQUIRED string | The id (SKU) of the item for which you want to find items that are frequently bought together |
| Query parameters | Type | Description |
|---|---|---|
| {userId} | string | User ID |
| {topN} | integer | Specifies the max number of items to be returned |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
| {filter} | string | An expression that allows to filter items based on the values of their attributes |
Top in category items
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/top-in-category
Recommends items that are the most popular in a given category. Popularity can be based on one of the following metrics: most viewed, most purchased, or highest rated.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| Query parameters | Type | Description |
|---|---|---|
| {daysSpan} | integer | The number of days considered in the recommendation. If not present, the default time span is 30 days |
| {category} | string | The category for which we want to get the most popular items. If not present, all categories will be considered |
| {rankBy} | string | The parameter according to which items' popularity is calculated. It can be one the following strings: view, purchase, rate |
| {topN} | integer | Specifies the max number of items to be returned |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
| {filter} | string | An expression that allows to filter items based on the values of their attributes |
Top purchased items
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/top-purchases
Recommends the most valuable items to a given user {userId} among those that have been purchased the most in a certain period of time.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| Query parameters | Type | Description |
|---|---|---|
| {userId} | string | User ID |
| {daysSpan} | integer | The number of days considered in the recommendation. If not present, the default time span is 1 day |
| {topN} | integer | Specifies the max number of items to be returned |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
| {filter} | string | An expression that allows to filter items based on the values of their attributes |
Also viewed items
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/{itemId}/also/viewed
Recommends items that are related to the item that's being viewed. People that viewed {itemId} also viewed these other items.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| {itemId} | REQUIRED string | The id (SKU) of the item for which you want to find related items |
| Query parameters | Type | Description |
|---|---|---|
| {userId} | string | User ID |
| {topN} | integer | Specifies the max number of items to be returned |
| {excludePreviousPurchases} | string | If true, items previously purchased by the user will not be included in the response |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
| {filter} | string | An expression that allows to filter items based on the values of their attributes |
Recently viewed items
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/recently-viewed
Recommends the user's recently viewed items.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| Query parameters | Type | Description |
|---|---|---|
| {userId} | string | User ID |
| {topN} | integer | Specifies the max number of items to be returned |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
Recently purchased items
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/recently-purchased
Recommends the items that have recently been purchased on your webstore.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| Query parameters | Type | Description |
|---|---|---|
| {topN} | integer | Specifies the max number of items to be returned |
| {startDate} | string | If present, only items purchased after the {startDate} will be returned |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
| {filter} | string | An expression that allows to filter items based on the values of their attributes |
Recently added to cart items
GET https://ai.kickdynamic.cloud/api/v1/recommender/{merchantId}/items/recently-added-to-cart
Recommends the items that have recently been added to users' carts.
Parameters
| Path parameters | Type | Description |
|---|---|---|
| {merchantId} | REQUIRED string | Your merchant ID |
| Query parameters | Type | Description |
|---|---|---|
| {topN} | integer | Specifies the max number of items to be returned |
| {startDate} | string | If present, only items that were added to the cart on or after the {startDate} will be returned |
| {attributes} | string | If present, it allows to specify the item's attributes that should be returned. The attributes are given as a comma-separated list |
| {filter} | string | An expression that allows to filter items based on the values of their attributes |