UsageClient

Value parameters

parameters

Query parameters to apply to the current query.

path

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

Attributes

Value parameters

parameters

Query parameters to apply to the current query.

path

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

Attributes

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

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

Attributes

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

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

Attributes

Value parameters

endDate

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

granularity

Granularity of the aggregated metrics. - hourly: the maximum time range for hourly metrics is 7 days. - daily: the maximum time range for daily metrics is 365 days.

indexName

Name of the index on which to perform the operation.

startDate

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

statistic

Usage statistics to retrieve. Use * to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. Search operations - search_operations. All search operations. - total_search_operations: Sum of all search operations. - total_search_requests: Sum of all search requests. The number of billed search requests is equal to this value minus querysuggestions_total_search_requests. - queries_operations. Number of single index search operations. - multi_queries_operations. Number of multi-index search operations. ACL operations - acl_operations. All ACL operations. - total_acl_operations. Sum of all ACL operations. - get_api_keys_operations. Number of list API keys operations. - get_api_key_operations. Number of get API key permission operations. - add_api_key_operations. Number of create API key operations. - update_api_key_operations. Number of update API key operations. - delete_api_key_operations. Number of delete API key operations. - list_api_key_operations. Number of list index API keys operations. Indexing operations - indexing_operations. All indexing operations. - total_indexing_operations. Sum of all indexing operations. - browse_operations. Number of browse index operations. - clear_index_operations. Number of clear records operations. - copy_move_operations. Number of copy or move index operations. - delete_index_operations. Number of delete index operations. - get_log_operations. Number of get logs operations. - get_settings_operations. Number of get settings operations. - set_settings_operations. Number of set settings operations. - list_indices_operations. Number of list indices operations. - wait_task_operations. Number of wait operations. Record operations - record_operations. All record operations. - total_records_operations. Sum of all record operations. - add_record_operations. Number of add or replace record operations. - batch_operations. Number of batch indexing operations. - delete_by_query_operations. Number of delete by query operations. - delete_record_operations. Number of delete record operations. - get_record_operations. Number of get record operations. - partial_update_record_operations. Number of partially update records operations. - update_record_operations. Number of add or replace record by objectID operations. Synonym operations - synonym_operations. All synonym operations. - total_synonym_operations. Sum of all synonym operations. - batch_synonym_operations. Number of save all synonyms operations. - clear_synonym_operations. Number of clear synonyms operations. - delete_synonym_operations. Number of delete synonym operations. - get_synonym_operations. Number of get synonym operations. - query_synonym_operations. Number of search synonyms operations. - update_synonym_operations. Number of save a synonym operations. Rule operations - rule_operations. All rule operations. - total_rules_operations. Sum of all rule operations. - batch_rules_operations. Number of batch rules operations. - clear_rules_operations. Number of delete rule operations. - delete_rules_operations. Number of clear rules operations. - get_rules_operations. Number of get rule operations. - save_rules_operations. Number of save rule operations. - search_rules_operations. Number of search rules operations. Total operations - total_recommend_requests. Number of Recommend requests - total_write_operations. Number of Write operations - total_read_operations. Number of read operations - total_operations. Sum of all operations Total Query Suggestions operations Query Suggestions operations are a subset of total_search_operations. - querysuggestions_total_search_operations. Number of Query Suggestions search operations. - querysuggestions_total_search_requests. Number of Query Suggestions search requests. - querysuggestions_total_acl_operations. Sum of all Query Suggestions ACL operations. - querysuggestions_total_indexing_operations. Number of Query Suggestions indexing operations. - querysuggestions_total_records_operations. Number of Query Suggestions record operations. - querysuggestions_total_synonym_operations. Number of Query Suggestions synonym operations. - querysuggestions_total_rules_operations. Number of Query Suggestions Rule operations. - querysuggestions_total_write_operations. Number of Query Suggestions Write operations. - querysuggestions_total_read_operations. Number of Query Suggestions Read operations. - querysuggestions_total_operations. Sum of all Query Suggestions operations. Processing time - avg_processing_time. Average processing time (in milliseconds). - 90p_processing_time. 90th percentile of processing time (in milliseconds). - 99p_processing_time. 99th percentile of processing time (in milliseconds). - queries_above_last_ms_processing_time. Number of queries that take one or more seconds to process. Indices - records. Number of records. - data_size. The size of the records (in bytes). - file_size. The size of the records and index metadata (in bytes). Maximum queries per second - max_qps. Maximum queries per second per server. - region_max_qps. Maximum queries per second per region. - total_max_qps. Maximum queries per second across all servers. Used search capacity The following capacities are reported in percent: - used_search_capacity. Maximum search capacity used per server. - avg_used_search_capacity. Average search capacity used per server. - region_used_search_capacity. Maximum search capacity used per region. - region_avg_used_search_capacity. Average search capacity used per region. - total_used_search_capacity. Maximum search capacity used for all servers. - total_avg_used_search_capacity. Average used search capacity for all servers. Degraded queries Check the impact of degraded queries. - degraded_queries_ssd_used_queries_impacted. Percentage of degraded queries due to the Algolia search engine having to read from the server's SSD. - degraded_queries_ssd_used_seconds_impacted. Percentage of seconds affected by ssd_used degraded queries. - degraded_queries_max_capacity_queries_impacted. Percentage of degraded queries due to all search threads being used. - degraded_queries_max_capacity_seconds_impacted. Percentage of seconds affected by max_capacity degraded queries.

