Module: Swiftype::Client::Analytics
- Included in:
- Swiftype::Client
- Defined in:
- lib/swiftype/client.rb
Overview
The analytics API provides a way to export analytics data similar to what is found in the Swiftype Dashboard. See the REST API Documentation for details.
Instance Method Summary collapse
-
#analytics_autoselects(engine_id, options = {}) ⇒ Object
Return the number of autoselects (when a user clicks a result from an autocomplete dropdown) that occurred on each day in the time range for the provided Engine and optional DocumentType.
-
#analytics_clicks(engine_id, options = {}) ⇒ Object
Return the number of clickthroughs (when a user clicks a result from a search results page) that occurred on each day in the time range for the provided Engine and optional DocumentType.
-
#analytics_searches(engine_id, options = {}) ⇒ Object
Return the number of searches that occurred on each day in the time range for the provided Engine and optional DocumentType.
-
#analytics_top_no_result_queries(engine_id, options = {}) ⇒ Object
Return top queries with no results for an engine.
-
#analytics_top_queries(engine_id, options = {}) ⇒ Object
Return top queries for an engine.
Instance Method Details
#analytics_autoselects(engine_id, options = {}) ⇒ Object
Return the number of autoselects (when a user clicks a result from an autocomplete dropdown) that occurred on each day in the time range for the provided Engine and optional DocumentType. The maximum time range between start and end dates is 30 days.
342 343 344 345 346 347 348 349 |
# File 'lib/swiftype/client.rb', line 342 def analytics_autoselects(engine_id, ={}) document_type_id = .delete(:document_type_id) if document_type_id get("engines/#{engine_id}/document_types/#{document_type_id}/analytics/autoselects.json", ) else get("engines/#{engine_id}/analytics/autoselects.json", ) end end |
#analytics_clicks(engine_id, options = {}) ⇒ Object
Return the number of clickthroughs (when a user clicks a result from a search results page) that occurred on each day in the time range for the provided Engine and optional DocumentType. The maximum time range between start and end dates is 30 days.
360 361 362 363 364 365 366 367 |
# File 'lib/swiftype/client.rb', line 360 def analytics_clicks(engine_id, ={}) document_type_id = .delete(:document_type_id) if document_type_id get("engines/#{engine_id}/document_types/#{document_type_id}/analytics/clicks.json", ) else get("engines/#{engine_id}/analytics/clicks.json", ) end end |
#analytics_searches(engine_id, options = {}) ⇒ Object
Return the number of searches that occurred on each day in the time range for the provided Engine and optional DocumentType. The maximum time range between start and end dates is 30 days.
324 325 326 327 328 329 330 331 |
# File 'lib/swiftype/client.rb', line 324 def analytics_searches(engine_id, ={}) document_type_id = .delete(:document_type_id) if document_type_id get("engines/#{engine_id}/document_types/#{document_type_id}/analytics/searches.json", ) else get("engines/#{engine_id}/analytics/searches.json", ) end end |
#analytics_top_no_result_queries(engine_id, options = {}) ⇒ Object
Return top queries with no results for an engine.
389 390 391 |
# File 'lib/swiftype/client.rb', line 389 def analytics_top_no_result_queries(engine_id, ={}) get("engines/#{engine_id}/analytics/top_no_result_queries.json", ) end |
#analytics_top_queries(engine_id, options = {}) ⇒ Object
Return top queries for an engine.
377 378 379 |
# File 'lib/swiftype/client.rb', line 377 def analytics_top_queries(engine_id, ={}) get("engines/#{engine_id}/analytics/top_queries.json", ) end |