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
7
8
9
10
from algoliasearch.monitoring.client import MonitoringClientSync
from json import loads

# In an asynchronous context, you can use MonitoringClient instead, which exposes the exact same methods.
client = MonitoringClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.get_metrics(
    metric="avg_build_time",
    period="minute",
)
Did you find this page helpful?