Module: Keen::Client::QueryingMethods
- Included in:
- Keen::Client
- Defined in:
- lib/keen/client/querying_methods.rb
Instance Method Summary collapse
-
#average(event_collection, params, options = {}) ⇒ Object
Runs a average query.
-
#count(event_collection, params = {}, options = {}) ⇒ Object
Runs a count query.
-
#count_unique(event_collection, params, options = {}) ⇒ Object
Runs a count unique query.
-
#extraction(event_collection, params = {}, options = {}) ⇒ Object
Runs a extraction query.
-
#funnel(params, options = {}) ⇒ Object
Runs a funnel query.
-
#maximum(event_collection, params, options = {}) ⇒ Object
Runs a maximum query.
-
#median(event_collection, params, options = {}) ⇒ Object
Runs a median query.
-
#minimum(event_collection, params, options = {}) ⇒ Object
Runs a minimum query.
-
#multi_analysis(event_collection, params, options = {}) ⇒ Object
Runs a multi-analysis query See detailed documentation here: keen.io/docs/data-analysis/multi-analysis/.
-
#percentile(event_collection, params, options = {}) ⇒ Object
Runs a percentile query.
-
#query(analysis_type, event_collection, params = {}, options = {}) ⇒ Object
Run a query.
-
#query_url(analysis_type, event_collection, params = {}, options = {}) ⇒ Object
Returns the URL for a Query without running it.
-
#select_unique(event_collection, params, options = {}) ⇒ Object
Runs a select_unique query.
-
#sum(event_collection, params, options = {}) ⇒ Object
Runs a sum query.
Instance Method Details
#average(event_collection, params, options = {}) ⇒ Object
Runs a average query. See detailed documentation here: keen.io/docs/api/reference/#average-resource
98 99 100 |
# File 'lib/keen/client/querying_methods.rb', line 98 def average(event_collection, params, ={}) query(__method__, event_collection, params, ) end |
#count(event_collection, params = {}, options = {}) ⇒ Object
Runs a count query. See detailed documentation here: keen.io/docs/api/reference/#count-resource
18 19 20 |
# File 'lib/keen/client/querying_methods.rb', line 18 def count(event_collection, params={}, ={}) query(__method__, event_collection, params, ) end |
#count_unique(event_collection, params, options = {}) ⇒ Object
Runs a count unique query. See detailed documentation here: keen.io/docs/api/reference/#count-unique-resource
34 35 36 |
# File 'lib/keen/client/querying_methods.rb', line 34 def count_unique(event_collection, params, ={}) query(__method__, event_collection, params, ) end |
#extraction(event_collection, params = {}, options = {}) ⇒ Object
Runs a extraction query. See detailed documentation here: keen.io/docs/api/reference/#extraction-resource
164 165 166 |
# File 'lib/keen/client/querying_methods.rb', line 164 def extraction(event_collection, params={}, ={}) query(__method__, event_collection, params, ) end |
#funnel(params, options = {}) ⇒ Object
Runs a funnel query. See detailed documentation here: keen.io/docs/api/reference/#funnel-resource
175 176 177 |
# File 'lib/keen/client/querying_methods.rb', line 175 def funnel(params, ={}) query(__method__, nil, params, ) end |
#maximum(event_collection, params, options = {}) ⇒ Object
Runs a maximum query. See detailed documentation here: keen.io/docs/api/reference/#maximum-resource
66 67 68 |
# File 'lib/keen/client/querying_methods.rb', line 66 def maximum(event_collection, params, ={}) query(__method__, event_collection, params, ) end |
#median(event_collection, params, options = {}) ⇒ Object
Runs a median query. See detailed documentation here: keen.io/docs/api/reference/#median-resource
114 115 116 |
# File 'lib/keen/client/querying_methods.rb', line 114 def median(event_collection, params, ={}) query(__method__, event_collection, params, ) end |
#minimum(event_collection, params, options = {}) ⇒ Object
Runs a minimum query. See detailed documentation here: keen.io/docs/api/reference/#minimum-resource
50 51 52 |
# File 'lib/keen/client/querying_methods.rb', line 50 def minimum(event_collection, params, ={}) query(__method__, event_collection, params, ) end |
#multi_analysis(event_collection, params, options = {}) ⇒ Object
Runs a multi-analysis query See detailed documentation here: keen.io/docs/data-analysis/multi-analysis/
NOTE: why isn’t multi-analysis listed in the
API Technical Reference?
192 193 194 |
# File 'lib/keen/client/querying_methods.rb', line 192 def multi_analysis(event_collection, params, ={}) query(__method__, event_collection, params, ) end |
#percentile(event_collection, params, options = {}) ⇒ Object
Runs a percentile query. See detailed documentation here: keen.io/docs/api/reference/#percentile-resource
131 132 133 |
# File 'lib/keen/client/querying_methods.rb', line 131 def percentile(event_collection, params, ={}) query(__method__, event_collection, params, ) end |
#query(analysis_type, event_collection, params = {}, options = {}) ⇒ Object
Run a query
222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/keen/client/querying_methods.rb', line 222 def query(analysis_type, event_collection, params={}, ={}) response = if [:method] == :post post_query(analysis_type, event_collection, params, ) else url = _query_url(analysis_type, event_collection, params, ) get_response(url, ) end response_body = response.body.chomp api_result = process_response(response.code, response_body) api_result = api_result["result"] unless [:response] == :all_keys api_result end |
#query_url(analysis_type, event_collection, params = {}, options = {}) ⇒ Object
Returns the URL for a Query without running it
207 208 209 210 211 |
# File 'lib/keen/client/querying_methods.rb', line 207 def query_url(analysis_type, event_collection, params={}, ={}) str = _query_url(analysis_type, event_collection, params, ) str << "&api_key=#{self.read_key}" unless [:exclude_api_key] str end |
#select_unique(event_collection, params, options = {}) ⇒ Object
Runs a select_unique query. See detailed documentation here: keen.io/docs/api/reference/#select-unique-resource
147 148 149 |
# File 'lib/keen/client/querying_methods.rb', line 147 def select_unique(event_collection, params, ={}) query(__method__, event_collection, params, ) end |
#sum(event_collection, params, options = {}) ⇒ Object
Runs a sum query. See detailed documentation here: keen.io/docs/api/reference/#sum-resource
82 83 84 |
# File 'lib/keen/client/querying_methods.rb', line 82 def sum(event_collection, params, ={}) query(__method__, event_collection, params, ) end |