How do I replicate the spotlight notebooks?

28 views
Skip to first unread message

montz

unread,
Nov 28, 2012, 1:19:55 AM11/28/12
to spring...@googlegroups.com
I would like to show "new" notebooks for users to explore similar to spotlight feature in springpad website. Is there any API support for this? I currently use the explore api but that seems to return only blocks that are not workbooks.

Caroline O'Reilly

unread,
Nov 28, 2012, 1:21:21 AM11/28/12
to spring...@googlegroups.com

Please can you remove me from the distribution list. Thanks. Caroline

Pete Aykroyd

unread,
Nov 28, 2012, 10:06:21 AM11/28/12
to spring...@googlegroups.com
Here's an overview of explore related api methods:

  /**
   * Returns notebooks that are in the explore section. This is paged via the standard 'X-Spring-Next-Token' and 'start'
   * query param method discussed elsewhere.
   *
   * @api.param start start token for paging
   * @api.param format controls the amount of data included in the JSON response
   * @api.param text a search term to further filter the query
   * @api.param tag filter on a tag
   * @api.param users comma seperated list of username or uuid to restrict the search to
   * @api.returns a JSON list of notebooks formatted based on format parameter
   */
  @RequestMapping(value = "/explore/notebooks", method = RequestMethod.GET)

  /**
   * Returns notebooks that are in the explore section filtered to a category.
   * This is paged via the standard 'X-Spring-Next-Token' and 'start' query param method discussed elsewhere.
   *
   * @param category category name to filter the query
   * @api.param start start token for paging
   * @api.param format controls the amount of data included in the JSON response
   * @api.param sort must be one of: popular, created, trending
   * @api.param text a search term to further filter the query
   * @api.param tag filter on a tag
   * @api.param users comma seperated list of username or uuid to restrict the search to
   * @api.returns a JSON list of notebooks formatted based on format parameter
   * @api.error 400 if an invalid sort is passed in
   */
  @RequestMapping(value = "/explore/notebooks/categories/{category}", method = RequestMethod.GET)

  /**
   * Returns blocks that are in the explore section. This is paged via the standard 'X-Spring-Next-Token' and 'start'
   * query param method discussed elsewhere.
   *
   * @api.param start start token for paging
   * @api.param format controls the amount of data included in the JSON response
   * @api.param text a search term to further filter the query
   * @api.param tag filter on a tag
   * @api.param highlightable if true only blocks fit for being highlighted (pretty) will be returned (default: true)
   * @api.param users comma seperated list of username or uuid to restrict the search to
   * @api.param sbrOnly boolean indicating if the results should contain only SBR information (no user info)
   * @api.returns a JSON list of blocks formatted based on format parameter
   */
  @RequestMapping(value = "/explore/blocks", method = RequestMethod.GET)

  /**
   * Returns blocks that are in the explore section filtered by category. This is paged via the standard 'X-Spring-Next-Token' and 'start'
   * query param method discussed elsewhere.
   *
   * @param category category name to filter the query
   * @api.param start start token for paging
   * @api.param format controls the amount of data included in the JSON response
   * @api.param text a search term to further filter the query
   * @api.param sort must be one of: popular, created, trending
   * @api.param tag filter on a tag
   * @api.param highlightable if true only blocks fit for being highlighted (pretty) will be returned (default: true)
   * @api.param users comma seperated list of username or uuid to restrict the search to
   * @api.param sbrOnly boolean indicating if the results should contain only SBR information (no user info)
   * @api.returns a JSON list of blocks formatted based on format parameter
   * @api.error 400 if an invalid sort is passed in
   */
  @RequestMapping(value = "/explore/blocks/categories/{category}", method = RequestMethod.GET)

/**
 * returns top tags
 */
  @RequestMapping(value = "/explore/tags", method = RequestMethod.GET)

  /**
   * top tags for a category
   */
  @RequestMapping(value = "/explore/tags/categories/{category}", method = RequestMethod.GET)

Pete Aykroyd

unread,
Nov 28, 2012, 10:07:33 AM11/28/12
to spring...@googlegroups.com
Caroline, sorry for the unwanted emails. You subscribed through google groups, so you can go there and unsubscribe yourself. Let me know if you are unable to do that.

Regards,

Pete
Reply all
Reply to author
Forward
0 new messages