Image Search
Search through indexed images of a search engine.
Authorizations
Query Parameters
Exclusive parameters are negative filters.
Doofinder expects the exclude parameters grouped like this:
exclude: { color: ['blue', 'red'], size: ['M', 'S'], price: { gte: 4.36, lt: 99 } }
For the range filters it can be used the following:
- gte: Greater than or equal
- lte: Less than or equal
- gt: Greater than
- lt: Less than
Writing that down in request parameters language is:
exclude[color][]=blue&exclude[color][]=red&exclude[size]=M&exclude[size]=S&exclude[price][gte]=4.36&exclude[price][lt]=99
Note that [ and ] characters should be escaped (%5B and %5D) in all exclude cases.
Aggregates fields values in a facet, you could use a term facet or range facet. Read facets configuration for more deep info about facets.
The type of the facet (term or range) will be determined automatically.
Parameters:
- field*: That is the field name that you want to aggregate results.
- size: The number of results to return in each field. Only applicable to facet terms. Maximum: 50 by default to help maintain the speed of the search function. If you need more, please contact Doofinder support.
- type: The facet type. Indicates the type of the facet, one of
termorrange. will return an error if the facet type is not correct.
*required parameter
Example request returning the brand term facet and the best_facet range facet:
facets[0][field]=brand&facets[0][size]=10&facets[1][field]=best_price.
Filter parameters for items.
Doofinder expects the filter parameters grouped like this:
filter: { color: ['blue', 'red'], size: ['M', 'S'], price: { gte: 4.36, lt: 99 } }
Range filters can be used as follow:
- gte: Greater than or equal
- lte: Less than or equal
- gt: Greater than
- lt: Less than
Writing that down in request parameters language:
filter[color][]=blue&filter[color][]=red&filter[size][]=M&filter[size][]=S&filter[price][gte]=4.36&filter[price][lt]=99
Note that [ and ] characters should be escaped (%5B and %5D) in all filter cases.
Sorted results by certain fields.
Doofinder expects sort parameters like this:
sort: [{"price": "asc"}, {"brand": "desc"}]
Writing that down in request parameters language is:
sort[0][price]=asc&sort[1][brand]=desc
Note that [ and ] characters should be escaped (%5B and %5D) in all filter cases.
Response
OK
Search response. Some fields can not be included in the request if they have not data.