Method: HalcyonAPI::Client#samples

Defined in:

lib/halcyon_api/client.rb

#samples(filter_params = {}) ⇒ OpenStruct

Gets batches of random match data

Examples:

Get samples

client = VaingloryAPI::Client.new('API_KEY', 'na')
client.samples

Parameters:

• filter_params (Hash) (defaults to: {}) —

  the parameters used to filter results

Options Hash (filter_params):

• 'page[offset]' (String) — default: 0 —

  Allows paging over results

• 'page[limit]' (String) — default: 50 —

  Values less than 50 and great than 2 are supported.

• 'sort' (String) — default: createdAt —

  By default, Matches are sorted by creation time ascending.

• 'filter[createdAt-start]' (String) — default: 3hrs ago —

  Must occur before end time. Format is iso8601

• 'filter[createdAt-end]' (String) — default: Now —

  Queries search the last 3 hrs. Format is iso8601

Returns:

• (OpenStruct) —

  the response and metadata

See Also:

• Vainglory API "Samples"
• Vainglory API "Pagination"
• Vainglory API "Sorting"

# File 'lib/halcyon_api/client.rb', line 46

def samples(filter_params = {})
  get_request(shard_endpoint_uri('samples', filter_params))
end