Skip to content

Commit 84897e7

Browse files
algolia-botkai687
andcommitted
fix(specs): clarify getIndexingTime (generated)
algolia/api-clients-automation#6276 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Kai Welke <kai.welke@algolia.com>
1 parent 94bdbf3 commit 84897e7

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

packages/monitoring/src/monitoringClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ export function createMonitoringClient({
304304
},
305305

306306
/**
307-
* Retrieves average times for indexing operations for selected clusters.
307+
* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. The returned value reflects latency measured on Algolia\'s internal monitoring index and is reported in milliseconds. This metric isn\'t intended to represent the indexing performance of an individual application or index. To measure when an indexing operation has completed for your application, use the `waitTask` method.
308308
* @param getIndexingTime - The getIndexingTime object.
309309
* @param getIndexingTime.clusters - Subset of clusters, separated by commas.
310310
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

0 commit comments

Comments
 (0)