Delete records matching a filter

This operation doesn’t accept empty filters.

This operation is resource-intensive. You should only use it if you can’t get the object IDs of the records you want to delete. It’s more efficient to get a list of object IDs with the browse operation, and then delete the records using the batch operation.

This operation is subject to indexing rate limits.

Usage

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

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

$response = $client->deleteBy(
    'ALGOLIA_INDEX_NAME',
    ['filters' => 'brand:brandName',
    ],
);
Did you find this page helpful?
PHP API clients v4