Class: Algolia::AnalyticsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/api/analytics_client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = nil) ⇒ AnalyticsClient

Returns a new instance of AnalyticsClient.



7
8
9
10
11
12
13
 
# File 'lib/algolia/api/analytics_client.rb', line 7

def initialize(config = nil)
  raise "`config` is missing." if config.nil?
  raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
  raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""

  @api_client = Algolia::ApiClient.new(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/algolia/api/analytics_client.rb', line 5

def api_client
  @api_client
end

Class Method Details

.create(app_id, api_key, region = nil, opts = {}) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/algolia/api/analytics_client.rb', line 15

def self.create(app_id, api_key, region = nil, opts = {})
  hosts = []
  regions = ["de", "us"]

  if region.is_a?(Hash) && (opts.nil? || opts.empty?)
    opts = region
    region = nil
  end

  if !region.nil? && (!region.is_a?(String) || !regions.include?(region))
    raise "`region` must be one of the following: #{regions.join(", ")}"
  end

  hosts <<
    Transport::StatefulHost.new(
      region.nil? ? "analytics.algolia.com" : "analytics.{region}.algolia.com".sub!("{region}", region),
      accept: CallType::READ | CallType::WRITE
    )

  config = Algolia::Configuration.new(app_id, api_key, hosts, "Analytics", opts)
  create_with_config(config)
end

.create_with_config(config) ⇒ Object 



38
39
40
 
# File 'lib/algolia/api/analytics_client.rb', line 38

def self.create_with_config(config)
  new(config)
end

Instance Method Details

#add_user_agent_segment(segment, version = nil) ⇒ Object 



52
53
54
55
56
 
# File 'lib/algolia/api/analytics_client.rb', line 52

def add_user_agent_segment(segment, version = nil)
  @api_client.config.add_user_agent_segment(segment, version)

  self
end

#custom_delete(path, parameters = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after "/1" must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


96
97
98
99
 
# File 'lib/algolia/api/analytics_client.rb', line 96

def custom_delete(path, parameters = nil, request_options = {})
  response = custom_delete_with_http_info(path, parameters, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_delete_with_http_info(path, parameters = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after "/1" must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/algolia/api/analytics_client.rb', line 64

def custom_delete_with_http_info(path, parameters = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.custom_delete",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#custom_get(path, parameters = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after "/1" must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


139
140
141
142
 
# File 'lib/algolia/api/analytics_client.rb', line 139

def custom_get(path, parameters = nil, request_options = {})
  response = custom_get_with_http_info(path, parameters, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_get_with_http_info(path, parameters = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after "/1" must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/algolia/api/analytics_client.rb', line 107

def custom_get_with_http_info(path, parameters = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.custom_get",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#custom_post(path, parameters = nil, body = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after "/1" must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


184
185
186
187
 
# File 'lib/algolia/api/analytics_client.rb', line 184

def custom_post(path, parameters = nil, body = nil, request_options = {})
  response = custom_post_with_http_info(path, parameters, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after "/1" must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/algolia/api/analytics_client.rb', line 151

def custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.custom_post",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#custom_put(path, parameters = nil, body = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after "/1" must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


229
230
231
232
 
# File 'lib/algolia/api/analytics_client.rb', line 229

def custom_put(path, parameters = nil, body = nil, request_options = {})
  response = custom_put_with_http_info(path, parameters, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after "/1" must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/algolia/api/analytics_client.rb', line 196

def custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.custom_put",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetAddToCartRateResponse

Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetAddToCartRateResponse) 


283
284
285
286
287
288
289
 
# File 'lib/algolia/api/analytics_client.rb', line 283

def get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_add_to_cart_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetAddToCartRateResponse"
  )
end

#get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/algolia/api/analytics_client.rb', line 244

def get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_add_to_cart_rate`."
  end

  path = "/2/conversions/addToCartRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_add_to_cart_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetAverageClickPositionResponse

Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results’ positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetAverageClickPositionResponse) 


346
347
348
349
350
351
352
 
# File 'lib/algolia/api/analytics_client.rb', line 346

def get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_average_click_position_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetAverageClickPositionResponse"
  )
end

#get_average_click_position_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results’ positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/algolia/api/analytics_client.rb', line 301

def get_average_click_position_with_http_info(
  index,
  start_date = nil,
  end_date = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_average_click_position`."
  end

  path = "/2/clicks/averageClickPosition"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_average_click_position",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetClickPositionsResponse

Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetClickPositionsResponse) 


403
404
405
406
407
408
409
 
# File 'lib/algolia/api/analytics_client.rb', line 403

def get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_click_positions_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetClickPositionsResponse"
  )
end

#get_click_positions_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/algolia/api/analytics_client.rb', line 364

def get_click_positions_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_click_positions`."
  end

  path = "/2/clicks/positions"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_click_positions",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetClickThroughRateResponse

Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetClickThroughRateResponse) 


460
461
462
463
464
465
466
 
# File 'lib/algolia/api/analytics_client.rb', line 460

def get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_click_through_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetClickThroughRateResponse"
  )
end

#get_click_through_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/algolia/api/analytics_client.rb', line 421

def get_click_through_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_click_through_rate`."
  end

  path = "/2/clicks/clickThroughRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_click_through_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetConversionRateResponse

Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetConversionRateResponse) 


517
518
519
520
521
522
523
 
# File 'lib/algolia/api/analytics_client.rb', line 517

def get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_conversion_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetConversionRateResponse"
  )
end

#get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/algolia/api/analytics_client.rb', line 478

def get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_conversion_rate`."
  end

  path = "/2/conversions/conversionRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_conversion_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetNoClickRateResponse

Retrieves the fraction of searches that didn’t lead to any click within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetNoClickRateResponse) 


574
575
576
577
 
# File 'lib/algolia/api/analytics_client.rb', line 574

def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_no_click_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetNoClickRateResponse")
end

#get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the fraction of searches that didn’t lead to any click within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/algolia/api/analytics_client.rb', line 535

def get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_no_click_rate`."
  end

  path = "/2/searches/noClickRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_no_click_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetNoResultsRateResponse

Retrieves the fraction of searches that didn’t return any results within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetNoResultsRateResponse) 


628
629
630
631
632
633
634
 
# File 'lib/algolia/api/analytics_client.rb', line 628

def get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_no_results_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetNoResultsRateResponse"
  )
end

#get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the fraction of searches that didn’t return any results within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/algolia/api/analytics_client.rb', line 589

def get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_no_results_rate`."
  end

  path = "/2/searches/noResultRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_no_results_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetPurchaseRateResponse

Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetPurchaseRateResponse) 


685
686
687
688
689
690
691
 
# File 'lib/algolia/api/analytics_client.rb', line 685

def get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_purchase_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetPurchaseRateResponse"
  )
end

#get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/algolia/api/analytics_client.rb', line 646

def get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_purchase_rate`."
  end

  path = "/2/conversions/purchaseRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_purchase_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetRevenue

Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetRevenue) 


