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
List known incidents for selected clusters.
List known incidents for selected clusters.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
Report whether a cluster is operational.
Report whether a cluster is operational.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
List known incidents for all clusters.
List known incidents for all clusters.
Attributes
List the average times for indexing operations for selected clusters.
List the average times for indexing operations for selected clusters.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
List the servers belonging 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.
List the servers belonging 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
List the average latency for search requests for selected clusters.
List the average latency for search requests for selected clusters.
Value parameters
- clusters
-
Subset of clusters, separated by comma.
Attributes
Report the aggregate value of a metric for a selected period of time.
Report the aggregate value of a metric for a selected period of time.
Value parameters
- metric
-
Metric to report. For more information about the individual metrics, see the response. To include all metrics, use
*as the parameter. - 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
Report whether clusters are operational. The response depends on whether you authenticate your API request. - With authentication, the response includes the status of the cluster assigned to your Algolia application. - Without authentication, the response lists the statuses of all public Algolia clusters.
Report whether clusters are operational. The response depends on whether you authenticate your API request. - With authentication, the response includes the status of the cluster assigned to your Algolia application. - Without authentication, the response lists the statuses of all public Algolia clusters.