Menu
▾
▴
RankingsAPI
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. |
| 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 |
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. |
| 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 |
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. |
| 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 |
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. |
| 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 |
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. |
| 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 |