742
743
744
745
 
# File 'lib/algolia/api/analytics_client.rb', line 742

def get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_revenue_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetRevenue")
end

#get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/algolia/api/analytics_client.rb', line 703

def get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_revenue`."
  end

  path = "/2/conversions/revenue"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_revenue",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetSearchesCountResponse

Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetSearchesCountResponse) 


796
797
798
799
800
801
802
 
# File 'lib/algolia/api/analytics_client.rb', line 796

def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_searches_count_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetSearchesCountResponse"
  )
end

#get_searches_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/algolia/api/analytics_client.rb', line 757

def get_searches_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_count`."
  end

  path = "/2/searches/count"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_searches_count",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_searches_no_clicks(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetSearchesNoClicksResponse

Retrieves the most popular searches that didn’t lead to any clicks, from the 1,000 most frequent searches.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetSearchesNoClicksResponse) 


867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'lib/algolia/api/analytics_client.rb', line 867

def get_searches_no_clicks(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_searches_no_clicks_with_http_info(
    index,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetSearchesNoClicksResponse"
  )
end

#get_searches_no_clicks_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the most popular searches that didn’t lead to any clicks, from the 1,000 most frequent searches.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/algolia/api/analytics_client.rb', line 816

def get_searches_no_clicks_with_http_info(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_clicks`."
  end

  path = "/2/searches/noClicks"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_searches_no_clicks",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_searches_no_results(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetSearchesNoResultsResponse

Retrieves the most popular searches that didn’t return any results.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetSearchesNoResultsResponse) 


954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/algolia/api/analytics_client.rb', line 954

def get_searches_no_results(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_searches_no_results_with_http_info(
    index,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetSearchesNoResultsResponse"
  )
end

#get_searches_no_results_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the most popular searches that didn’t return any results.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/algolia/api/analytics_client.rb', line 903

def get_searches_no_results_with_http_info(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_results`."
  end

  path = "/2/searches/noResults"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_searches_no_results",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_status(index, request_options = {}) ⇒ GetStatusResponse

Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetStatusResponse) 


1018
1019
1020
1021
 
# File 'lib/algolia/api/analytics_client.rb', line 1018

def get_status(index, request_options = {})
  response = get_status_with_http_info(index, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetStatusResponse")
end

#get_status_with_http_info(index, request_options = {}) ⇒ Http::Response

Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/algolia/api/analytics_client.rb', line 985

def get_status_with_http_info(index, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_status`."
  end

  path = "/2/status"
  query_params = {}
  query_params[:index] = index
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_status",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_countries(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopCountriesResponse

Retrieves the countries with the most searches to your index.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTopCountriesResponse) 


1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/algolia/api/analytics_client.rb', line 1086

def get_top_countries(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_countries_with_http_info(index, start_date, end_date, limit, offset, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetTopCountriesResponse"
  )
end

#get_top_countries_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the countries with the most searches to your index.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'lib/algolia/api/analytics_client.rb', line 1035

def get_top_countries_with_http_info(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_countries`."
  end

  path = "/2/countries"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_countries",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_filter_attributes(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopFilterAttributesResponse

Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the ‘attributesForFaceting` setting.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • search (String) (defaults to: nil) —

    Search query.

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTopFilterAttributesResponse) 


1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/algolia/api/analytics_client.rb', line 1169

def get_top_filter_attributes(
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_filter_attributes_with_http_info(
    index,
    search,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetTopFilterAttributesResponse"
  )
end

#get_top_filter_attributes_with_http_info(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the ‘attributesForFaceting` setting.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • search (String) (defaults to: nil) —

    Search query.

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/algolia/api/analytics_client.rb', line 1115

def get_top_filter_attributes_with_http_info(
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_attributes`."
  end

  path = "/2/filters"
  query_params = {}
  query_params[:index] = index
  query_params[:search] = search unless search.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_filter_attributes",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_filter_for_attribute(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopFilterForAttributeResponse

Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the ‘attributesForFaceting` setting.

Required API Key ACLs:

- analytics

Parameters:

  • attribute (String) —

    Attribute name. (required)

  • index (String) —

    Index name. (required)

  • search (String) (defaults to: nil) —

    Search query.

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTopFilterForAttributeResponse) 


1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/algolia/api/analytics_client.rb', line 1269

def get_top_filter_for_attribute(
  attribute,
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_filter_for_attribute_with_http_info(
    attribute,
    index,
    search,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetTopFilterForAttributeResponse"
  )
end

#get_top_filter_for_attribute_with_http_info(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the ‘attributesForFaceting` setting.

Required API Key ACLs:

- analytics

Parameters:

  • attribute (String) —

    Attribute name. (required)

  • index (String) —

    Index name. (required)

  • search (String) (defaults to: nil) —

    Search query.

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/algolia/api/analytics_client.rb', line 1209

def get_top_filter_for_attribute_with_http_info(
  attribute,
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'attribute' is set
  if @api_client.config.client_side_validation && attribute.nil?
    raise ArgumentError, "Parameter `attribute` is required when calling `get_top_filter_for_attribute`."
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_for_attribute`."
  end

  path = "/2/filters/{attribute}".sub("{" + "attribute" + "}", Transport.encode_uri(attribute.to_s))
  query_params = {}
  query_params[:index] = index
  query_params[:search] = search unless search.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_filter_for_attribute",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_filters_no_results(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopFiltersNoResultsResponse

Retrieves the most frequently used filters for a search that didn’t return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • search (String) (defaults to: nil) —

    Search query.

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTopFiltersNoResultsResponse) 


1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'lib/algolia/api/analytics_client.rb', line 1364

def get_top_filters_no_results(
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_filters_no_results_with_http_info(
    index,
    search,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetTopFiltersNoResultsResponse"
  )
end

#get_top_filters_no_results_with_http_info(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the most frequently used filters for a search that didn’t return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • search (String) (defaults to: nil) —

    Search query.

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/algolia/api/analytics_client.rb', line 1310

def get_top_filters_no_results_with_http_info(
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filters_no_results`."
  end

  path = "/2/filters/noResults"
  query_params = {}
  query_params[:index] = index
  query_params[:search] = search unless search.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_filters_no_results",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_hits(index, search = nil, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopHitsResponse

Retrieves the object IDs of the most frequent search results.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • search (String) (defaults to: nil) —

    Search query.

  • click_analytics (Boolean) (defaults to: nil) —

    Whether to include metrics related to click and conversion events in the response. (default to false)

  • revenue_analytics (Boolean) (defaults to: nil) —

    Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTopHitsResponse) 


1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'lib/algolia/api/analytics_client.rb', line 1465

def get_top_hits(
  index,
  search = nil,
  click_analytics = nil,
  revenue_analytics = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_hits_with_http_info(
    index,
    search,
    click_analytics,
    revenue_analytics,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopHitsResponse")
end

#get_top_hits_with_http_info(index, search = nil, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the object IDs of the most frequent search results.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • search (String) (defaults to: nil) —

    Search query.

  • click_analytics (Boolean) (defaults to: nil) —

    Whether to include metrics related to click and conversion events in the response. (default to false)

  • revenue_analytics (Boolean) (defaults to: nil) —

    Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/algolia/api/analytics_client.rb', line 1405

def get_top_hits_with_http_info(
  index,
  search = nil,
  click_analytics = nil,
  revenue_analytics = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_hits`."
  end

  path = "/2/hits"
  query_params = {}
  query_params[:index] = index
  query_params[:search] = search unless search.nil?
  query_params[:clickAnalytics] = click_analytics unless click_analytics.nil?
  query_params[:revenueAnalytics] = revenue_analytics unless revenue_analytics.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_hits",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_searches(index, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopSearchesResponse

Returns the most popular search terms.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • click_analytics (Boolean) (defaults to: nil) —

    Whether to include metrics related to click and conversion events in the response. (default to false)

  • revenue_analytics (Boolean) (defaults to: nil) —

    Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • order_by (OrderBy) (defaults to: nil) —

    Attribute by which to order the response items. If the ‘clickAnalytics` parameter is false, only `searchCount` is available. (default to ’searchCount’)

  • direction (Direction) (defaults to: nil) —

    Sorting direction of the results: ascending or descending. (default to ‘asc’)

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetTopSearchesResponse) 


1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
 
# File 'lib/algolia/api/analytics_client.rb', line 1571

def get_top_searches(
  index,
  click_analytics = nil,
  revenue_analytics = nil,
  start_date = nil,
  end_date = nil,
  order_by = nil,
  direction = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_searches_with_http_info(
    index,
    click_analytics,
    revenue_analytics,
    start_date,
    end_date,
    order_by,
    direction,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopSearchesResponse")
end

#get_top_searches_with_http_info(index, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

Returns the most popular search terms.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • click_analytics (Boolean) (defaults to: nil) —

    Whether to include metrics related to click and conversion events in the response. (default to false)

  • revenue_analytics (Boolean) (defaults to: nil) —

    Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • order_by (OrderBy) (defaults to: nil) —

    Attribute by which to order the response items. If the ‘clickAnalytics` parameter is false, only `searchCount` is available. (default to ’searchCount’)

  • direction (Direction) (defaults to: nil) —

    Sorting direction of the results: ascending or descending. (default to ‘asc’)

  • limit (Integer) (defaults to: nil) —

    Number of items to return. (default to 10)

  • offset (Integer) (defaults to: nil) —

    Position of the first item to return. (default to 0)

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
 
# File 'lib/algolia/api/analytics_client.rb', line 1508

def get_top_searches_with_http_info(
  index,
  click_analytics = nil,
  revenue_analytics = nil,
  start_date = nil,
  end_date = nil,
  order_by = nil,
  direction = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_searches`."
  end

  path = "/2/searches"
  query_params = {}
  query_params[:index] = index
  query_params[:clickAnalytics] = click_analytics unless click_analytics.nil?
  query_params[:revenueAnalytics] = revenue_analytics unless revenue_analytics.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:orderBy] = order_by unless order_by.nil?
  query_params[:direction] = direction unless direction.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_searches",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetUsersCountResponse

Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number. By default, Algolia distinguishes search users by their IP address, unless you include a pseudonymous user identifier in your search requests with the ‘userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (GetUsersCountResponse) 


1649
1650
1651
1652
 
# File 'lib/algolia/api/analytics_client.rb', line 1649

def get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_users_count_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetUsersCountResponse")
end

#get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number. By default, Algolia distinguishes search users by their IP address, unless you include a pseudonymous user identifier in your search requests with the ‘userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

  • index (String) —

    Index name. (required)

  • start_date (String) (defaults to: nil) —

    Start date of the period to analyze, in ‘YYYY-MM-DD` format.

  • end_date (String) (defaults to: nil) —

    End date of the period to analyze, in ‘YYYY-MM-DD` format.

  • tags (String) (defaults to: nil) —

    Tags by which to segment the analytics. You can combine multiple tags with ‘OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
 
# File 'lib/algolia/api/analytics_client.rb', line 1610

def get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_users_count`."
  end

  path = "/2/users/count"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_users_count",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#set_client_api_key(api_key) ⇒ void

This method returns an undefined value.

Helper method to switch the API key used to authenticate the requests.

Parameters:

  • api_key (String) —

    the new API key to use.



46
47
48
49
50
 
# File 'lib/algolia/api/analytics_client.rb', line 46

def set_client_api_key(api_key)
  @api_client.set_client_api_key(api_key)

  self
end