algolia 3.0.0.beta.8 → 3.0.0.beta.10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/release.yml +2 -0
- data/CHANGELOG.md +15 -0
- data/Gemfile.lock +6 -31
- data/Rakefile +0 -2
- data/algolia.gemspec +1 -1
- data/lib/algolia/api/abtesting_client.rb +52 -37
- data/lib/algolia/api/analytics_client.rb +415 -116
- data/lib/algolia/api/ingestion_client.rb +462 -182
- data/lib/algolia/api/insights_client.rb +45 -28
- data/lib/algolia/api/monitoring_client.rb +50 -44
- data/lib/algolia/api/personalization_client.rb +57 -32
- data/lib/algolia/api/query_suggestions_client.rb +59 -40
- data/lib/algolia/api/recommend_client.rb +70 -43
- data/lib/algolia/api/search_client.rb +474 -277
- data/lib/algolia/api/usage_client.rb +48 -28
- data/lib/algolia/api_client.rb +25 -24
- data/lib/algolia/api_error.rb +8 -8
- data/lib/algolia/configuration.rb +17 -6
- data/lib/algolia/error.rb +2 -2
- data/lib/algolia/logger_helper.rb +4 -4
- data/lib/algolia/models/abtesting/ab_test.rb +62 -37
- data/lib/algolia/models/abtesting/ab_test_configuration.rb +35 -20
- data/lib/algolia/models/abtesting/ab_test_response.rb +35 -20
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +38 -23
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +41 -26
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +38 -23
- data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +33 -24
- data/lib/algolia/models/abtesting/currency.rb +32 -20
- data/lib/algolia/models/abtesting/custom_search_params.rb +33 -18
- data/lib/algolia/models/abtesting/effect.rb +2 -3
- data/lib/algolia/models/abtesting/empty_search.rb +33 -18
- data/lib/algolia/models/abtesting/error_base.rb +24 -13
- data/lib/algolia/models/abtesting/filter_effects.rb +34 -19
- data/lib/algolia/models/abtesting/filter_effects_empty_search.rb +34 -19
- data/lib/algolia/models/abtesting/filter_effects_outliers.rb +34 -19
- data/lib/algolia/models/abtesting/list_ab_tests_response.rb +37 -22
- data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +37 -22
- data/lib/algolia/models/abtesting/outliers.rb +29 -17
- data/lib/algolia/models/abtesting/status.rb +2 -3
- data/lib/algolia/models/abtesting/variant.rb +83 -51
- data/lib/algolia/models/analytics/click_positions_inner.rb +39 -24
- data/lib/algolia/models/analytics/currencies_value.rb +34 -19
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +42 -27
- data/lib/algolia/models/analytics/daily_average_clicks.rb +40 -25
- data/lib/algolia/models/analytics/daily_click_through_rates.rb +42 -27
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +42 -27
- data/lib/algolia/models/analytics/daily_no_click_rates.rb +41 -26
- data/lib/algolia/models/analytics/daily_no_results_rates.rb +39 -24
- data/lib/algolia/models/analytics/daily_purchase_rates.rb +40 -25
- data/lib/algolia/models/analytics/daily_revenue.rb +34 -19
- data/lib/algolia/models/analytics/daily_searches.rb +34 -19
- data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +37 -22
- data/lib/algolia/models/analytics/daily_searches_no_results.rb +37 -22
- data/lib/algolia/models/analytics/daily_users.rb +34 -19
- data/lib/algolia/models/analytics/direction.rb +2 -3
- data/lib/algolia/models/analytics/error_base.rb +24 -13
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +42 -27
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +40 -25
- data/lib/algolia/models/analytics/get_click_positions_response.rb +36 -21
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +42 -27
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +42 -27
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +41 -26
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +39 -24
- data/lib/algolia/models/analytics/get_purchase_rate_response.rb +40 -25
- data/lib/algolia/models/analytics/get_revenue.rb +34 -19
- data/lib/algolia/models/analytics/get_searches_count_response.rb +34 -19
- data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +33 -18
- data/lib/algolia/models/analytics/get_searches_no_results_response.rb +33 -18
- data/lib/algolia/models/analytics/get_status_response.rb +35 -20
- data/lib/algolia/models/analytics/get_top_countries_response.rb +33 -18
- data/lib/algolia/models/analytics/get_top_filter_attribute.rb +34 -19
- data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +33 -18
- data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +36 -21
- data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +33 -18
- data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +35 -20
- data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +35 -20
- data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +34 -19
- data/lib/algolia/models/analytics/get_top_hits_response.rb +34 -25
- data/lib/algolia/models/analytics/get_top_searches_response.rb +34 -25
- data/lib/algolia/models/analytics/get_users_count_response.rb +34 -19
- data/lib/algolia/models/analytics/operator.rb +2 -3
- data/lib/algolia/models/analytics/order_by.rb +2 -3
- data/lib/algolia/models/analytics/top_country.rb +34 -19
- data/lib/algolia/models/analytics/top_hit.rb +30 -18
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +50 -35
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +77 -50
- data/lib/algolia/models/analytics/top_hits_response.rb +33 -18
- data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +33 -18
- data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +33 -18
- data/lib/algolia/models/analytics/top_search.rb +35 -20
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +76 -44
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +94 -58
- data/lib/algolia/models/analytics/top_searches_response.rb +33 -18
- data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +33 -18
- data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +33 -18
- data/lib/algolia/models/ingestion/action_type.rb +2 -3
- data/lib/algolia/models/ingestion/auth_algolia.rb +34 -19
- data/lib/algolia/models/ingestion/auth_algolia_insights.rb +34 -19
- data/lib/algolia/models/ingestion/auth_algolia_insights_partial.rb +34 -19
- data/lib/algolia/models/ingestion/auth_algolia_partial.rb +34 -19
- data/lib/algolia/models/ingestion/auth_api_key.rb +33 -18
- data/lib/algolia/models/ingestion/auth_api_key_partial.rb +33 -18
- data/lib/algolia/models/ingestion/auth_basic.rb +34 -19
- data/lib/algolia/models/ingestion/auth_basic_partial.rb +34 -19
- data/lib/algolia/models/ingestion/auth_google_service_account.rb +34 -19
- data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +34 -19
- data/lib/algolia/models/ingestion/auth_input.rb +37 -28
- data/lib/algolia/models/ingestion/auth_input_partial.rb +37 -28
- data/lib/algolia/models/ingestion/auth_o_auth.rb +36 -21
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +36 -21
- data/lib/algolia/models/ingestion/authentication.rb +41 -26
- data/lib/algolia/models/ingestion/authentication_create.rb +38 -23
- data/lib/algolia/models/ingestion/authentication_create_response.rb +35 -20
- data/lib/algolia/models/ingestion/authentication_search.rb +33 -18
- data/lib/algolia/models/ingestion/authentication_sort_keys.rb +2 -3
- data/lib/algolia/models/ingestion/authentication_type.rb +2 -3
- data/lib/algolia/models/ingestion/authentication_update.rb +38 -23
- data/lib/algolia/models/ingestion/authentication_update_response.rb +35 -20
- data/lib/algolia/models/ingestion/big_commerce_channel.rb +34 -19
- data/lib/algolia/models/ingestion/big_commerce_metafield.rb +34 -19
- data/lib/algolia/models/ingestion/big_query_data_type.rb +2 -3
- data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +39 -24
- data/lib/algolia/models/ingestion/delete_response.rb +33 -18
- data/lib/algolia/models/ingestion/destination.rb +39 -24
- data/lib/algolia/models/ingestion/destination_create.rb +36 -21
- data/lib/algolia/models/ingestion/destination_create_response.rb +35 -20
- data/lib/algolia/models/ingestion/destination_index_name.rb +35 -20
- data/lib/algolia/models/ingestion/destination_index_prefix.rb +33 -18
- data/lib/algolia/models/ingestion/destination_input.rb +33 -24
- data/lib/algolia/models/ingestion/destination_search.rb +33 -18
- data/lib/algolia/models/ingestion/destination_sort_keys.rb +2 -3
- data/lib/algolia/models/ingestion/destination_type.rb +2 -3
- data/lib/algolia/models/ingestion/destination_update.rb +36 -21
- data/lib/algolia/models/ingestion/destination_update_response.rb +35 -20
- data/lib/algolia/models/ingestion/docker_image_type.rb +2 -3
- data/lib/algolia/models/ingestion/docker_registry.rb +2 -3
- data/lib/algolia/models/ingestion/{on_demand_date_utils_input.rb → docker_streams_input.rb} +41 -49
- data/lib/algolia/models/ingestion/error_base.rb +24 -13
- data/lib/algolia/models/ingestion/event.rb +38 -26
- data/lib/algolia/models/ingestion/event_sort_keys.rb +2 -3
- data/lib/algolia/models/ingestion/event_status.rb +2 -3
- data/lib/algolia/models/ingestion/event_type.rb +2 -3
- data/lib/algolia/models/ingestion/list_authentications_response.rb +34 -19
- data/lib/algolia/models/ingestion/list_destinations_response.rb +34 -19
- data/lib/algolia/models/ingestion/list_events_response.rb +35 -20
- data/lib/algolia/models/ingestion/list_sources_response.rb +34 -19
- data/lib/algolia/models/ingestion/list_tasks_response.rb +34 -19
- data/lib/algolia/models/ingestion/list_transformations_response.rb +34 -19
- data/lib/algolia/models/ingestion/mapping_field_directive.rb +34 -19
- data/lib/algolia/models/ingestion/mapping_format_schema.rb +2 -3
- data/lib/algolia/models/ingestion/mapping_input.rb +34 -19
- data/lib/algolia/models/ingestion/mapping_kit_action.rb +36 -21
- data/lib/algolia/models/ingestion/mapping_type_csv.rb +2 -3
- data/lib/algolia/models/ingestion/method_type.rb +2 -3
- data/lib/algolia/models/ingestion/on_demand_trigger.rb +34 -19
- data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +33 -18
- data/lib/algolia/models/ingestion/on_demand_trigger_type.rb +2 -3
- data/lib/algolia/models/ingestion/order_keys.rb +2 -3
- data/lib/algolia/models/ingestion/pagination.rb +45 -30
- data/lib/algolia/models/ingestion/platform.rb +2 -3
- data/lib/algolia/models/ingestion/platform_none.rb +2 -3
- data/lib/algolia/models/ingestion/platform_with_none.rb +33 -24
- data/lib/algolia/models/ingestion/record_type.rb +2 -3
- data/lib/algolia/models/ingestion/run.rb +59 -33
- data/lib/algolia/models/ingestion/run_list_response.rb +35 -20
- data/lib/algolia/models/ingestion/run_outcome.rb +2 -3
- data/lib/algolia/models/ingestion/run_progress.rb +34 -19
- data/lib/algolia/models/ingestion/run_reason_code.rb +2 -3
- data/lib/algolia/models/ingestion/run_response.rb +34 -19
- data/lib/algolia/models/ingestion/run_sort_keys.rb +2 -3
- data/lib/algolia/models/ingestion/run_status.rb +2 -3
- data/lib/algolia/models/ingestion/run_type.rb +2 -3
- data/lib/algolia/models/ingestion/schedule_trigger.rb +36 -21
- data/lib/algolia/models/ingestion/schedule_trigger_input.rb +34 -19
- data/lib/algolia/models/ingestion/schedule_trigger_type.rb +2 -3
- data/lib/algolia/models/ingestion/shopify_input.rb +34 -19
- data/lib/algolia/models/ingestion/shopify_market.rb +35 -20
- data/lib/algolia/models/ingestion/shopify_metafield.rb +35 -20
- data/lib/algolia/models/ingestion/sort_keys.rb +2 -3
- data/lib/algolia/models/ingestion/source.rb +35 -23
- data/lib/algolia/models/ingestion/source_big_commerce.rb +37 -22
- data/lib/algolia/models/ingestion/source_big_query.rb +39 -24
- data/lib/algolia/models/ingestion/source_commercetools.rb +38 -23
- data/lib/algolia/models/ingestion/source_create.rb +36 -21
- data/lib/algolia/models/ingestion/source_create_response.rb +35 -20
- data/lib/algolia/models/ingestion/source_csv.rb +43 -25
- data/lib/algolia/models/ingestion/source_docker.rb +37 -22
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +35 -20
- data/lib/algolia/models/ingestion/source_input.rb +39 -30
- data/lib/algolia/models/ingestion/source_json.rb +35 -20
- data/lib/algolia/models/ingestion/source_search.rb +33 -18
- data/lib/algolia/models/ingestion/source_shopify.rb +45 -89
- data/lib/algolia/models/ingestion/source_shopify_base.rb +33 -18
- data/lib/algolia/models/ingestion/source_sort_keys.rb +2 -3
- data/lib/algolia/models/ingestion/source_type.rb +2 -3
- data/lib/algolia/models/ingestion/source_update.rb +35 -20
- data/lib/algolia/models/ingestion/source_update_commercetools.rb +37 -22
- data/lib/algolia/models/ingestion/source_update_docker.rb +36 -21
- data/lib/algolia/models/ingestion/source_update_input.rb +38 -29
- data/lib/algolia/models/ingestion/source_update_response.rb +35 -20
- data/lib/algolia/models/ingestion/source_update_shopify.rb +42 -86
- data/lib/algolia/models/ingestion/source_watch_response.rb +36 -21
- data/lib/algolia/models/ingestion/{streaming_utils_input.rb → streaming_input.rb} +34 -19
- data/lib/algolia/models/ingestion/streaming_trigger.rb +33 -18
- data/lib/algolia/models/ingestion/streaming_trigger_type.rb +2 -3
- data/lib/algolia/models/ingestion/subscription_trigger.rb +33 -18
- data/lib/algolia/models/ingestion/subscription_trigger_type.rb +2 -3
- data/lib/algolia/models/ingestion/task.rb +55 -31
- data/lib/algolia/models/ingestion/task_create.rb +43 -28
- data/lib/algolia/models/ingestion/task_create_response.rb +34 -19
- data/lib/algolia/models/ingestion/task_create_trigger.rb +35 -26
- data/lib/algolia/models/ingestion/task_input.rb +34 -26
- data/lib/algolia/models/ingestion/task_search.rb +33 -18
- data/lib/algolia/models/ingestion/task_sort_keys.rb +2 -3
- data/lib/algolia/models/ingestion/task_update.rb +40 -25
- data/lib/algolia/models/ingestion/task_update_response.rb +34 -19
- data/lib/algolia/models/ingestion/transformation.rb +38 -25
- data/lib/algolia/models/ingestion/transformation_create.rb +35 -22
- data/lib/algolia/models/ingestion/transformation_create_response.rb +34 -19
- data/lib/algolia/models/ingestion/transformation_search.rb +33 -18
- data/lib/algolia/models/ingestion/transformation_try.rb +34 -19
- data/lib/algolia/models/ingestion/transformation_try_response.rb +34 -19
- data/lib/algolia/models/ingestion/transformation_try_response_error.rb +34 -19
- data/lib/algolia/models/ingestion/transformation_update_response.rb +34 -19
- data/lib/algolia/models/ingestion/trigger.rb +35 -26
- data/lib/algolia/models/ingestion/trigger_type.rb +2 -3
- data/lib/algolia/models/ingestion/trigger_update_input.rb +33 -18
- data/lib/algolia/models/ingestion/window.rb +30 -18
- data/lib/algolia/models/insights/add_to_cart_event.rb +2 -3
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +91 -46
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +99 -50
- data/lib/algolia/models/insights/click_event.rb +2 -3
- data/lib/algolia/models/insights/clicked_filters.rb +71 -38
- data/lib/algolia/models/insights/clicked_object_ids.rb +71 -38
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +93 -47
- data/lib/algolia/models/insights/conversion_event.rb +2 -3
- data/lib/algolia/models/insights/converted_filters.rb +71 -38
- data/lib/algolia/models/insights/converted_object_ids.rb +71 -38
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +78 -42
- data/lib/algolia/models/insights/discount.rb +33 -24
- data/lib/algolia/models/insights/error_base.rb +24 -13
- data/lib/algolia/models/insights/events_items.rb +43 -34
- data/lib/algolia/models/insights/events_response.rb +34 -19
- data/lib/algolia/models/insights/insights_events.rb +36 -21
- data/lib/algolia/models/insights/object_data.rb +35 -20
- data/lib/algolia/models/insights/object_data_after_search.rb +42 -24
- data/lib/algolia/models/insights/price.rb +33 -24
- data/lib/algolia/models/insights/purchase_event.rb +2 -3
- data/lib/algolia/models/insights/purchased_object_ids.rb +91 -46
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +91 -46
- data/lib/algolia/models/insights/value.rb +33 -24
- data/lib/algolia/models/insights/view_event.rb +2 -3
- data/lib/algolia/models/insights/viewed_filters.rb +71 -38
- data/lib/algolia/models/insights/viewed_object_ids.rb +71 -38
- data/lib/algolia/models/monitoring/error_base.rb +24 -13
- data/lib/algolia/models/monitoring/get_servers403_response.rb +33 -18
- data/lib/algolia/models/monitoring/incident.rb +30 -18
- data/lib/algolia/models/monitoring/incidents_inner.rb +34 -19
- data/lib/algolia/models/monitoring/incidents_response.rb +33 -18
- data/lib/algolia/models/monitoring/indexing_time_response.rb +33 -18
- data/lib/algolia/models/monitoring/indexing_time_response_metrics.rb +33 -18
- data/lib/algolia/models/monitoring/infrastructure_response.rb +33 -18
- data/lib/algolia/models/monitoring/infrastructure_response_metrics.rb +37 -22
- data/lib/algolia/models/monitoring/inventory_response.rb +33 -18
- data/lib/algolia/models/monitoring/latency_response.rb +33 -18
- data/lib/algolia/models/monitoring/latency_response_metrics.rb +33 -18
- data/lib/algolia/models/monitoring/metric.rb +2 -3
- data/lib/algolia/models/monitoring/period.rb +2 -3
- data/lib/algolia/models/monitoring/probes_metric.rb +34 -19
- data/lib/algolia/models/monitoring/region.rb +2 -3
- data/lib/algolia/models/monitoring/server.rb +35 -23
- data/lib/algolia/models/monitoring/server_status.rb +2 -3
- data/lib/algolia/models/monitoring/status.rb +2 -3
- data/lib/algolia/models/monitoring/status_response.rb +33 -18
- data/lib/algolia/models/monitoring/time_inner.rb +34 -19
- data/lib/algolia/models/monitoring/type.rb +2 -3
- data/lib/algolia/models/personalization/delete_user_profile_response.rb +34 -19
- data/lib/algolia/models/personalization/error_base.rb +24 -13
- data/lib/algolia/models/personalization/event_scoring.rb +35 -20
- data/lib/algolia/models/personalization/event_type.rb +2 -3
- data/lib/algolia/models/personalization/facet_scoring.rb +34 -19
- data/lib/algolia/models/personalization/get_user_token_response.rb +35 -20
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +38 -23
- data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +33 -18
- data/lib/algolia/models/query-suggestions/app_id.rb +29 -17
- data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb +22 -9
- data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_with_index.rb +22 -9
- data/lib/algolia/models/query-suggestions/base_response.rb +34 -19
- data/lib/algolia/models/query-suggestions/configuration.rb +44 -26
- data/lib/algolia/models/query-suggestions/configuration_response.rb +48 -30
- data/lib/algolia/models/query-suggestions/configuration_with_index.rb +46 -28
- data/lib/algolia/models/query-suggestions/error_base.rb +24 -13
- data/lib/algolia/models/query-suggestions/facet.rb +30 -18
- data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +37 -22
- data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +36 -21
- data/lib/algolia/models/query-suggestions/languages.rb +33 -24
- data/lib/algolia/models/query-suggestions/log_level.rb +2 -3
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +34 -16
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +34 -16
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +34 -16
- data/lib/algolia/models/query-suggestions/source_index.rb +49 -34
- data/lib/algolia/models/recommend/advanced_syntax_features.rb +2 -3
- data/lib/algolia/models/recommend/alternatives_as_exact.rb +2 -3
- data/lib/algolia/models/recommend/around_precision.rb +33 -24
- data/lib/algolia/models/recommend/around_precision_from_value_inner.rb +34 -19
- data/lib/algolia/models/recommend/around_radius.rb +33 -24
- data/lib/algolia/models/recommend/around_radius_all.rb +2 -3
- data/lib/algolia/models/recommend/auto_facet_filter.rb +34 -19
- data/lib/algolia/models/recommend/base_recommend_request.rb +42 -27
- data/lib/algolia/models/recommend/base_search_params.rb +110 -63
- data/lib/algolia/models/recommend/base_search_params_without_query.rb +106 -60
- data/lib/algolia/models/recommend/base_search_response.rb +76 -121
- data/lib/algolia/models/recommend/bought_together_query.rb +46 -31
- data/lib/algolia/models/recommend/condition.rb +35 -20
- data/lib/algolia/models/recommend/consequence.rb +39 -24
- data/lib/algolia/models/recommend/deleted_at_response.rb +34 -19
- data/lib/algolia/models/recommend/distinct.rb +33 -24
- data/lib/algolia/models/recommend/error_base.rb +24 -13
- data/lib/algolia/models/recommend/exact_on_single_word_query.rb +2 -3
- data/lib/algolia/models/recommend/exhaustive.rb +37 -22
- data/lib/algolia/models/recommend/facet_filters.rb +33 -24
- data/lib/algolia/models/recommend/facet_ordering.rb +34 -19
- data/lib/algolia/models/recommend/facets.rb +29 -17
- data/lib/algolia/models/recommend/facets_stats.rb +36 -21
- data/lib/algolia/models/recommend/fallback_params.rb +207 -118
- data/lib/algolia/models/recommend/fbt_model.rb +2 -3
- data/lib/algolia/models/recommend/frequently_bought_together.rb +34 -19
- data/lib/algolia/models/recommend/get_recommend_task_response.rb +33 -18
- data/lib/algolia/models/recommend/get_recommendations_params.rb +33 -18
- data/lib/algolia/models/recommend/get_recommendations_response.rb +35 -18
- data/lib/algolia/models/recommend/hide_consequence_object.rb +33 -18
- data/lib/algolia/models/recommend/highlight_result.rb +34 -25
- data/lib/algolia/models/recommend/highlight_result_option.rb +36 -21
- data/lib/algolia/models/recommend/ignore_plurals.rb +33 -24
- data/lib/algolia/models/recommend/index_settings_as_search_params.rb +134 -75
- data/lib/algolia/models/recommend/looking_similar.rb +35 -20
- data/lib/algolia/models/recommend/looking_similar_model.rb +2 -3
- data/lib/algolia/models/recommend/looking_similar_query.rb +47 -32
- data/lib/algolia/models/recommend/match_level.rb +2 -3
- data/lib/algolia/models/recommend/matched_geo_location.rb +35 -20
- data/lib/algolia/models/recommend/mode.rb +2 -3
- data/lib/algolia/models/recommend/numeric_filters.rb +33 -24
- data/lib/algolia/models/recommend/optional_filters.rb +33 -24
- data/lib/algolia/models/recommend/params_consequence.rb +35 -20
- data/lib/algolia/models/recommend/personalization.rb +35 -20
- data/lib/algolia/models/recommend/promote_consequence_object.rb +36 -21
- data/lib/algolia/models/recommend/query_type.rb +2 -3
- data/lib/algolia/models/recommend/ranking_info.rb +76 -48
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +33 -24
- data/lib/algolia/models/recommend/recommend_hit.rb +32 -21
- data/lib/algolia/models/recommend/recommend_models.rb +2 -3
- data/lib/algolia/models/recommend/recommend_rule.rb +38 -23
- data/lib/algolia/models/recommend/recommend_rule_metadata.rb +33 -18
- data/lib/algolia/models/recommend/recommendations_hit.rb +33 -24
- data/lib/algolia/models/recommend/recommendations_hits.rb +33 -18
- data/lib/algolia/models/recommend/recommendations_request.rb +37 -28
- data/lib/algolia/models/recommend/recommendations_results.rb +159 -114
- data/lib/algolia/models/recommend/recommended_for_you.rb +34 -19
- data/lib/algolia/models/recommend/recommended_for_you_model.rb +2 -3
- data/lib/algolia/models/recommend/recommended_for_you_query.rb +46 -31
- data/lib/algolia/models/recommend/redirect.rb +29 -17
- data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +37 -22
- data/lib/algolia/models/recommend/redirect_rule_index_metadata_data.rb +33 -18
- data/lib/algolia/models/recommend/redirect_url.rb +33 -18
- data/lib/algolia/models/recommend/related_model.rb +2 -3
- data/lib/algolia/models/recommend/related_products.rb +35 -20
- data/lib/algolia/models/recommend/related_query.rb +47 -32
- data/lib/algolia/models/recommend/remove_stop_words.rb +33 -24
- data/lib/algolia/models/recommend/remove_words_if_no_results.rb +2 -3
- data/lib/algolia/models/recommend/rendering_content.rb +34 -19
- data/lib/algolia/models/recommend/search_pagination.rb +282 -0
- data/lib/algolia/models/recommend/search_params.rb +207 -118
- data/lib/algolia/models/recommend/search_params_object.rb +208 -119
- data/lib/algolia/models/recommend/search_params_query.rb +33 -18
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +48 -33
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +38 -23
- data/lib/algolia/models/recommend/semantic_search.rb +35 -20
- data/lib/algolia/models/recommend/snippet_result.rb +34 -25
- data/lib/algolia/models/recommend/snippet_result_option.rb +34 -19
- data/lib/algolia/models/recommend/sort_remaining_by.rb +2 -3
- data/lib/algolia/models/recommend/supported_language.rb +72 -5
- data/lib/algolia/models/recommend/tag_filters.rb +33 -24
- data/lib/algolia/models/recommend/task_status.rb +2 -3
- data/lib/algolia/models/recommend/trending_facet_hit.rb +38 -23
- data/lib/algolia/models/recommend/trending_facets.rb +37 -22
- data/lib/algolia/models/recommend/trending_facets_model.rb +2 -3
- data/lib/algolia/models/recommend/trending_facets_query.rb +49 -34
- data/lib/algolia/models/recommend/trending_items.rb +36 -25
- data/lib/algolia/models/recommend/trending_items_model.rb +2 -3
- data/lib/algolia/models/recommend/trending_items_query.rb +58 -38
- data/lib/algolia/models/recommend/typo_tolerance.rb +33 -24
- data/lib/algolia/models/recommend/typo_tolerance_enum.rb +2 -3
- data/lib/algolia/models/recommend/value.rb +31 -19
- data/lib/algolia/models/search/acl.rb +19 -5
- data/lib/algolia/models/search/action.rb +11 -4
- data/lib/algolia/models/search/add_api_key_response.rb +34 -19
- data/lib/algolia/models/search/advanced_syntax_features.rb +2 -3
- data/lib/algolia/models/search/alternatives_as_exact.rb +2 -3
- data/lib/algolia/models/search/anchoring.rb +2 -3
- data/lib/algolia/models/search/api_key.rb +46 -25
- data/lib/algolia/models/search/api_key_operation.rb +2 -3
- data/lib/algolia/models/search/around_precision.rb +33 -24
- data/lib/algolia/models/search/around_precision_from_value_inner.rb +34 -19
- data/lib/algolia/models/search/around_radius.rb +33 -24
- data/lib/algolia/models/search/around_radius_all.rb +2 -3
- data/lib/algolia/models/search/assign_user_id_params.rb +33 -18
- data/lib/algolia/models/search/attribute_to_update.rb +33 -24
- data/lib/algolia/models/search/automatic_facet_filter.rb +35 -20
- data/lib/algolia/models/search/automatic_facet_filters.rb +33 -24
- data/lib/algolia/models/search/base_get_api_key_response.rb +34 -19
- data/lib/algolia/models/search/base_index_settings.rb +71 -39
- data/lib/algolia/models/search/base_search_params.rb +110 -63
- data/lib/algolia/models/search/base_search_params_without_query.rb +106 -60
- data/lib/algolia/models/search/base_search_response.rb +76 -121
- data/lib/algolia/models/search/batch_assign_user_ids_params.rb +34 -19
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +34 -19
- data/lib/algolia/models/search/batch_dictionary_entries_request.rb +34 -19
- data/lib/algolia/models/search/batch_params.rb +33 -18
- data/lib/algolia/models/search/batch_request.rb +34 -19
- data/lib/algolia/models/search/batch_response.rb +34 -19
- data/lib/algolia/models/search/batch_write_params.rb +33 -18
- data/lib/algolia/models/{ingestion/schedule_date_utils_input.rb → search/browse_pagination.rb} +92 -45
- data/lib/algolia/models/search/browse_params.rb +33 -24
- data/lib/algolia/models/search/browse_params_object.rb +210 -120
- data/lib/algolia/models/search/browse_response.rb +158 -118
- data/lib/algolia/models/search/built_in_operation.rb +34 -19
- data/lib/algolia/models/search/built_in_operation_type.rb +2 -3
- data/lib/algolia/models/search/condition.rb +38 -23
- data/lib/algolia/models/search/consequence.rb +43 -28
- data/lib/algolia/models/search/consequence_hide.rb +33 -18
- data/lib/algolia/models/search/consequence_params.rb +213 -122
- data/lib/algolia/models/search/consequence_query.rb +33 -24
- data/lib/algolia/models/search/consequence_query_object.rb +34 -19
- data/lib/algolia/models/search/created_at_response.rb +33 -18
- data/lib/algolia/models/search/cursor.rb +29 -17
- data/lib/algolia/models/search/delete_api_key_response.rb +33 -18
- data/lib/algolia/models/search/delete_by_params.rb +50 -26
- data/lib/algolia/models/search/delete_source_response.rb +33 -18
- data/lib/algolia/models/search/deleted_at_response.rb +34 -19
- data/lib/algolia/models/search/dictionary_action.rb +2 -3
- data/lib/algolia/models/search/dictionary_entry.rb +29 -18
- data/lib/algolia/models/search/dictionary_entry_state.rb +2 -3
- data/lib/algolia/models/search/dictionary_language.rb +33 -18
- data/lib/algolia/models/search/dictionary_settings_params.rb +33 -18
- data/lib/algolia/models/search/dictionary_type.rb +2 -3
- data/lib/algolia/models/search/distinct.rb +33 -24
- data/lib/algolia/models/search/edit.rb +31 -19
- data/lib/algolia/models/search/edit_type.rb +2 -3
- data/lib/algolia/models/search/error_base.rb +24 -13
- data/lib/algolia/models/search/exact_on_single_word_query.rb +2 -3
- data/lib/algolia/models/search/exhaustive.rb +37 -22
- data/lib/algolia/models/search/facet_filters.rb +33 -24
- data/lib/algolia/models/search/facet_hits.rb +35 -20
- data/lib/algolia/models/search/facet_ordering.rb +34 -19
- data/lib/algolia/models/search/facets.rb +29 -17
- data/lib/algolia/models/search/facets_stats.rb +36 -21
- data/lib/algolia/models/search/fetched_index.rb +58 -30
- data/lib/algolia/models/search/get_api_key_response.rb +56 -30
- data/lib/algolia/models/search/get_dictionary_settings_response.rb +33 -18
- data/lib/algolia/models/search/get_logs_response.rb +33 -18
- data/lib/algolia/models/search/get_objects_params.rb +33 -18
- data/lib/algolia/models/search/get_objects_request.rb +35 -20
- data/lib/algolia/models/search/get_objects_response.rb +33 -18
- data/lib/algolia/models/search/get_task_response.rb +33 -18
- data/lib/algolia/models/search/get_top_user_ids_response.rb +33 -18
- data/lib/algolia/models/search/has_pending_mappings_response.rb +34 -19
- data/lib/algolia/models/search/highlight_result.rb +34 -25
- data/lib/algolia/models/search/highlight_result_option.rb +36 -21
- data/lib/algolia/models/search/hit.rb +24 -16
- data/lib/algolia/models/search/ignore_plurals.rb +33 -24
- data/lib/algolia/models/search/index_settings.rb +171 -97
- data/lib/algolia/models/search/index_settings_as_search_params.rb +134 -75
- data/lib/algolia/models/search/languages.rb +39 -24
- data/lib/algolia/models/search/list_api_keys_response.rb +33 -18
- data/lib/algolia/models/search/list_clusters_response.rb +33 -18
- data/lib/algolia/models/search/list_indices_response.rb +34 -19
- data/lib/algolia/models/search/list_user_ids_response.rb +33 -18
- data/lib/algolia/models/search/log.rb +70 -37
- data/lib/algolia/models/search/log_query.rb +31 -19
- data/lib/algolia/models/search/log_type.rb +2 -3
- data/lib/algolia/models/search/match_level.rb +2 -3
- data/lib/algolia/models/search/matched_geo_location.rb +35 -20
- data/lib/algolia/models/search/mode.rb +2 -3
- data/lib/algolia/models/search/multiple_batch_request.rb +35 -20
- data/lib/algolia/models/search/multiple_batch_response.rb +34 -19
- data/lib/algolia/models/search/numeric_filters.rb +33 -24
- data/lib/algolia/models/search/operation_index_params.rb +35 -20
- data/lib/algolia/models/search/operation_type.rb +2 -3
- data/lib/algolia/models/search/optional_filters.rb +33 -24
- data/lib/algolia/models/search/params.rb +32 -20
- data/lib/algolia/models/search/personalization.rb +35 -20
- data/lib/algolia/models/search/promote.rb +33 -24
- data/lib/algolia/models/search/promote_object_id.rb +34 -19
- data/lib/algolia/models/search/promote_object_ids.rb +36 -21
- data/lib/algolia/models/search/query_type.rb +2 -3
- data/lib/algolia/models/search/ranking_info.rb +76 -48
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +33 -24
- data/lib/algolia/models/search/redirect.rb +29 -17
- data/lib/algolia/models/search/redirect_rule_index_metadata.rb +37 -22
- data/lib/algolia/models/search/redirect_rule_index_metadata_data.rb +33 -18
- data/lib/algolia/models/search/redirect_url.rb +33 -18
- data/lib/algolia/models/search/remove_stop_words.rb +33 -24
- data/lib/algolia/models/search/remove_user_id_response.rb +33 -18
- data/lib/algolia/models/search/remove_words_if_no_results.rb +2 -3
- data/lib/algolia/models/search/rendering_content.rb +34 -19
- data/lib/algolia/models/search/replace_all_objects_response.rb +35 -20
- data/lib/algolia/models/search/replace_source_response.rb +33 -18
- data/lib/algolia/models/search/rule.rb +37 -25
- data/lib/algolia/models/search/save_object_response.rb +35 -20
- data/lib/algolia/models/search/save_synonym_response.rb +35 -20
- data/lib/algolia/models/search/scope_type.rb +2 -3
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +41 -26
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +38 -23
- data/lib/algolia/models/search/search_for_facet_values_request.rb +37 -22
- data/lib/algolia/models/search/search_for_facet_values_response.rb +35 -20
- data/lib/algolia/models/search/search_for_facets.rb +218 -124
- data/lib/algolia/models/search/search_for_facets_options.rb +39 -24
- data/lib/algolia/models/search/search_for_hits.rb +214 -122
- data/lib/algolia/models/search/search_for_hits_options.rb +34 -19
- data/lib/algolia/models/search/search_hits.rb +26 -15
- data/lib/algolia/models/search/search_method_params.rb +34 -19
- data/lib/algolia/models/search/search_pagination.rb +282 -0
- data/lib/algolia/models/search/search_params.rb +33 -24
- data/lib/algolia/models/search/search_params_object.rb +208 -119
- data/lib/algolia/models/search/search_params_query.rb +33 -18
- data/lib/algolia/models/search/search_params_string.rb +33 -18
- data/lib/algolia/models/search/search_query.rb +33 -24
- data/lib/algolia/models/search/search_response.rb +154 -111
- data/lib/algolia/models/search/search_responses.rb +33 -18
- data/lib/algolia/models/search/search_result.rb +33 -24
- data/lib/algolia/models/search/search_rules_params.rb +45 -30
- data/lib/algolia/models/search/search_rules_response.rb +36 -21
- data/lib/algolia/models/search/search_strategy.rb +2 -3
- data/lib/algolia/models/search/search_synonyms_params.rb +41 -26
- data/lib/algolia/models/search/search_synonyms_response.rb +25 -14
- data/lib/algolia/models/search/search_type_default.rb +2 -3
- data/lib/algolia/models/search/search_type_facet.rb +2 -3
- data/lib/algolia/models/search/search_user_ids_params.rb +41 -26
- data/lib/algolia/models/search/search_user_ids_response.rb +42 -27
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +38 -23
- data/lib/algolia/models/search/semantic_search.rb +35 -20
- data/lib/algolia/models/search/snippet_result.rb +34 -25
- data/lib/algolia/models/search/snippet_result_option.rb +34 -19
- data/lib/algolia/models/search/sort_remaining_by.rb +2 -3
- data/lib/algolia/models/search/source.rb +30 -18
- data/lib/algolia/models/search/standard_entries.rb +39 -24
- data/lib/algolia/models/search/supported_language.rb +72 -5
- data/lib/algolia/models/search/synonym_hit.rb +40 -25
- data/lib/algolia/models/search/synonym_type.rb +2 -3
- data/lib/algolia/models/search/tag_filters.rb +33 -24
- data/lib/algolia/models/search/task_status.rb +2 -3
- data/lib/algolia/models/search/time_range.rb +34 -19
- data/lib/algolia/models/search/typo_tolerance.rb +33 -24
- data/lib/algolia/models/search/typo_tolerance_enum.rb +2 -3
- data/lib/algolia/models/search/update_api_key_response.rb +34 -19
- data/lib/algolia/models/search/updated_at_response.rb +34 -19
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +35 -20
- data/lib/algolia/models/search/updated_rule_response.rb +35 -20
- data/lib/algolia/models/search/user_highlight_result.rb +34 -19
- data/lib/algolia/models/search/user_hit.rb +35 -23
- data/lib/algolia/models/search/user_id.rb +33 -21
- data/lib/algolia/models/search/value.rb +31 -19
- data/lib/algolia/models/usage/error_base.rb +24 -13
- data/lib/algolia/models/usage/get_usage200_response.rb +33 -18
- data/lib/algolia/models/usage/get_usage200_response_statistics_inner.rb +34 -19
- data/lib/algolia/models/usage/get_usage400_response.rb +33 -18
- data/lib/algolia/models/usage/get_usage400_response_error.rb +35 -20
- data/lib/algolia/models/usage/get_usage400_response_error_errors_inner.rb +36 -21
- data/lib/algolia/models/usage/granularity.rb +2 -3
- data/lib/algolia/models/usage/statistic.rb +88 -5
- data/lib/algolia/models/usage/statistic_value.rb +33 -24
- data/lib/algolia/transport/call_type.rb +1 -1
- data/lib/algolia/transport/echo_requester.rb +11 -2
- data/lib/algolia/transport/http/http_requester.rb +23 -15
- data/lib/algolia/transport/http/response.rb +8 -8
- data/lib/algolia/transport/request_options.rb +6 -4
- data/lib/algolia/transport/retry_outcome_type.rb +3 -3
- data/lib/algolia/transport/retry_strategy.rb +8 -7
- data/lib/algolia/transport/stateful_host.rb +6 -6
- data/lib/algolia/transport/transport.rb +28 -21
- data/lib/algolia/user_agent.rb +1 -1
- data/lib/algolia/version.rb +1 -1
- data/lib/algolia.rb +16 -16
- metadata +20 -13
- data/.rubocop.yml +0 -99
@@ -5,28 +5,33 @@ module Algolia
|
|
5
5
|
attr_accessor :api_client
|
6
6
|
|
7
7
|
def initialize(config = nil)
|
8
|
-
raise
|
9
|
-
raise
|
10
|
-
raise
|
8
|
+
raise "`config` is missing." if config.nil?
|
9
|
+
raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
|
10
|
+
raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
|
11
11
|
|
12
12
|
@api_client = Algolia::ApiClient.new(config)
|
13
13
|
end
|
14
14
|
|
15
15
|
def self.create(app_id, api_key, region = nil, opts = {})
|
16
16
|
hosts = []
|
17
|
-
regions = [
|
17
|
+
regions = ["de", "us"]
|
18
18
|
|
19
19
|
if region.is_a?(Hash) && (opts.nil? || opts.empty?)
|
20
20
|
opts = region
|
21
21
|
region = nil
|
22
22
|
end
|
23
23
|
|
24
|
-
|
24
|
+
if !region.nil? && (!region.is_a?(String) || !regions.include?(region))
|
25
|
+
raise "`region` must be one of the following: #{regions.join(", ")}"
|
26
|
+
end
|
25
27
|
|
26
|
-
hosts <<
|
27
|
-
|
28
|
+
hosts <<
|
29
|
+
Transport::StatefulHost.new(
|
30
|
+
region.nil? ? "analytics.algolia.com" : "analytics.{region}.algolia.com".sub!("{region}", region),
|
31
|
+
accept: CallType::READ | CallType::WRITE
|
32
|
+
)
|
28
33
|
|
29
|
-
config = Algolia::Configuration.new(app_id, api_key, hosts,
|
34
|
+
config = Algolia::Configuration.new(app_id, api_key, hosts, "Analytics", opts)
|
30
35
|
create_with_config(config)
|
31
36
|
end
|
32
37
|
|
@@ -46,7 +51,7 @@ module Algolia
|
|
46
51
|
raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
|
47
52
|
end
|
48
53
|
|
49
|
-
path =
|
54
|
+
path = "/{path}".sub("{" + "path" + "}", path.to_s)
|
50
55
|
query_params = {}
|
51
56
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
52
57
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -56,7 +61,7 @@ module Algolia
|
|
56
61
|
post_body = request_options[:debug_body]
|
57
62
|
|
58
63
|
new_options = request_options.merge(
|
59
|
-
:operation => :
|
64
|
+
:operation => :"AnalyticsClient.custom_delete",
|
60
65
|
:header_params => header_params,
|
61
66
|
:query_params => query_params,
|
62
67
|
:body => post_body,
|
@@ -74,7 +79,7 @@ module Algolia
|
|
74
79
|
# @return [Object]
|
75
80
|
def custom_delete(path, parameters = nil, request_options = {})
|
76
81
|
response = custom_delete_with_http_info(path, parameters, request_options)
|
77
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] ||
|
82
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
|
78
83
|
end
|
79
84
|
|
80
85
|
# This method allow you to send requests to the Algolia REST API.
|
@@ -89,7 +94,7 @@ module Algolia
|
|
89
94
|
raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
|
90
95
|
end
|
91
96
|
|
92
|
-
path =
|
97
|
+
path = "/{path}".sub("{" + "path" + "}", path.to_s)
|
93
98
|
query_params = {}
|
94
99
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
95
100
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -99,7 +104,7 @@ module Algolia
|
|
99
104
|
post_body = request_options[:debug_body]
|
100
105
|
|
101
106
|
new_options = request_options.merge(
|
102
|
-
:operation => :
|
107
|
+
:operation => :"AnalyticsClient.custom_get",
|
103
108
|
:header_params => header_params,
|
104
109
|
:query_params => query_params,
|
105
110
|
:body => post_body,
|
@@ -117,7 +122,7 @@ module Algolia
|
|
117
122
|
# @return [Object]
|
118
123
|
def custom_get(path, parameters = nil, request_options = {})
|
119
124
|
response = custom_get_with_http_info(path, parameters, request_options)
|
120
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] ||
|
125
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
|
121
126
|
end
|
122
127
|
|
123
128
|
# This method allow you to send requests to the Algolia REST API.
|
@@ -133,7 +138,7 @@ module Algolia
|
|
133
138
|
raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
|
134
139
|
end
|
135
140
|
|
136
|
-
path =
|
141
|
+
path = "/{path}".sub("{" + "path" + "}", path.to_s)
|
137
142
|
query_params = {}
|
138
143
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
139
144
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -143,7 +148,7 @@ module Algolia
|
|
143
148
|
post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
|
144
149
|
|
145
150
|
new_options = request_options.merge(
|
146
|
-
:operation => :
|
151
|
+
:operation => :"AnalyticsClient.custom_post",
|
147
152
|
:header_params => header_params,
|
148
153
|
:query_params => query_params,
|
149
154
|
:body => post_body,
|
@@ -162,7 +167,7 @@ module Algolia
|
|
162
167
|
# @return [Object]
|
163
168
|
def custom_post(path, parameters = nil, body = nil, request_options = {})
|
164
169
|
response = custom_post_with_http_info(path, parameters, body, request_options)
|
165
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] ||
|
170
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
|
166
171
|
end
|
167
172
|
|
168
173
|
# This method allow you to send requests to the Algolia REST API.
|
@@ -178,7 +183,7 @@ module Algolia
|
|
178
183
|
raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
|
179
184
|
end
|
180
185
|
|
181
|
-
path =
|
186
|
+
path = "/{path}".sub("{" + "path" + "}", path.to_s)
|
182
187
|
query_params = {}
|
183
188
|
query_params = query_params.merge(parameters) unless parameters.nil?
|
184
189
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -188,7 +193,7 @@ module Algolia
|
|
188
193
|
post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
|
189
194
|
|
190
195
|
new_options = request_options.merge(
|
191
|
-
:operation => :
|
196
|
+
:operation => :"AnalyticsClient.custom_put",
|
192
197
|
:header_params => header_params,
|
193
198
|
:query_params => query_params,
|
194
199
|
:body => post_body,
|
@@ -207,7 +212,7 @@ module Algolia
|
|
207
212
|
# @return [Object]
|
208
213
|
def custom_put(path, parameters = nil, body = nil, request_options = {})
|
209
214
|
response = custom_put_with_http_info(path, parameters, body, request_options)
|
210
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] ||
|
215
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
|
211
216
|
end
|
212
217
|
|
213
218
|
# 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.
|
@@ -226,7 +231,7 @@ module Algolia
|
|
226
231
|
raise ArgumentError, "Parameter `index` is required when calling `get_add_to_cart_rate`."
|
227
232
|
end
|
228
233
|
|
229
|
-
path =
|
234
|
+
path = "/2/conversions/addToCartRate"
|
230
235
|
query_params = {}
|
231
236
|
query_params[:index] = index
|
232
237
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -239,7 +244,7 @@ module Algolia
|
|
239
244
|
post_body = request_options[:debug_body]
|
240
245
|
|
241
246
|
new_options = request_options.merge(
|
242
|
-
:operation => :
|
247
|
+
:operation => :"AnalyticsClient.get_add_to_cart_rate",
|
243
248
|
:header_params => header_params,
|
244
249
|
:query_params => query_params,
|
245
250
|
:body => post_body,
|
@@ -261,7 +266,10 @@ module Algolia
|
|
261
266
|
# @return [GetAddToCartRateResponse]
|
262
267
|
def get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
263
268
|
response = get_add_to_cart_rate_with_http_info(index, start_date, end_date, tags, request_options)
|
264
|
-
@api_client.deserialize(
|
269
|
+
@api_client.deserialize(
|
270
|
+
response.body,
|
271
|
+
request_options[:debug_return_type] || "Analytics::GetAddToCartRateResponse"
|
272
|
+
)
|
265
273
|
end
|
266
274
|
|
267
275
|
# 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.
|
@@ -274,13 +282,19 @@ module Algolia
|
|
274
282
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
275
283
|
# @param 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)
|
276
284
|
# @return [Http::Response] the response
|
277
|
-
def get_average_click_position_with_http_info(
|
285
|
+
def get_average_click_position_with_http_info(
|
286
|
+
index,
|
287
|
+
start_date = nil,
|
288
|
+
end_date = nil,
|
289
|
+
tags = nil,
|
290
|
+
request_options = {}
|
291
|
+
)
|
278
292
|
# verify the required parameter 'index' is set
|
279
293
|
if @api_client.config.client_side_validation && index.nil?
|
280
294
|
raise ArgumentError, "Parameter `index` is required when calling `get_average_click_position`."
|
281
295
|
end
|
282
296
|
|
283
|
-
path =
|
297
|
+
path = "/2/clicks/averageClickPosition"
|
284
298
|
query_params = {}
|
285
299
|
query_params[:index] = index
|
286
300
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -293,7 +307,7 @@ module Algolia
|
|
293
307
|
post_body = request_options[:debug_body]
|
294
308
|
|
295
309
|
new_options = request_options.merge(
|
296
|
-
:operation => :
|
310
|
+
:operation => :"AnalyticsClient.get_average_click_position",
|
297
311
|
:header_params => header_params,
|
298
312
|
:query_params => query_params,
|
299
313
|
:body => post_body,
|
@@ -315,7 +329,10 @@ module Algolia
|
|
315
329
|
# @return [GetAverageClickPositionResponse]
|
316
330
|
def get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
317
331
|
response = get_average_click_position_with_http_info(index, start_date, end_date, tags, request_options)
|
318
|
-
@api_client.deserialize(
|
332
|
+
@api_client.deserialize(
|
333
|
+
response.body,
|
334
|
+
request_options[:debug_return_type] || "Analytics::GetAverageClickPositionResponse"
|
335
|
+
)
|
319
336
|
end
|
320
337
|
|
321
338
|
# 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.
|
@@ -334,7 +351,7 @@ module Algolia
|
|
334
351
|
raise ArgumentError, "Parameter `index` is required when calling `get_click_positions`."
|
335
352
|
end
|
336
353
|
|
337
|
-
path =
|
354
|
+
path = "/2/clicks/positions"
|
338
355
|
query_params = {}
|
339
356
|
query_params[:index] = index
|
340
357
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -347,7 +364,7 @@ module Algolia
|
|
347
364
|
post_body = request_options[:debug_body]
|
348
365
|
|
349
366
|
new_options = request_options.merge(
|
350
|
-
:operation => :
|
367
|
+
:operation => :"AnalyticsClient.get_click_positions",
|
351
368
|
:header_params => header_params,
|
352
369
|
:query_params => query_params,
|
353
370
|
:body => post_body,
|
@@ -369,7 +386,10 @@ module Algolia
|
|
369
386
|
# @return [GetClickPositionsResponse]
|
370
387
|
def get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
371
388
|
response = get_click_positions_with_http_info(index, start_date, end_date, tags, request_options)
|
372
|
-
@api_client.deserialize(
|
389
|
+
@api_client.deserialize(
|
390
|
+
response.body,
|
391
|
+
request_options[:debug_return_type] || "Analytics::GetClickPositionsResponse"
|
392
|
+
)
|
373
393
|
end
|
374
394
|
|
375
395
|
# 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.
|
@@ -388,7 +408,7 @@ module Algolia
|
|
388
408
|
raise ArgumentError, "Parameter `index` is required when calling `get_click_through_rate`."
|
389
409
|
end
|
390
410
|
|
391
|
-
path =
|
411
|
+
path = "/2/clicks/clickThroughRate"
|
392
412
|
query_params = {}
|
393
413
|
query_params[:index] = index
|
394
414
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -401,7 +421,7 @@ module Algolia
|
|
401
421
|
post_body = request_options[:debug_body]
|
402
422
|
|
403
423
|
new_options = request_options.merge(
|
404
|
-
:operation => :
|
424
|
+
:operation => :"AnalyticsClient.get_click_through_rate",
|
405
425
|
:header_params => header_params,
|
406
426
|
:query_params => query_params,
|
407
427
|
:body => post_body,
|
@@ -423,7 +443,10 @@ module Algolia
|
|
423
443
|
# @return [GetClickThroughRateResponse]
|
424
444
|
def get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
425
445
|
response = get_click_through_rate_with_http_info(index, start_date, end_date, tags, request_options)
|
426
|
-
@api_client.deserialize(
|
446
|
+
@api_client.deserialize(
|
447
|
+
response.body,
|
448
|
+
request_options[:debug_return_type] || "Analytics::GetClickThroughRateResponse"
|
449
|
+
)
|
427
450
|
end
|
428
451
|
|
429
452
|
# 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.
|
@@ -442,7 +465,7 @@ module Algolia
|
|
442
465
|
raise ArgumentError, "Parameter `index` is required when calling `get_conversion_rate`."
|
443
466
|
end
|
444
467
|
|
445
|
-
path =
|
468
|
+
path = "/2/conversions/conversionRate"
|
446
469
|
query_params = {}
|
447
470
|
query_params[:index] = index
|
448
471
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -455,7 +478,7 @@ module Algolia
|
|
455
478
|
post_body = request_options[:debug_body]
|
456
479
|
|
457
480
|
new_options = request_options.merge(
|
458
|
-
:operation => :
|
481
|
+
:operation => :"AnalyticsClient.get_conversion_rate",
|
459
482
|
:header_params => header_params,
|
460
483
|
:query_params => query_params,
|
461
484
|
:body => post_body,
|
@@ -477,7 +500,10 @@ module Algolia
|
|
477
500
|
# @return [GetConversionRateResponse]
|
478
501
|
def get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
479
502
|
response = get_conversion_rate_with_http_info(index, start_date, end_date, tags, request_options)
|
480
|
-
@api_client.deserialize(
|
503
|
+
@api_client.deserialize(
|
504
|
+
response.body,
|
505
|
+
request_options[:debug_return_type] || "Analytics::GetConversionRateResponse"
|
506
|
+
)
|
481
507
|
end
|
482
508
|
|
483
509
|
# 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.
|
@@ -496,7 +522,7 @@ module Algolia
|
|
496
522
|
raise ArgumentError, "Parameter `index` is required when calling `get_no_click_rate`."
|
497
523
|
end
|
498
524
|
|
499
|
-
path =
|
525
|
+
path = "/2/searches/noClickRate"
|
500
526
|
query_params = {}
|
501
527
|
query_params[:index] = index
|
502
528
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -509,7 +535,7 @@ module Algolia
|
|
509
535
|
post_body = request_options[:debug_body]
|
510
536
|
|
511
537
|
new_options = request_options.merge(
|
512
|
-
:operation => :
|
538
|
+
:operation => :"AnalyticsClient.get_no_click_rate",
|
513
539
|
:header_params => header_params,
|
514
540
|
:query_params => query_params,
|
515
541
|
:body => post_body,
|
@@ -531,7 +557,7 @@ module Algolia
|
|
531
557
|
# @return [GetNoClickRateResponse]
|
532
558
|
def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
533
559
|
response = get_no_click_rate_with_http_info(index, start_date, end_date, tags, request_options)
|
534
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] ||
|
560
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetNoClickRateResponse")
|
535
561
|
end
|
536
562
|
|
537
563
|
# 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.
|
@@ -550,7 +576,7 @@ module Algolia
|
|
550
576
|
raise ArgumentError, "Parameter `index` is required when calling `get_no_results_rate`."
|
551
577
|
end
|
552
578
|
|
553
|
-
path =
|
579
|
+
path = "/2/searches/noResultRate"
|
554
580
|
query_params = {}
|
555
581
|
query_params[:index] = index
|
556
582
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -563,7 +589,7 @@ module Algolia
|
|
563
589
|
post_body = request_options[:debug_body]
|
564
590
|
|
565
591
|
new_options = request_options.merge(
|
566
|
-
:operation => :
|
592
|
+
:operation => :"AnalyticsClient.get_no_results_rate",
|
567
593
|
:header_params => header_params,
|
568
594
|
:query_params => query_params,
|
569
595
|
:body => post_body,
|
@@ -585,7 +611,10 @@ module Algolia
|
|
585
611
|
# @return [GetNoResultsRateResponse]
|
586
612
|
def get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
587
613
|
response = get_no_results_rate_with_http_info(index, start_date, end_date, tags, request_options)
|
588
|
-
@api_client.deserialize(
|
614
|
+
@api_client.deserialize(
|
615
|
+
response.body,
|
616
|
+
request_options[:debug_return_type] || "Analytics::GetNoResultsRateResponse"
|
617
|
+
)
|
589
618
|
end
|
590
619
|
|
591
620
|
# 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.
|
@@ -604,7 +633,7 @@ module Algolia
|
|
604
633
|
raise ArgumentError, "Parameter `index` is required when calling `get_purchase_rate`."
|
605
634
|
end
|
606
635
|
|
607
|
-
path =
|
636
|
+
path = "/2/conversions/purchaseRate"
|
608
637
|
query_params = {}
|
609
638
|
query_params[:index] = index
|
610
639
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -617,7 +646,7 @@ module Algolia
|
|
617
646
|
post_body = request_options[:debug_body]
|
618
647
|
|
619
648
|
new_options = request_options.merge(
|
620
|
-
:operation => :
|
649
|
+
:operation => :"AnalyticsClient.get_purchase_rate",
|
621
650
|
:header_params => header_params,
|
622
651
|
:query_params => query_params,
|
623
652
|
:body => post_body,
|
@@ -639,7 +668,10 @@ module Algolia
|
|
639
668
|
# @return [GetPurchaseRateResponse]
|
640
669
|
def get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
641
670
|
response = get_purchase_rate_with_http_info(index, start_date, end_date, tags, request_options)
|
642
|
-
@api_client.deserialize(
|
671
|
+
@api_client.deserialize(
|
672
|
+
response.body,
|
673
|
+
request_options[:debug_return_type] || "Analytics::GetPurchaseRateResponse"
|
674
|
+
)
|
643
675
|
end
|
644
676
|
|
645
677
|
# 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.
|
@@ -658,7 +690,7 @@ module Algolia
|
|
658
690
|
raise ArgumentError, "Parameter `index` is required when calling `get_revenue`."
|
659
691
|
end
|
660
692
|
|
661
|
-
path =
|
693
|
+
path = "/2/conversions/revenue"
|
662
694
|
query_params = {}
|
663
695
|
query_params[:index] = index
|
664
696
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -671,7 +703,7 @@ module Algolia
|
|
671
703
|
post_body = request_options[:debug_body]
|
672
704
|
|
673
705
|
new_options = request_options.merge(
|
674
|
-
:operation => :
|
706
|
+
:operation => :"AnalyticsClient.get_revenue",
|
675
707
|
:header_params => header_params,
|
676
708
|
:query_params => query_params,
|
677
709
|
:body => post_body,
|
@@ -693,7 +725,7 @@ module Algolia
|
|
693
725
|
# @return [GetRevenue]
|
694
726
|
def get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
695
727
|
response = get_revenue_with_http_info(index, start_date, end_date, tags, request_options)
|
696
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] ||
|
728
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetRevenue")
|
697
729
|
end
|
698
730
|
|
699
731
|
# 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.
|
@@ -712,7 +744,7 @@ module Algolia
|
|
712
744
|
raise ArgumentError, "Parameter `index` is required when calling `get_searches_count`."
|
713
745
|
end
|
714
746
|
|
715
|
-
path =
|
747
|
+
path = "/2/searches/count"
|
716
748
|
query_params = {}
|
717
749
|
query_params[:index] = index
|
718
750
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -725,7 +757,7 @@ module Algolia
|
|
725
757
|
post_body = request_options[:debug_body]
|
726
758
|
|
727
759
|
new_options = request_options.merge(
|
728
|
-
:operation => :
|
760
|
+
:operation => :"AnalyticsClient.get_searches_count",
|
729
761
|
:header_params => header_params,
|
730
762
|
:query_params => query_params,
|
731
763
|
:body => post_body,
|
@@ -747,7 +779,10 @@ module Algolia
|
|
747
779
|
# @return [GetSearchesCountResponse]
|
748
780
|
def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
749
781
|
response = get_searches_count_with_http_info(index, start_date, end_date, tags, request_options)
|
750
|
-
@api_client.deserialize(
|
782
|
+
@api_client.deserialize(
|
783
|
+
response.body,
|
784
|
+
request_options[:debug_return_type] || "Analytics::GetSearchesCountResponse"
|
785
|
+
)
|
751
786
|
end
|
752
787
|
|
753
788
|
# Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
|
@@ -762,16 +797,28 @@ module Algolia
|
|
762
797
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
763
798
|
# @param 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)
|
764
799
|
# @return [Http::Response] the response
|
765
|
-
def get_searches_no_clicks_with_http_info(
|
800
|
+
def get_searches_no_clicks_with_http_info(
|
801
|
+
index,
|
802
|
+
start_date = nil,
|
803
|
+
end_date = nil,
|
804
|
+
limit = nil,
|
805
|
+
offset = nil,
|
806
|
+
tags = nil,
|
807
|
+
request_options = {}
|
808
|
+
)
|
766
809
|
# verify the required parameter 'index' is set
|
767
810
|
if @api_client.config.client_side_validation && index.nil?
|
768
811
|
raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_clicks`."
|
769
812
|
end
|
813
|
+
|
770
814
|
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
771
|
-
raise
|
815
|
+
raise(
|
816
|
+
ArgumentError,
|
817
|
+
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_clicks, must be greater than or equal to 0."
|
818
|
+
)
|
772
819
|
end
|
773
820
|
|
774
|
-
path =
|
821
|
+
path = "/2/searches/noClicks"
|
775
822
|
query_params = {}
|
776
823
|
query_params[:index] = index
|
777
824
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -786,7 +833,7 @@ module Algolia
|
|
786
833
|
post_body = request_options[:debug_body]
|
787
834
|
|
788
835
|
new_options = request_options.merge(
|
789
|
-
:operation => :
|
836
|
+
:operation => :"AnalyticsClient.get_searches_no_clicks",
|
790
837
|
:header_params => header_params,
|
791
838
|
:query_params => query_params,
|
792
839
|
:body => post_body,
|
@@ -808,9 +855,28 @@ module Algolia
|
|
808
855
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
809
856
|
# @param 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)
|
810
857
|
# @return [GetSearchesNoClicksResponse]
|
811
|
-
def get_searches_no_clicks(
|
812
|
-
|
813
|
-
|
858
|
+
def get_searches_no_clicks(
|
859
|
+
index,
|
860
|
+
start_date = nil,
|
861
|
+
end_date = nil,
|
862
|
+
limit = nil,
|
863
|
+
offset = nil,
|
864
|
+
tags = nil,
|
865
|
+
request_options = {}
|
866
|
+
)
|
867
|
+
response = get_searches_no_clicks_with_http_info(
|
868
|
+
index,
|
869
|
+
start_date,
|
870
|
+
end_date,
|
871
|
+
limit,
|
872
|
+
offset,
|
873
|
+
tags,
|
874
|
+
request_options
|
875
|
+
)
|
876
|
+
@api_client.deserialize(
|
877
|
+
response.body,
|
878
|
+
request_options[:debug_return_type] || "Analytics::GetSearchesNoClicksResponse"
|
879
|
+
)
|
814
880
|
end
|
815
881
|
|
816
882
|
# Retrieves the most popular searches that didn't return any results.
|
@@ -825,16 +891,28 @@ module Algolia
|
|
825
891
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
826
892
|
# @param 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)
|
827
893
|
# @return [Http::Response] the response
|
828
|
-
def get_searches_no_results_with_http_info(
|
894
|
+
def get_searches_no_results_with_http_info(
|
895
|
+
index,
|
896
|
+
start_date = nil,
|
897
|
+
end_date = nil,
|
898
|
+
limit = nil,
|
899
|
+
offset = nil,
|
900
|
+
tags = nil,
|
901
|
+
request_options = {}
|
902
|
+
)
|
829
903
|
# verify the required parameter 'index' is set
|
830
904
|
if @api_client.config.client_side_validation && index.nil?
|
831
905
|
raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_results`."
|
832
906
|
end
|
907
|
+
|
833
908
|
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
834
|
-
raise
|
909
|
+
raise(
|
910
|
+
ArgumentError,
|
911
|
+
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_results, must be greater than or equal to 0."
|
912
|
+
)
|
835
913
|
end
|
836
914
|
|
837
|
-
path =
|
915
|
+
path = "/2/searches/noResults"
|
838
916
|
query_params = {}
|
839
917
|
query_params[:index] = index
|
840
918
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -849,7 +927,7 @@ module Algolia
|
|
849
927
|
post_body = request_options[:debug_body]
|
850
928
|
|
851
929
|
new_options = request_options.merge(
|
852
|
-
:operation => :
|
930
|
+
:operation => :"AnalyticsClient.get_searches_no_results",
|
853
931
|
:header_params => header_params,
|
854
932
|
:query_params => query_params,
|
855
933
|
:body => post_body,
|
@@ -871,9 +949,28 @@ module Algolia
|
|
871
949
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
872
950
|
# @param 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)
|
873
951
|
# @return [GetSearchesNoResultsResponse]
|
874
|
-
def get_searches_no_results(
|
875
|
-
|
876
|
-
|
952
|
+
def get_searches_no_results(
|
953
|
+
index,
|
954
|
+
start_date = nil,
|
955
|
+
end_date = nil,
|
956
|
+
limit = nil,
|
957
|
+
offset = nil,
|
958
|
+
tags = nil,
|
959
|
+
request_options = {}
|
960
|
+
)
|
961
|
+
response = get_searches_no_results_with_http_info(
|
962
|
+
index,
|
963
|
+
start_date,
|
964
|
+
end_date,
|
965
|
+
limit,
|
966
|
+
offset,
|
967
|
+
tags,
|
968
|
+
request_options
|
969
|
+
)
|
970
|
+
@api_client.deserialize(
|
971
|
+
response.body,
|
972
|
+
request_options[:debug_return_type] || "Analytics::GetSearchesNoResultsResponse"
|
973
|
+
)
|
877
974
|
end
|
878
975
|
|
879
976
|
# Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes.
|
@@ -889,7 +986,7 @@ module Algolia
|
|
889
986
|
raise ArgumentError, "Parameter `index` is required when calling `get_status`."
|
890
987
|
end
|
891
988
|
|
892
|
-
path =
|
989
|
+
path = "/2/status"
|
893
990
|
query_params = {}
|
894
991
|
query_params[:index] = index
|
895
992
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -899,7 +996,7 @@ module Algolia
|
|
899
996
|
post_body = request_options[:debug_body]
|
900
997
|
|
901
998
|
new_options = request_options.merge(
|
902
|
-
:operation => :
|
999
|
+
:operation => :"AnalyticsClient.get_status",
|
903
1000
|
:header_params => header_params,
|
904
1001
|
:query_params => query_params,
|
905
1002
|
:body => post_body,
|
@@ -918,7 +1015,7 @@ module Algolia
|
|
918
1015
|
# @return [GetStatusResponse]
|
919
1016
|
def get_status(index, request_options = {})
|
920
1017
|
response = get_status_with_http_info(index, request_options)
|
921
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] ||
|
1018
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetStatusResponse")
|
922
1019
|
end
|
923
1020
|
|
924
1021
|
# Retrieves the countries with the most searches to your index.
|
@@ -933,16 +1030,28 @@ module Algolia
|
|
933
1030
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
934
1031
|
# @param 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)
|
935
1032
|
# @return [Http::Response] the response
|
936
|
-
def get_top_countries_with_http_info(
|
1033
|
+
def get_top_countries_with_http_info(
|
1034
|
+
index,
|
1035
|
+
start_date = nil,
|
1036
|
+
end_date = nil,
|
1037
|
+
limit = nil,
|
1038
|
+
offset = nil,
|
1039
|
+
tags = nil,
|
1040
|
+
request_options = {}
|
1041
|
+
)
|
937
1042
|
# verify the required parameter 'index' is set
|
938
1043
|
if @api_client.config.client_side_validation && index.nil?
|
939
1044
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_countries`."
|
940
1045
|
end
|
1046
|
+
|
941
1047
|
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
942
|
-
raise
|
1048
|
+
raise(
|
1049
|
+
ArgumentError,
|
1050
|
+
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_countries, must be greater than or equal to 0."
|
1051
|
+
)
|
943
1052
|
end
|
944
1053
|
|
945
|
-
path =
|
1054
|
+
path = "/2/countries"
|
946
1055
|
query_params = {}
|
947
1056
|
query_params[:index] = index
|
948
1057
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -957,7 +1066,7 @@ module Algolia
|
|
957
1066
|
post_body = request_options[:debug_body]
|
958
1067
|
|
959
1068
|
new_options = request_options.merge(
|
960
|
-
:operation => :
|
1069
|
+
:operation => :"AnalyticsClient.get_top_countries",
|
961
1070
|
:header_params => header_params,
|
962
1071
|
:query_params => query_params,
|
963
1072
|
:body => post_body,
|
@@ -979,9 +1088,20 @@ module Algolia
|
|
979
1088
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
980
1089
|
# @param 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)
|
981
1090
|
# @return [GetTopCountriesResponse]
|
982
|
-
def get_top_countries(
|
1091
|
+
def get_top_countries(
|
1092
|
+
index,
|
1093
|
+
start_date = nil,
|
1094
|
+
end_date = nil,
|
1095
|
+
limit = nil,
|
1096
|
+
offset = nil,
|
1097
|
+
tags = nil,
|
1098
|
+
request_options = {}
|
1099
|
+
)
|
983
1100
|
response = get_top_countries_with_http_info(index, start_date, end_date, limit, offset, tags, request_options)
|
984
|
-
@api_client.deserialize(
|
1101
|
+
@api_client.deserialize(
|
1102
|
+
response.body,
|
1103
|
+
request_options[:debug_return_type] || "Analytics::GetTopCountriesResponse"
|
1104
|
+
)
|
985
1105
|
end
|
986
1106
|
|
987
1107
|
# Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.
|
@@ -997,16 +1117,29 @@ module Algolia
|
|
997
1117
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
998
1118
|
# @param 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)
|
999
1119
|
# @return [Http::Response] the response
|
1000
|
-
def get_top_filter_attributes_with_http_info(
|
1120
|
+
def get_top_filter_attributes_with_http_info(
|
1121
|
+
index,
|
1122
|
+
search = nil,
|
1123
|
+
start_date = nil,
|
1124
|
+
end_date = nil,
|
1125
|
+
limit = nil,
|
1126
|
+
offset = nil,
|
1127
|
+
tags = nil,
|
1128
|
+
request_options = {}
|
1129
|
+
)
|
1001
1130
|
# verify the required parameter 'index' is set
|
1002
1131
|
if @api_client.config.client_side_validation && index.nil?
|
1003
1132
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_attributes`."
|
1004
1133
|
end
|
1134
|
+
|
1005
1135
|
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
1006
|
-
raise
|
1136
|
+
raise(
|
1137
|
+
ArgumentError,
|
1138
|
+
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_attributes, must be greater than or equal to 0."
|
1139
|
+
)
|
1007
1140
|
end
|
1008
1141
|
|
1009
|
-
path =
|
1142
|
+
path = "/2/filters"
|
1010
1143
|
query_params = {}
|
1011
1144
|
query_params[:index] = index
|
1012
1145
|
query_params[:search] = search unless search.nil?
|
@@ -1022,7 +1155,7 @@ module Algolia
|
|
1022
1155
|
post_body = request_options[:debug_body]
|
1023
1156
|
|
1024
1157
|
new_options = request_options.merge(
|
1025
|
-
:operation => :
|
1158
|
+
:operation => :"AnalyticsClient.get_top_filter_attributes",
|
1026
1159
|
:header_params => header_params,
|
1027
1160
|
:query_params => query_params,
|
1028
1161
|
:body => post_body,
|
@@ -1045,9 +1178,30 @@ module Algolia
|
|
1045
1178
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1046
1179
|
# @param 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)
|
1047
1180
|
# @return [GetTopFilterAttributesResponse]
|
1048
|
-
def get_top_filter_attributes(
|
1049
|
-
|
1050
|
-
|
1181
|
+
def get_top_filter_attributes(
|
1182
|
+
index,
|
1183
|
+
search = nil,
|
1184
|
+
start_date = nil,
|
1185
|
+
end_date = nil,
|
1186
|
+
limit = nil,
|
1187
|
+
offset = nil,
|
1188
|
+
tags = nil,
|
1189
|
+
request_options = {}
|
1190
|
+
)
|
1191
|
+
response = get_top_filter_attributes_with_http_info(
|
1192
|
+
index,
|
1193
|
+
search,
|
1194
|
+
start_date,
|
1195
|
+
end_date,
|
1196
|
+
limit,
|
1197
|
+
offset,
|
1198
|
+
tags,
|
1199
|
+
request_options
|
1200
|
+
)
|
1201
|
+
@api_client.deserialize(
|
1202
|
+
response.body,
|
1203
|
+
request_options[:debug_return_type] || "Analytics::GetTopFilterAttributesResponse"
|
1204
|
+
)
|
1051
1205
|
end
|
1052
1206
|
|
1053
1207
|
# Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.
|
@@ -1064,7 +1218,17 @@ module Algolia
|
|
1064
1218
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1065
1219
|
# @param 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)
|
1066
1220
|
# @return [Http::Response] the response
|
1067
|
-
def get_top_filter_for_attribute_with_http_info(
|
1221
|
+
def get_top_filter_for_attribute_with_http_info(
|
1222
|
+
attribute,
|
1223
|
+
index,
|
1224
|
+
search = nil,
|
1225
|
+
start_date = nil,
|
1226
|
+
end_date = nil,
|
1227
|
+
limit = nil,
|
1228
|
+
offset = nil,
|
1229
|
+
tags = nil,
|
1230
|
+
request_options = {}
|
1231
|
+
)
|
1068
1232
|
# verify the required parameter 'attribute' is set
|
1069
1233
|
if @api_client.config.client_side_validation && attribute.nil?
|
1070
1234
|
raise ArgumentError, "Parameter `attribute` is required when calling `get_top_filter_for_attribute`."
|
@@ -1073,11 +1237,15 @@ module Algolia
|
|
1073
1237
|
if @api_client.config.client_side_validation && index.nil?
|
1074
1238
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_for_attribute`."
|
1075
1239
|
end
|
1240
|
+
|
1076
1241
|
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
1077
|
-
raise
|
1242
|
+
raise(
|
1243
|
+
ArgumentError,
|
1244
|
+
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be greater than or equal to 0."
|
1245
|
+
)
|
1078
1246
|
end
|
1079
1247
|
|
1080
|
-
path =
|
1248
|
+
path = "/2/filters/{attribute}".sub("{" + "attribute" + "}", Transport.encode_uri(attribute.to_s))
|
1081
1249
|
query_params = {}
|
1082
1250
|
query_params[:index] = index
|
1083
1251
|
query_params[:search] = search unless search.nil?
|
@@ -1093,7 +1261,7 @@ module Algolia
|
|
1093
1261
|
post_body = request_options[:debug_body]
|
1094
1262
|
|
1095
1263
|
new_options = request_options.merge(
|
1096
|
-
:operation => :
|
1264
|
+
:operation => :"AnalyticsClient.get_top_filter_for_attribute",
|
1097
1265
|
:header_params => header_params,
|
1098
1266
|
:query_params => query_params,
|
1099
1267
|
:body => post_body,
|
@@ -1117,9 +1285,32 @@ module Algolia
|
|
1117
1285
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1118
1286
|
# @param 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)
|
1119
1287
|
# @return [GetTopFilterForAttributeResponse]
|
1120
|
-
def get_top_filter_for_attribute(
|
1121
|
-
|
1122
|
-
|
1288
|
+
def get_top_filter_for_attribute(
|
1289
|
+
attribute,
|
1290
|
+
index,
|
1291
|
+
search = nil,
|
1292
|
+
start_date = nil,
|
1293
|
+
end_date = nil,
|
1294
|
+
limit = nil,
|
1295
|
+
offset = nil,
|
1296
|
+
tags = nil,
|
1297
|
+
request_options = {}
|
1298
|
+
)
|
1299
|
+
response = get_top_filter_for_attribute_with_http_info(
|
1300
|
+
attribute,
|
1301
|
+
index,
|
1302
|
+
search,
|
1303
|
+
start_date,
|
1304
|
+
end_date,
|
1305
|
+
limit,
|
1306
|
+
offset,
|
1307
|
+
tags,
|
1308
|
+
request_options
|
1309
|
+
)
|
1310
|
+
@api_client.deserialize(
|
1311
|
+
response.body,
|
1312
|
+
request_options[:debug_return_type] || "Analytics::GetTopFilterForAttributeResponse"
|
1313
|
+
)
|
1123
1314
|
end
|
1124
1315
|
|
1125
1316
|
# 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.
|
@@ -1135,16 +1326,29 @@ module Algolia
|
|
1135
1326
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1136
1327
|
# @param 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)
|
1137
1328
|
# @return [Http::Response] the response
|
1138
|
-
def get_top_filters_no_results_with_http_info(
|
1329
|
+
def get_top_filters_no_results_with_http_info(
|
1330
|
+
index,
|
1331
|
+
search = nil,
|
1332
|
+
start_date = nil,
|
1333
|
+
end_date = nil,
|
1334
|
+
limit = nil,
|
1335
|
+
offset = nil,
|
1336
|
+
tags = nil,
|
1337
|
+
request_options = {}
|
1338
|
+
)
|
1139
1339
|
# verify the required parameter 'index' is set
|
1140
1340
|
if @api_client.config.client_side_validation && index.nil?
|
1141
1341
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_filters_no_results`."
|
1142
1342
|
end
|
1343
|
+
|
1143
1344
|
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
1144
|
-
raise
|
1345
|
+
raise(
|
1346
|
+
ArgumentError,
|
1347
|
+
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filters_no_results, must be greater than or equal to 0."
|
1348
|
+
)
|
1145
1349
|
end
|
1146
1350
|
|
1147
|
-
path =
|
1351
|
+
path = "/2/filters/noResults"
|
1148
1352
|
query_params = {}
|
1149
1353
|
query_params[:index] = index
|
1150
1354
|
query_params[:search] = search unless search.nil?
|
@@ -1160,7 +1364,7 @@ module Algolia
|
|
1160
1364
|
post_body = request_options[:debug_body]
|
1161
1365
|
|
1162
1366
|
new_options = request_options.merge(
|
1163
|
-
:operation => :
|
1367
|
+
:operation => :"AnalyticsClient.get_top_filters_no_results",
|
1164
1368
|
:header_params => header_params,
|
1165
1369
|
:query_params => query_params,
|
1166
1370
|
:body => post_body,
|
@@ -1183,9 +1387,30 @@ module Algolia
|
|
1183
1387
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1184
1388
|
# @param 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)
|
1185
1389
|
# @return [GetTopFiltersNoResultsResponse]
|
1186
|
-
def get_top_filters_no_results(
|
1187
|
-
|
1188
|
-
|
1390
|
+
def get_top_filters_no_results(
|
1391
|
+
index,
|
1392
|
+
search = nil,
|
1393
|
+
start_date = nil,
|
1394
|
+
end_date = nil,
|
1395
|
+
limit = nil,
|
1396
|
+
offset = nil,
|
1397
|
+
tags = nil,
|
1398
|
+
request_options = {}
|
1399
|
+
)
|
1400
|
+
response = get_top_filters_no_results_with_http_info(
|
1401
|
+
index,
|
1402
|
+
search,
|
1403
|
+
start_date,
|
1404
|
+
end_date,
|
1405
|
+
limit,
|
1406
|
+
offset,
|
1407
|
+
tags,
|
1408
|
+
request_options
|
1409
|
+
)
|
1410
|
+
@api_client.deserialize(
|
1411
|
+
response.body,
|
1412
|
+
request_options[:debug_return_type] || "Analytics::GetTopFiltersNoResultsResponse"
|
1413
|
+
)
|
1189
1414
|
end
|
1190
1415
|
|
1191
1416
|
# Retrieves the object IDs of the most frequent search results.
|
@@ -1203,17 +1428,31 @@ module Algolia
|
|
1203
1428
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1204
1429
|
# @param 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)
|
1205
1430
|
# @return [Http::Response] the response
|
1206
|
-
def get_top_hits_with_http_info(
|
1207
|
-
|
1431
|
+
def get_top_hits_with_http_info(
|
1432
|
+
index,
|
1433
|
+
search = nil,
|
1434
|
+
click_analytics = nil,
|
1435
|
+
revenue_analytics = nil,
|
1436
|
+
start_date = nil,
|
1437
|
+
end_date = nil,
|
1438
|
+
limit = nil,
|
1439
|
+
offset = nil,
|
1440
|
+
tags = nil,
|
1441
|
+
request_options = {}
|
1442
|
+
)
|
1208
1443
|
# verify the required parameter 'index' is set
|
1209
1444
|
if @api_client.config.client_side_validation && index.nil?
|
1210
1445
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_hits`."
|
1211
1446
|
end
|
1447
|
+
|
1212
1448
|
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
1213
|
-
raise
|
1449
|
+
raise(
|
1450
|
+
ArgumentError,
|
1451
|
+
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_hits, must be greater than or equal to 0."
|
1452
|
+
)
|
1214
1453
|
end
|
1215
1454
|
|
1216
|
-
path =
|
1455
|
+
path = "/2/hits"
|
1217
1456
|
query_params = {}
|
1218
1457
|
query_params[:index] = index
|
1219
1458
|
query_params[:search] = search unless search.nil?
|
@@ -1231,7 +1470,7 @@ module Algolia
|
|
1231
1470
|
post_body = request_options[:debug_body]
|
1232
1471
|
|
1233
1472
|
new_options = request_options.merge(
|
1234
|
-
:operation => :
|
1473
|
+
:operation => :"AnalyticsClient.get_top_hits",
|
1235
1474
|
:header_params => header_params,
|
1236
1475
|
:query_params => query_params,
|
1237
1476
|
:body => post_body,
|
@@ -1256,10 +1495,31 @@ module Algolia
|
|
1256
1495
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1257
1496
|
# @param 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)
|
1258
1497
|
# @return [GetTopHitsResponse]
|
1259
|
-
def get_top_hits(
|
1260
|
-
|
1261
|
-
|
1262
|
-
|
1498
|
+
def get_top_hits(
|
1499
|
+
index,
|
1500
|
+
search = nil,
|
1501
|
+
click_analytics = nil,
|
1502
|
+
revenue_analytics = nil,
|
1503
|
+
start_date = nil,
|
1504
|
+
end_date = nil,
|
1505
|
+
limit = nil,
|
1506
|
+
offset = nil,
|
1507
|
+
tags = nil,
|
1508
|
+
request_options = {}
|
1509
|
+
)
|
1510
|
+
response = get_top_hits_with_http_info(
|
1511
|
+
index,
|
1512
|
+
search,
|
1513
|
+
click_analytics,
|
1514
|
+
revenue_analytics,
|
1515
|
+
start_date,
|
1516
|
+
end_date,
|
1517
|
+
limit,
|
1518
|
+
offset,
|
1519
|
+
tags,
|
1520
|
+
request_options
|
1521
|
+
)
|
1522
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopHitsResponse")
|
1263
1523
|
end
|
1264
1524
|
|
1265
1525
|
# Returns the most popular search terms.
|
@@ -1278,17 +1538,32 @@ module Algolia
|
|
1278
1538
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1279
1539
|
# @param 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)
|
1280
1540
|
# @return [Http::Response] the response
|
1281
|
-
def get_top_searches_with_http_info(
|
1282
|
-
|
1541
|
+
def get_top_searches_with_http_info(
|
1542
|
+
index,
|
1543
|
+
click_analytics = nil,
|
1544
|
+
revenue_analytics = nil,
|
1545
|
+
start_date = nil,
|
1546
|
+
end_date = nil,
|
1547
|
+
order_by = nil,
|
1548
|
+
direction = nil,
|
1549
|
+
limit = nil,
|
1550
|
+
offset = nil,
|
1551
|
+
tags = nil,
|
1552
|
+
request_options = {}
|
1553
|
+
)
|
1283
1554
|
# verify the required parameter 'index' is set
|
1284
1555
|
if @api_client.config.client_side_validation && index.nil?
|
1285
1556
|
raise ArgumentError, "Parameter `index` is required when calling `get_top_searches`."
|
1286
1557
|
end
|
1558
|
+
|
1287
1559
|
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
|
1288
|
-
raise
|
1560
|
+
raise(
|
1561
|
+
ArgumentError,
|
1562
|
+
"invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_searches, must be greater than or equal to 0."
|
1563
|
+
)
|
1289
1564
|
end
|
1290
1565
|
|
1291
|
-
path =
|
1566
|
+
path = "/2/searches"
|
1292
1567
|
query_params = {}
|
1293
1568
|
query_params[:index] = index
|
1294
1569
|
query_params[:clickAnalytics] = click_analytics unless click_analytics.nil?
|
@@ -1307,7 +1582,7 @@ module Algolia
|
|
1307
1582
|
post_body = request_options[:debug_body]
|
1308
1583
|
|
1309
1584
|
new_options = request_options.merge(
|
1310
|
-
:operation => :
|
1585
|
+
:operation => :"AnalyticsClient.get_top_searches",
|
1311
1586
|
:header_params => header_params,
|
1312
1587
|
:query_params => query_params,
|
1313
1588
|
:body => post_body,
|
@@ -1333,10 +1608,33 @@ module Algolia
|
|
1333
1608
|
# @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
1334
1609
|
# @param 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)
|
1335
1610
|
# @return [GetTopSearchesResponse]
|
1336
|
-
def get_top_searches(
|
1337
|
-
|
1338
|
-
|
1339
|
-
|
1611
|
+
def get_top_searches(
|
1612
|
+
index,
|
1613
|
+
click_analytics = nil,
|
1614
|
+
revenue_analytics = nil,
|
1615
|
+
start_date = nil,
|
1616
|
+
end_date = nil,
|
1617
|
+
order_by = nil,
|
1618
|
+
direction = nil,
|
1619
|
+
limit = nil,
|
1620
|
+
offset = nil,
|
1621
|
+
tags = nil,
|
1622
|
+
request_options = {}
|
1623
|
+
)
|
1624
|
+
response = get_top_searches_with_http_info(
|
1625
|
+
index,
|
1626
|
+
click_analytics,
|
1627
|
+
revenue_analytics,
|
1628
|
+
start_date,
|
1629
|
+
end_date,
|
1630
|
+
order_by,
|
1631
|
+
direction,
|
1632
|
+
limit,
|
1633
|
+
offset,
|
1634
|
+
tags,
|
1635
|
+
request_options
|
1636
|
+
)
|
1637
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopSearchesResponse")
|
1340
1638
|
end
|
1341
1639
|
|
1342
1640
|
# 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.
|
@@ -1355,7 +1653,7 @@ module Algolia
|
|
1355
1653
|
raise ArgumentError, "Parameter `index` is required when calling `get_users_count`."
|
1356
1654
|
end
|
1357
1655
|
|
1358
|
-
path =
|
1656
|
+
path = "/2/users/count"
|
1359
1657
|
query_params = {}
|
1360
1658
|
query_params[:index] = index
|
1361
1659
|
query_params[:startDate] = start_date unless start_date.nil?
|
@@ -1368,7 +1666,7 @@ module Algolia
|
|
1368
1666
|
post_body = request_options[:debug_body]
|
1369
1667
|
|
1370
1668
|
new_options = request_options.merge(
|
1371
|
-
:operation => :
|
1669
|
+
:operation => :"AnalyticsClient.get_users_count",
|
1372
1670
|
:header_params => header_params,
|
1373
1671
|
:query_params => query_params,
|
1374
1672
|
:body => post_body,
|
@@ -1390,7 +1688,8 @@ module Algolia
|
|
1390
1688
|
# @return [GetUsersCountResponse]
|
1391
1689
|
def get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
1392
1690
|
response = get_users_count_with_http_info(index, start_date, end_date, tags, request_options)
|
1393
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] ||
|
1691
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetUsersCountResponse")
|
1394
1692
|
end
|
1693
|
+
|
1395
1694
|
end
|
1396
1695
|
end
|