Check task status

Checks the status of a given task.

Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server.

The indexing tasks’ responses include a task ID that you can use to check the status.

Usage

Required ACL: addObject
1
2
3
4
5
6
7
8
use Algolia\AlgoliaSearch\Api\SearchClient;

$client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

$response = $client->getTask(
    'ALGOLIA_INDEX_NAME',
    123,
);
Did you find this page helpful?