Recent changes to RankingsAPI

RankingsAPI modified by Florian Kleedorfer

Florian Kleedorfer — Mon, 22 Feb 2016 16:44:21 -0000

--- v2
+++ v3
@@ -14,6 +14,7 @@
 apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 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.
 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.
 timeRange | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history 
@@ -34,6 +35,7 @@
 apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 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.
 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 | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history
@@ -52,6 +54,7 @@
 apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 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.
 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 | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history 
@@ -70,6 +73,7 @@
 apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 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.
 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 | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history 
@@ -88,6 +92,7 @@
 apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 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.
 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 | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history

RankingsAPI modified by Stephan Zavrel

Stephan Zavrel — Tue, 25 Aug 2015 12:57:46 -0000

--- v1
+++ v2
@@ -15,7 +15,7 @@
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 numberOfResults | optional |parameter to determine the number of results returned.
 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 | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
+timeRange | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history

RankingsAPI modified by Stephan Zavrel

Stephan Zavrel — Tue, 04 Aug 2015 13:32:35 -0000

most viewed items
- Sample call
- Parameters
most bought items
- Sample call
- Parameters
most rated items
- Sample call
- Parameters
best rated items
- Sample call
- Parameters
worst rated items
- Sample call
- Parameters

most viewed items

This community ranking shows items that were viewed most by all users. 50 items are returned at most, results are sorted by relevance.

Sample call

HTTP GET

{yourServerURL}/api/1.1/mostvieweditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&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")
numberOfResults	optional	parameter to determine the number of results returned.
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	parameter to determine the time range. This parameter may be set to one of the following values: DAY: most viewed items within the last 24 hours. WEEK: most viewed items within the last week. MONTH: most viewed items within the last month. ALL (default): if no value or this value is given, the most viewed items of all time will be shown
clusterid	optional	the type of actions in the history

most bought items

This community ranking shows items that were bought the most. No more than 50 items are returned, results are sorted by relevance.

Sample call

HTTP GET

{yourServerURL}/api/1.1/mostboughtitems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&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")
numberOfResults	optional	parameter to determine the number of results returned.
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	parameter to determine the time range. This parameter may be set to one of the following values: DAY: most viewed items within the last 24 hours. WEEK: most viewed items within the last week. MONTH: most viewed items within the last month. ALL (default): if no value or this value is given, the most viewed items of all time will be shown
clusterid	optional	the type of actions in the history

most rated items

This community ranking shows items that were rated the most. No more than 50 items are returned, results are sorted by relevance.

Sample call

HTTP GET

{yourServerURL}/api/1.1/mostrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&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")
numberOfResults	optional	parameter to determine the number of results returned.
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	parameter to determine the time range. This parameter may be set to one of the following values: DAY: most viewed items within the last 24 hours. WEEK: most viewed items within the last week. MONTH: most viewed items within the last month. ALL (default): if no value or this value is given, the most viewed items of all time will be shown
clusterid	optional	the type of actions in the history

best rated items

This community ranking shows the best rated items. Rating values range from 1 to 10. The ranking only includes items that have an average ranking value greater than 5.5. No more than 50 items are returned, results are sorted by relevance.

Sample call

HTTP GET

{yourServerURL}/api/1.1/bestrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&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")
numberOfResults	optional	parameter to determine the number of results returned.
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	parameter to determine the time range. This parameter may be set to one of the following values: DAY: most viewed items within the last 24 hours. WEEK: most viewed items within the last week. MONTH: most viewed items within the last month. ALL (default): if no value or this value is given, the most viewed items of all time will be shown
clusterid	optional	the type of actions in the history

worst rated items

This community ranking shows the worst rated items. Rating values range from 1 to 10. The ranking only includes items that have an average ranking value less than 5.5. No more than 50 items are returned, results are sorted by relevance.

Sample call

HTTP GET

{yourServerURL}/api/1.1/worstrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&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")
numberOfResults	optional	parameter to determine the number of results returned.
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	parameter to determine the time range. This parameter may be set to one of the following values: DAY: most viewed items within the last 24 hours. WEEK: most viewed items within the last week. MONTH: most viewed items within the last month. ALL (default): if no value or this value is given, the most viewed items of all time will be shown
clusterid	optional	the type of actions in the history