POST /1/indexes/{indexName}/deleteByQuery
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.
Servers
- https://{appId}.algolia.net
- https://{appId}-1.algolianet.com
- https://{appId}-2.algolianet.com
- https://{appId}-3.algolianet.com
- https://{appId}-dsn.algolia.net
Path parameters
Name | Type | Required | Description |
---|---|---|---|
indexName |
String | Yes |
Name of the index on which to perform the operation. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
filters |
String | No |
Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions:
You can combine filters with
Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords ( For more information, see Filters. |
tagFilters |
Object | No |
Filter the search by values of the special Prefer using the Different from regular facets, |
numericFilters |
Object | No |
Filter by numeric facets. Prefer using the You can use numeric comparison operators: |
insidePolygon[] |
Array | No |
Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude.
Provide multiple polygons as nested arrays.
For more information, see filtering inside polygons.
This parameter is ignored if you also specify |
insideBoundingBox |
Object | No | |
aroundLatLng |
String | No |
Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results.
The radius of the circle is determined by the |
aroundRadius |
Object | No |
Maximum radius for a search around a central location. This parameter works in combination with the |
facetFilters |
Object | No |
Filter the search by facet values, so that only records with the same facet values are retrieved. Prefer using the
While it's best to avoid attributes that start with a |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.