To keep the Yottaa API consistant and simply Yottaa shares parameters across multiple functions.

API Calls that return lists objects share a common set of searching and filtering parameters, and parameter defined with a star(*) means this is required, otherwise is optional.

List Filtering Parameters

per_page: The maximum number of benchmarks objects that are returned for this request. Default (20)

page

The set of benchmark objects that are returned. Example page=2&per_page=7. The request will return 8-14. Default (1)

search_term

Check the method’s “search_term” options to see the values this parameter can be equal to.

query

The value that will be searched for. Default (null)

List Sorting Parameters

sort_by

Check the method’s “sort_by” options to see the values this parameter can be equal to.

direction

(asc | desc) - default is desc.