Retrieve metrics

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).

Usage

1
2
3
4
5
6
import { algoliasearch } from 'algoliasearch';

//
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initMonitoring();

const response = await client.getMetrics({ metric: 'avg_build_time', period: 'minute' });