Sign in

v1

latestOpenAPI 3.0.02026-07-1329122146.2 KB
AdminService

Displays usage information about indexing and query operations in a corpus. This helps administrators in analyzing and managing resource consumption more efficiently for specific corpora.

Some tips for this API:

  • Use these metrics to determine usage patterns that enable you to optimize resource allocations.
  • This operation works with the Personal API Key and OAuth 2.0 (in a JWT "Bearer Token") authentication. You can find details of how to set up and use OAuth 2.0 here.
  • The filter feature applies to either the name or the description of a corpus.
post/v1/get-usage-metrics

Headers

customer-idinteger required

Enter the Customer ID to use for the request.

timeoutstring

(Optional) Enter the timeout value of the request in seconds, such as 10S or 30S.

Request body

corpusIdinteger

The corpus for which the metric is requested.

type'METRICTYPE__NONE' | 'METRICTYPE__INDEXING' | 'METRICTYPE__SERVING'
aggregationIntervalSecsstring int64

The response stats will be aggregated by this interval. Minimum aggregation interval is 1 minute. Supported granularity units for aggregation are days, hours and minutes. For example, If 2.5 days (in seconds) are passed, results will be aggregated by 2 days. Similarly, if 7.6 hours (in seconds) are passed, results will be aggregated by 7 hours.

Response

A successful response.