Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.55 KB

Get Datasets.md

File metadata and controls

33 lines (24 loc) · 1.55 KB

Get Projects

Data Sets help structure information on WikiRate by combining Companies and Metrics associated with a particular Topic or theme.

This example assumes you have configured your Wikirate REST client. Instructions on how to configure a client can be found in examples/Configurations.md

The get_datasets method take as an input a Hash where the user can define the parameters of their request. More specifically, we could divide our params in two different types of parameters, the endpoint parameters and the filter parameters. The endpoint parameters help us to iterate through our query's results and the filter parameters allow us to restrict our results based on specific given input.

endpoint params:
  • limit: default value 20, the maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
  • offset: default value 0, the (zero-based) offset of the first item in the collection to return

filter params:

  • name: returns datasets that contain in their name the given string
  • wikirate_topic: returns datasets that fall under the defined wikirate topic. All wikirate topics can be found here.

In the example below, we are looking for datasets related to Fashion.

datasets = client.get_datasets({ 'wikirate_topic' => 'fashion' })
puts datasets