Overview

This node operation retrieves statistical information about a specific index in Meilisearch. It is useful for monitoring the status and usage metrics of an index, such as the number of documents it contains and other relevant statistics. For example, a user might use this operation to check the health or size of an index before performing further search or indexing operations.

Use Case Examples

1. Retrieve stats for an index named 'products' to monitor document count and index health.
2. Check index statistics to optimize search performance or storage usage.

Properties

Output

JSON

• json - Contains the statistical data of the specified index, such as document count and other index metrics.

Dependencies

• Requires Meilisearch API credentials for authentication and access to the Meilisearch instance.

Troubleshooting

• Common issues include providing an invalid or non-existent index UID, which will result in an error from the Meilisearch API indicating the index was not found.
• Network or authentication errors may occur if the API credentials are incorrect or the Meilisearch server is unreachable.
• Timeout errors might happen if the Meilisearch server is slow to respond; ensure the server is operational and accessible.