Forum Discussion

franpp's avatar
franpp
Guide
12 years ago

Is there an API request URL to get products sorted by rating?

I need to get products sorted by rating, but can't find the correct API request for this in the API documentation. Is there any API request that returns this, or there is any sorting option for produ...
MichaelD's avatar
MichaelD
Lithium Alumni (Retired)
11 years ago
A product is not required to have associated rating information. This is the reason that the /restapi/vc/products/all was implemented such that all products would be returned independent of the rating.

Once you have obtained the id for a product you will be able to call the endpoint /restapi/vc/products/id/34/ratings/key/key to obtain the rating information for the product.

Presently the rest API does not provide a single endpoint for obtaining a list of products ordered by ratings. But the two endpoints discussed here can be used to build such a list.

I hope this helps.
thilo's avatar
thilo
Mentor
11 years ago

Thanks a lot MichaelD  for your support! A simple route to achieve this would be awesome.

 

The question still remains what the route "restapi/vc/ratings/key/key/ratings/leaderboard" is for, and why it isn't working? As the documentation suggests exactly to be the route we were looking for it might be helpful to adjust the documentation of this API call.

  • ChhamaJ's avatar
    ChhamaJ
    Khoros Staff
    11 years ago

    thilo 

    "restapi/vc/ratings/key/key/ratings/leaderboard" is for listing all rated targets (forum posts, knowledge base articles, products, ideas, contests) and their average rating and count. The default sort order is by average. 

     

    For getting all products, the key is review_ratings. So the call should look like 

     

    restapi/vc/ratings/key/review_ratings/ratings/leaderboard

     

    Also, you would get a 303 only if Ratings is not enabled on your community. The call should work and return the correct result. If it doesn't, feel free to message me with the call you are using.

     

    Hope this helps.

     

    Regards,
    Chhama