Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
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
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
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
Retrieves known incidents for the selected clusters.
Retrieves known incidents for the selected clusters.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
Retrieves the status of selected clusters.
Retrieves the status of selected clusters.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
Retrieves known incidents for all clusters.
Retrieves known incidents for all clusters.
Attributes
Retrieves average times for indexing operations for selected clusters.
Retrieves average times for indexing operations for selected clusters.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
Retrieves the average latency for search requests for selected clusters.
Retrieves the average latency for search requests for selected clusters.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the Premium or Elevate plans. You must authenticate requests with the x-algolia-application-id and x-algolia-api-key headers (using the Monitoring API key).
Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the Premium or Elevate plans. You must authenticate requests with the x-algolia-application-id and x-algolia-api-key headers (using the Monitoring API key).
Value parameters
- metric
-
Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use
*. - period
-
Period over which to aggregate the metrics: -
minute. Aggregate the last minute. 1 data point per 10 seconds. -hour. Aggregate the last hour. 1 data point per minute. -day. Aggregate the last day. 1 data point per 10 minutes. -week. Aggregate the last week. 1 data point per hour. -month. Aggregate the last month. 1 data point per day.
Attributes
Test whether clusters are reachable or not.
Test whether clusters are reachable or not.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.
Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.
Attributes
Retrieves the status of all Algolia clusters and instances.
Retrieves the status of all Algolia clusters and instances.