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.

Required ACL: deleteIndex

See also: Should I use the deleteBy method for deleting records

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName · string · required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

Body

application/json

facetFilters

Filter the search by facet values, so that only records with the same facet values are retrieved.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

• [filter1, filter2] is interpreted as filter1 AND filter2.
• [[filter1, filter2], filter3] is interpreted as filter1 OR filter2 AND filter3.
• facet:-value is interpreted as NOT facet:value.

While it's best to avoid attributes that start with a -, you can still filter them by escaping with a backslash: facet:\-value.

Show child attributes

Example:

[
  ["category:Book", "category:-Movie"],
  "author:John Doe"
]

filters · string

Filter expression to only include items that match the filter criteria in the response.

You can use these filter expressions:

• Numeric filters. <facet> <op> <number>, where <op> is one of <, <=, =, !=, >, >=.
• Ranges. <facet>:<lower> TO <upper> where <lower> and <upper> are the lower and upper limits of the range (inclusive).
• Facet filters. <facet>:<value> where <facet> is a facet attribute (case-sensitive) and <value> a facet value.
• Tag filters. _tags:<value> or just <value> (case-sensitive).
• Boolean filters. <facet>: true | false.

You can combine filters with AND, OR, and NOT operators with the following restrictions:

• You can only combine filters of the same type with OR. Not supported: facet:value OR num > 3.
• You can't use NOT with combinations of filters. Not supported: NOT(facet:value OR facet:value)
• You can't combine conjunctions (AND) with OR. Not supported: facet:value OR (facet:value AND facet:value)

Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (OR, AND, NOT), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.

For more information, see Filters.

Example:

"(category:Book OR category:Ebook) AND _tags:published"

numericFilters

Filter by numeric facets.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

You can use numeric comparison operators: <, <=, =, !=, >, >=. Comparisons are precise up to 3 decimals. You can also provide ranges: facet:<lower> TO <upper>. The range includes the lower and upper boundaries. The same combination rules apply as for facetFilters.

Show child attributes

Example:

[
  ["inStock = 1", "deliveryDate < 1441755506"],
  "price < 1000"
]

tagFilters

Filter the search by values of the special _tags attribute.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

Different from regular facets, _tags can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for facetFilters.

Show child attributes

Example:

[["Book", "Movie"], "SciFi"]

aroundLatLng · string · default: ""

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 and minimumAroundRadius settings. This parameter is ignored if you also specify insidePolygon or insideBoundingBox.

Example:

"40.71,-74.01"

aroundRadius

Maximum radius for a search around a central location.

This parameter works in combination with the aroundLatLng and aroundLatLngViaIP parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.

Maximum search radius around a central location in meters.

Required range: x >= 1

insideBoundingBox

insidePolygon · number[][]

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.

Show child attributes

Example:

[
  [
    47.3165,
    4.9665,
    47.3424,
    5.0201,
    47.32,
    4.9
  ],
  [
    40.9234,
    2.1185,
    38.643,
    1.9916,
    39.2587,
    2.0104
  ]
]

Response

200

application/json

OK

Response, taskID, and update timestamp.

taskID · integer · required

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this task ID.

Example:

1514562690001

updatedAt · string · required

Date and time when the object was updated, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"