Module: BlippexAPI::Client::Search

Included in:
BlippexAPI::Client
Defined in:
lib/blippex_api/client/search.rb

Instance Method Summary collapse

Instance Method Details

#search(opts = {}) ⇒ Hashie::Mash

Get search data

Parameters:

  • opts (String) (defaults to: {}) —

    q search term

Options Hash (opts):

  • w (Integer) —

    the scoring of the searchterms has on the ranking of the search result in percent

  • d (Integer) —

    the number of days the search should go back

  • highlight (Integer) —

    highlight=1 if you want to add an excerpt of the text with a the highlighted search terms

  • limit (Integer) —

    this is the number of individual objects that are returned (maximum 100)

  • offset (Integer) —

    this offsets the start of the results by the number specified

  • callback (String) —

    the response will use the JSONP format with a callback of the given name

Returns:

  • (Hashie::Mash) —

    Hash containing the response



15
16
17
 
# File 'lib/blippex_api/client/search.rb', line 15

def search opts={}
  get 'search', opts
end