Migrate from GitHub to SourceForge with this tool. Check out all of SourceForge's recent improvements.
Close

RecommendationAPI

Florian Kleedorfer Stephan Zavrel

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

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

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

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

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

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

Related

Wiki: API