This client is new in v4 of the Python API clients.

The Monitoring API client is part of the algoliasearch package. You can install this package with pip:

1
pip install 'algoliasearch>=4,<5'

To use the Monitoring client, add this import to your files:

1
from algoliasearch.monitoring.client import MonitoringClientSync

To create an instance of the client:

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

Async code

To use the Monitoring client in async environments, add these imports instead:

1
2
import asyncio
from algoliasearch.monitoring.client import MonitoringClient

The client supports the async with statement to automatically close open connections.

1
2
3
async def run():
    async with MonitoringClient(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) as client:
        # client.search(...)

The method names are the same for synchronous and asynchronous methods.

List of methods

Each method makes one request to the Monitoring API.

Status

Incidents

Monitoring

Infrastructure

Did you find this page helpful?