Forum Discussion

Claudius's avatar
11 years ago

Get most popular ideas by kudos via REST API

I would like to create a dashboard of the most popular idea on one of our ideation boards.

I started from showing the latest ideas via

http://lithosphere.lithium.com/restapi/vc/boards/id/Example_Ideation_Board/threads/latest

Based on the information on leaderboards (http://lithosphere.lithium.com/t5/rest-api/bd-p/developers-rest-api?leaf-id=Board.kudos.messages.leaderboard#Board.kudos.messages.leaderboard) i tried to use

http://lithosphere.lithium.com/restapi/vc/boards/id/Example_Ideation_Board/kudos/messages/leaderboard

 ...but this returns "A required query string argument is missing." and already

http://lithosphere.lithium.com/restapi/vc/boards/id/Example_Ideation_Board/kudos

 ,,,returns "Method 'get' is not supported off of node 'board.kudos'."

 

How can I get a list of ideas sorted by kudos?

  • PaoloT's avatar
    PaoloT
    Lithium Alumni (Retired)

    Hi Claudius,

     

    the messages/leaderboard call requires that you specify a time-frame to look at to determine the leaderboard. This is the max_age parameter and it's documented here 

     

    To take the Lithosphere's Customer Ideas board as an example, you could do:

     

    http://lithosphere.lithium.com/restapi/vc/boards/id/Lithium_Ideas/kudos/messages/leaderboard?max_age=all

     To get the most kudoed messages of all time :smileyhappy: 

     

    You can also pass a page_size and page attribute to play with the pagination.

     

    Hope that helps !

     

     

     

    • Claudius's avatar
      Claudius
      Boss

      Thanks, that did the trick.

       

      Maybe the REST API documentation should have required parameters written in bold for developers like me ;)