Attributes

Value parameters

endDate

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

granularity

Granularity of the aggregated metrics. - hourly: the maximum time range for hourly metrics is 7 days. - daily: the maximum time range for daily metrics is 365 days.

startDate

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

statistic

Usage statistics to retrieve. Use * to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. Search operations - search_operations. All search operations. - total_search_operations: Sum of all search operations. - total_search_requests: Sum of all search requests. The number of billed search requests is equal to this value minus querysuggestions_total_search_requests. - queries_operations. Number of single index search operations. - multi_queries_operations. Number of multi-index search operations. ACL operations - acl_operations. All ACL operations. - total_acl_operations. Sum of all ACL operations. - get_api_keys_operations. Number of list API keys operations. - get_api_key_operations. Number of get API key permission operations. - add_api_key_operations. Number of create API key operations. - update_api_key_operations. Number of update API key operations. - delete_api_key_operations. Number of delete API key operations. - list_api_key_operations. Number of list index API keys operations. Indexing operations - indexing_operations. All indexing operations. - total_indexing_operations. Sum of all indexing operations. - browse_operations. Number of browse index operations. - clear_index_operations. Number of clear records operations. - copy_move_operations. Number of copy or move index operations. - delete_index_operations. Number of delete index operations. - get_log_operations. Number of get logs operations. - get_settings_operations. Number of get settings operations. - set_settings_operations. Number of set settings operations. - list_indices_operations. Number of list indices operations. - wait_task_operations. Number of wait operations. Record operations - record_operations. All record operations. - total_records_operations. Sum of all record operations. - add_record_operations. Number of add or replace record operations. - batch_operations. Number of batch indexing operations. - delete_by_query_operations. Number of delete by query operations. - delete_record_operations. Number of delete record operations. - get_record_operations. Number of get record operations. - partial_update_record_operations. Number of partially update records operations. - update_record_operations. Number of add or replace record by objectID operations. Synonym operations - synonym_operations. All synonym operations. - total_synonym_operations. Sum of all synonym operations. - batch_synonym_operations. Number of save all synonyms operations. - clear_synonym_operations. Number of clear synonyms operations. - delete_synonym_operations. Number of delete synonym operations. - get_synonym_operations. Number of get synonym operations. - query_synonym_operations. Number of search synonyms operations. - update_synonym_operations. Number of save a synonym operations. Rule operations - rule_operations. All rule operations. - total_rules_operations. Sum of all rule operations. - batch_rules_operations. Number of batch rules operations. - clear_rules_operations. Number of delete rule operations. - delete_rules_operations. Number of clear rules operations. - get_rules_operations. Number of get rule operations. - save_rules_operations. Number of save rule operations. - search_rules_operations. Number of search rules operations. Total operations - total_recommend_requests. Number of Recommend requests - total_write_operations. Number of Write operations - total_read_operations. Number of read operations - total_operations. Sum of all operations Total Query Suggestions operations Query Suggestions operations are a subset of total_search_operations. - querysuggestions_total_search_operations. Number of Query Suggestions search operations. - querysuggestions_total_search_requests. Number of Query Suggestions search requests. - querysuggestions_total_acl_operations. Sum of all Query Suggestions ACL operations. - querysuggestions_total_indexing_operations. Number of Query Suggestions indexing operations. - querysuggestions_total_records_operations. Number of Query Suggestions record operations. - querysuggestions_total_synonym_operations. Number of Query Suggestions synonym operations. - querysuggestions_total_rules_operations. Number of Query Suggestions Rule operations. - querysuggestions_total_write_operations. Number of Query Suggestions Write operations. - querysuggestions_total_read_operations. Number of Query Suggestions Read operations. - querysuggestions_total_operations. Sum of all Query Suggestions operations. Processing time - avg_processing_time. Average processing time (in milliseconds). - 90p_processing_time. 90th percentile of processing time (in milliseconds). - 99p_processing_time. 99th percentile of processing time (in milliseconds). - queries_above_last_ms_processing_time. Number of queries that take one or more seconds to process. Indices - records. Number of records. - data_size. The size of the records (in bytes). - file_size. The size of the records and index metadata (in bytes). Maximum queries per second - max_qps. Maximum queries per second per server. - region_max_qps. Maximum queries per second per region. - total_max_qps. Maximum queries per second across all servers. Used search capacity The following capacities are reported in percent: - used_search_capacity. Maximum search capacity used per server. - avg_used_search_capacity. Average search capacity used per server. - region_used_search_capacity. Maximum search capacity used per region. - region_avg_used_search_capacity. Average search capacity used per region. - total_used_search_capacity. Maximum search capacity used for all servers. - total_avg_used_search_capacity. Average used search capacity for all servers. Degraded queries Check the impact of degraded queries. - degraded_queries_ssd_used_queries_impacted. Percentage of degraded queries due to the Algolia search engine having to read from the server's SSD. - degraded_queries_ssd_used_seconds_impacted. Percentage of seconds affected by ssd_used degraded queries. - degraded_queries_max_capacity_queries_impacted. Percentage of degraded queries due to all search threads being used. - degraded_queries_max_capacity_seconds_impacted. Percentage of seconds affected by max_capacity degraded queries.

Attributes

Attributes

Definition Classes

ApiClient -> AutoCloseable

Inherited from:

ApiClient