Recent changes to RecommendationAPI

RecommendationAPI modified by Florian Kleedorfer

Florian Kleedorfer — Mon, 22 Feb 2016 16:43:25 -0000

--- v3
+++ v4
@@ -16,6 +16,7 @@
 itemid | required | id to identify an item on your Website. (e.g. "ID001")    
 userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
 numberOfResults | optional | An optional parameter to determine the number of results returned.
+offset | optional | An optional 0-based index to specify with which item to start the result - useful for paging.
 itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
 requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
 withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
@@ -36,6 +37,7 @@
 itemid | required | id to identify an item on your Website. (e.g. "ID001")    
 userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
 numberOfResults | optional | An optional parameter to determine the number of results returned.
+offset | optional | An optional 0-based index to specify with which item to start the result - useful for paging.
 itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
 requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
 withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
@@ -57,6 +59,7 @@
 itemid | required | id to identify an item on your Website. (e.g. "ID001")    
 userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
 numberOfResults | optional | An optional parameter to determine the number of results returned.
+offset | optional | An optional 0-based index to specify with which item to start the result - useful for paging.
 itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
 requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
 withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
@@ -77,6 +80,7 @@
 itemid | required | id to identify an item on your Website. (e.g. "ID001")    
 userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
 numberOfResults | optional | An optional parameter to determine the number of results returned.
+offset | optional | An optional 0-based index to specify with which item to start the result - useful for paging.
 itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
 requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
 withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
@@ -97,6 +101,7 @@
 itemid | required | id to identify an item on your Website. (e.g. "ID001")    
 userid | optional | anonymised id of a user. (e.g. "24EH1723322222A3")
 numberOfResults | optional | parameter to determine the number of results returned.
+offset | optional | An optional 0-based index to specify with which item to start the result - useful for paging.
 itemtype | optional; default: ITEM | item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
 requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
 withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
@@ -116,6 +121,7 @@
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 userid | optional | anonymised id of a user. (e.g. "24EH1723322222A3")
 numberOfResults | optional |parameter to determine the number of results returned.
+offset | optional | An optional 0-based index to specify with which item to start the result - useful for paging.
 itemtype | optional; default: ITEM | item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
 requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
 actiontype | optional | thte type of actions in the history

RecommendationAPI modified by Stephan Zavrel

Stephan Zavrel — Tue, 04 Aug 2015 13:31:56 -0000

--- v2
+++ v3
@@ -1,3 +1,5 @@
+[TOC]
+
 ## other users also viewed
 Users who viewed the specified item also viewed the returned items. At most 15 items are returned, results are sorted by relevance.

RecommendationAPI modified by Stephan Zavrel

Stephan Zavrel — Tue, 04 Aug 2015 13:31:21 -0000

--- v1
+++ v2
@@ -0,0 +1,119 @@
+## other users also viewed
+Users who viewed the specified item also viewed the returned items. At most 15 items are returned, results are sorted by relevance. 
+
+### Sample call
+**HTTP GET**
+
+> {*yourServerURL*}/api/1.1/otherusersalsoviewed?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&userid=24EH1723322222A3&itemtype=ITEM&requesteditemtype=ITEM
+
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+itemid | required | id to identify an item on your Website. (e.g. "ID001")    
+userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
+numberOfResults | optional | An optional parameter to determine the number of results returned.
+itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
+requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
+withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
+
+## other users also bought
+Users who bought the specified item also bought the items returned by this method. At most 15 items are returned, results are sorted by relevance.
+
+### Sample call
+**HTTP GET**
+
+> {*yourServerURL*}/api/1.1/otherusersalsobought?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&userid=24EH1723322222A3&itemtype=ITEM&requesteditemtype=ITEM
+
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+itemid | required | id to identify an item on your Website. (e.g. "ID001")    
+userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
+numberOfResults | optional | An optional parameter to determine the number of results returned.
+itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
+requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
+withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
+
+
+## items rated good by other users
+Users who rated the specified item 'good' did the same with items returned by this method. At most 15 items are returned, results are sorted by relevance.
+
+### Sample call
+**HTTP GET**
+
+> {*yourServerURL*}/api/1.1/itemsratedgoodbyotherusers?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&userid=24EH1723322222A3&itemtype=ITEM&requesteditemtype=ITEM
+
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+itemid | required | id to identify an item on your Website. (e.g. "ID001")    
+userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
+numberOfResults | optional | An optional parameter to determine the number of results returned.
+itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
+requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
+withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
+
+## related items
+This API is used to return rules generated by easyrec Plugins. At most 15 items are returned, results are sorted by relevance.
+
+### Sample call
+**HTTP GET**
+
+> {*yourServerURL*}/api/1.1/relateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&userid=24EH1723322222A3&itemtype=ITEM&requesteditemtype=ITEM
+
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+itemid | required | id to identify an item on your Website. (e.g. "ID001")    
+userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
+numberOfResults | optional | An optional parameter to determine the number of results returned.
+itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
+requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
+withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
+
+## recommendations for user
+This recommendation shows items for a given user id. The latest items that where viewed by the given user are used to find related items of any association type (also viewed, bought, etc., but also custom assoc type). If a user has no viewing history or the viewed items have no related items an empty list is returned. You might want to display other recommendations like most viewed items or most bought items of the last week to the user instead. At most 15 items are returned, results are sorted by relevance.
+
+### Sample call
+**HTTP GET**
+
+{*yourServerURL*}/api/1.1/recommendationsforuser?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&userid=24EH1723322222A3&requesteditemtype=ITEM 
+
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+itemid | required | id to identify an item on your Website. (e.g. "ID001")    
+userid | optional | anonymised id of a user. (e.g. "24EH1723322222A3")
+numberOfResults | optional | parameter to determine the number of results returned.
+itemtype | optional; default: ITEM | item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
+requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
+withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
+
+## action history for user
+This API is used to return the last actions performed by a user and can be used to present a browsing history for a user in a store.
+
+### Sample call
+**HTTP GET**
+
+{*yourServerURL*}/api/1.1/actionhistoryforuser?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&userid=24EH1723322222A3
+
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+userid | optional | anonymised id of a user. (e.g. "24EH1723322222A3")
+numberOfResults | optional |parameter to determine the number of results returned.
+itemtype | optional; default: ITEM | item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
+requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
+actiontype | optional | thte type of actions in the history

RecommendationAPI modified by Stephan Zavrel

Stephan Zavrel — Tue, 04 Aug 2015 13:17:58 -0000