# Doofinder API Reference

- [Doofinder API Reference](https://docs.doofinder.com/index.md): Complete reference for the Doofinder suite of APIs. Build powerful search experiences, manage your data, and unlock analytics insights.
- [Quick Start](https://docs.doofinder.com/introduction/quickstart.md): Make your first Doofinder API call in under 5 minutes.
- [Authentication](https://docs.doofinder.com/introduction/authentication.md): How to authenticate with Doofinder APIs.
- [Error Reference](https://docs.doofinder.com/introduction/errors.md): HTTP error codes and error response formats across all Doofinder APIs.
- [Search API](https://docs.doofinder.com/search-api/overview.md): Query your Doofinder search engine, get suggestions, run image search, and track user interactions.
- [Search query](https://docs.doofinder.com/api-reference/search/search-query.md): Search through indexed items of a search engine.
- [Search query (POST)](https://docs.doofinder.com/api-reference/search/search-query-post.md): Search through indexed items of a search engine. Identical to the GET variant but accepts parameters as a JSON body, which is useful when query strings would be too long or when sending complex nested structures (filters, facets, sort).
- [Image Search](https://docs.doofinder.com/api-reference/search/image-search.md): Search through indexed images of a search engine.
- [Suggestions](https://docs.doofinder.com/api-reference/search/suggestions.md): Search through indexed suggestions of a search engine.
- [Visually Similar](https://docs.doofinder.com/api-reference/search/visually-similar.md): Search for elements visually similar to the given dfid.
- [Add to cart](https://docs.doofinder.com/api-reference/session-&-events/add-to-cart.md): Registers a click event on the cart.
- [Logs a checkout](https://docs.doofinder.com/api-reference/session-&-events/logs-a-checkout.md): Logs a checkout event in stats logs. That is the event for when a customer complete a checkout. The info of the items that were in her session when she completes the checkout are logged in the event.
- [Click stats](https://docs.doofinder.com/api-reference/session-&-events/click-stats.md): Save click event on doofinder statistics
- [Logs a banner image click](https://docs.doofinder.com/api-reference/session-&-events/logs-a-banner-image-click.md): Logs a "click on banner image" event in stats logs.
- [Init session](https://docs.doofinder.com/api-reference/session-&-events/init-session.md): Starts a session identified by a session_id. The session is used to "group" events. I.e. it groups user interactions during a session. Like clicking some banner images, or completing a checkout.
- [Logs a redirection](https://docs.doofinder.com/api-reference/session-&-events/logs-a-redirection.md): Logs a "redirection triggered" event in stats logs.
- [Management API](https://docs.doofinder.com/management-api/overview.md): Manage Doofinder search engines, indices, and items programmatically.
- [Get from temporal](https://docs.doofinder.com/api-reference/items/get-from-temporal.md): Gets an item from the temporal index by its id.
- [Delete from temporal](https://docs.doofinder.com/api-reference/items/delete-from-temporal.md): Deletes an item from the temporal index given its id.
- [Update from temporal](https://docs.doofinder.com/api-reference/items/update-from-temporal.md): Partially updates an item in the temporal index given its id. The operation will return the updated item.
- [Create in bulk in temporal](https://docs.doofinder.com/api-reference/items/create-in-bulk-in-temporal.md): Creates a list of items in the temporal index in a single bulk operation.
- [Delete in bulk from temporal](https://docs.doofinder.com/api-reference/items/delete-in-bulk-from-temporal.md): Deletes a list of items in the temporal index in a single bulk operation.
- [Update in bulk from temporal](https://docs.doofinder.com/api-reference/items/update-in-bulk-from-temporal.md): Updates a list of items in the temporal index in a single bulk operation.
- [Create in temporal](https://docs.doofinder.com/api-reference/items/create-in-temporal.md): Creates an item with the data provided in the temporal index.
- [Find by ids from temporal](https://docs.doofinder.com/api-reference/items/find-by-ids-from-temporal.md): Finds a list items from a temporal index in a single operation by a list of ids.
- [Get](https://docs.doofinder.com/api-reference/items/get.md): Gets an item from the index by its id.
- [Delete](https://docs.doofinder.com/api-reference/items/delete.md): Deletes item from the index by its id.
- [Update](https://docs.doofinder.com/api-reference/items/update.md): Partially updates item from index by its id. The operation returns the updated item.
- [Create in bulk](https://docs.doofinder.com/api-reference/items/create-in-bulk.md): Creates a list of items in the index in a single bulk operation.
- [Delete in bulk](https://docs.doofinder.com/api-reference/items/delete-in-bulk.md): Deletes a list of items from the index in a single bulk operation.
- [Update in bulk](https://docs.doofinder.com/api-reference/items/update-in-bulk.md): Updates a list of items from the index in a single bulk operation.
- [Scroll index](https://docs.doofinder.com/api-reference/items/scroll-index.md): Scrolls through all the items of an index. The first request starts the scroll and generate a scroll id that can be traversed with each successive requests. There is a limited time period on which the traverse is possible. After 5 minutes the scroll expires and it is no longer accesible, a new reque…
- [Create](https://docs.doofinder.com/api-reference/items/create.md): Creates an item in the index with the data provided.
- [Find by ids](https://docs.doofinder.com/api-reference/items/find-by-ids.md): Finds a list items in a single operation by a list of ids.
- [Items count](https://docs.doofinder.com/api-reference/items/items-count.md): Returns the total number of items in an index.
- [Create temporary index](https://docs.doofinder.com/api-reference/indices/create-temporary-index.md): Creates a new empty temporary index for the same index name. There can not be two temporary indices at the same time, so any request made to this endpoint when there is one created will fail. Creating a temporary index also sets a lock preventing any changes on the search engine until the temporary…
- [Delete temporary index](https://docs.doofinder.com/api-reference/indices/delete-temporary-index.md): Deletes the temporary index. This also removes the lock in the search engine. If there is no temporary index this will return a 404 (Not found).
- [Replace indices](https://docs.doofinder.com/api-reference/indices/replace-indices.md): Replaces the content of the current "production" index with the content of the temporary one.
- [Reindexing task status](https://docs.doofinder.com/api-reference/indices/reindexing-task-status.md): Returns the status of the last scheduled reindexing tasks. If there is none, or the task finished more than 24 hours ago, it will return a 404 error.
- [Reindex into temporary index](https://docs.doofinder.com/api-reference/indices/reindex-into-temporary-index.md): This executes a reindexing operation between the real index and the temporary one. It reads all items from the real and index them onto the temporary. This will return a 404 (Not found) if there is no temporary index.
- [Get](https://docs.doofinder.com/api-reference/indices/get.md): Gets a search engine index.
- [Delete](https://docs.doofinder.com/api-reference/indices/delete.md): Deletes a search engine index.
- [Update](https://docs.doofinder.com/api-reference/indices/update.md): Updates a search engine index.
- [List](https://docs.doofinder.com/api-reference/indices/list.md): List all indices of search engine.
- [Create](https://docs.doofinder.com/api-reference/indices/create.md): Creates a new index for a search engine.
- [Get process task status](https://docs.doofinder.com/api-reference/search-engines/get-process-task-status.md): Gets the status of the last process task. Status persists for 72 hours. If there is no recent task, it will return an error.
- [Process](https://docs.doofinder.com/api-reference/search-engines/process.md): Schedules a task for processing all search engine's data sources.
- [Get](https://docs.doofinder.com/api-reference/search-engines/get.md): Gets a search engine details.
- [Delete](https://docs.doofinder.com/api-reference/search-engines/delete.md): Deletes a search engine.
- [Update](https://docs.doofinder.com/api-reference/search-engines/update.md): Updates a search engine.
- [List](https://docs.doofinder.com/api-reference/search-engines/list.md): Lists all user's search engines.
- [Create](https://docs.doofinder.com/api-reference/search-engines/create.md): Creates a new search engine with the provided data. It is not possible to run searches against the new search engine as it does not have any index yet. You must create an index belonging to the new search engine to be able to make searches.
- [Stats API](https://docs.doofinder.com/stats-api/overview.md): Retrieve analytics and usage data for your Doofinder search engines.
- [Banners](https://docs.doofinder.com/api-reference/features/banners.md): Gets how many times banners have been displayed and clicked in a time period, grouped by banner id.
- [Custom results](https://docs.doofinder.com/api-reference/features/custom-results.md): Gets how many times custom results have been displayed and clicked in a time period, grouped by custom result id.
- [Facets](https://docs.doofinder.com/api-reference/features/facets.md): Gets how many times facets filters have been used in a time period, grouped by facet field.
- [Top facets values](https://docs.doofinder.com/api-reference/features/top-facets-values.md): Gets most common facets filters used, how many times they have been used and which filter has been applied in a time period.
- [Facets by day](https://docs.doofinder.com/api-reference/features/facets-by-day.md): Gets how many times facets filters have been used in a time period, grouped by day.
- [Sector](https://docs.doofinder.com/api-reference/features/sector.md): Retrieve the median of the metric you send for the sector and/or the hashid.
- [Visit stats](https://docs.doofinder.com/api-reference/features/visit-stats.md): Save visit event on Doofinder statistics
- [Checkout cart process](https://docs.doofinder.com/api-reference/conversions-&-sales/checkout-cart-process.md): Process checkout cart information on Doofinder statistics.
- [Checkouts](https://docs.doofinder.com/api-reference/conversions-&-sales/checkouts.md): Counts numbers of checkouts in a time period grouped by day.
- [Sales](https://docs.doofinder.com/api-reference/conversions-&-sales/sales.md): Gets the total price for sales checkouts in a period, where a session id identifies every sale.
- [Sale confirm](https://docs.doofinder.com/api-reference/conversions-&-sales/sale-confirm.md): Register checkout event.
- [Get top sales](https://docs.doofinder.com/api-reference/conversions-&-sales/get-top-sales.md): Gets the top sold items in a period.
- [Clicked items](https://docs.doofinder.com/api-reference/clicks-&-interactions/clicked-items.md): Gets the most commonly clicked items in a time period.
- [Clicks items and position](https://docs.doofinder.com/api-reference/clicks-&-interactions/clicks-items-and-position.md): Gets the number of clicks each clicked product had in a period of time grouped by position.
- [Clicked item searches](https://docs.doofinder.com/api-reference/clicks-&-interactions/clicked-item-searches.md): Gets the most common searched for a clicked item, and how many times it has been clicked from those searches.
- [Clicks](https://docs.doofinder.com/api-reference/clicks-&-interactions/clicks.md): Counts number of clicks in a time period grouped by day.
- [Clicks with users](https://docs.doofinder.com/api-reference/clicks-&-interactions/clicks-with-users.md): Counts numbers of different users and products in clicks for a time period.
- [Redirections](https://docs.doofinder.com/api-reference/clicks-&-interactions/redirections.md): Gets redirections and how many times users make use of them in a time period.
- [Sessions](https://docs.doofinder.com/api-reference/usage-&-sessions/sessions.md): Counts number of total unique search sessions in a time period group by day.
- [Sessions geolocation](https://docs.doofinder.com/api-reference/usage-&-sessions/sessions-geolocation.md): Gets all sessions geolocation for a time period.
- [Inits with users](https://docs.doofinder.com/api-reference/usage-&-sessions/inits-with-users.md): Counts numbers of different users in sessions for a time period.
- [Search engine usage](https://docs.doofinder.com/api-reference/usage-&-sessions/search-engine-usage.md): Gets how many visits a Search engine receive and from that users how many inits & searches in a time period
- [Usage](https://docs.doofinder.com/api-reference/usage-&-sessions/usage.md): Gets the usage of a list of search engines during a period.
- [Results searches](https://docs.doofinder.com/api-reference/searches/results-searches.md): Gets the most commonly `metric` obtained in searches during a time period. Where `metric` can be brand or categories.
- [Searches](https://docs.doofinder.com/api-reference/searches/searches.md): Counts number of searches in a time period grouped by day.
- [Searches locations](https://docs.doofinder.com/api-reference/searches/searches-locations.md): Gets all searches locations for a time period.
- [Popular searches](https://docs.doofinder.com/api-reference/searches/popular-searches.md): Gets the most popular searches (the ones containing most clicked items) in a time period.
- [Top searches](https://docs.doofinder.com/api-reference/searches/top-searches.md): Gets a list of the most common searches in a time period.
- [Recommendations API](https://docs.doofinder.com/recommendations-api/overview.md): Deliver personalized product recommendations using Doofinder's recommendation engine.
- [Get widget recommendations](https://docs.doofinder.com/api-reference/recommendations/get-widget-recommendations.md): Retrieves personalized recommendations for a specific widget
- [Register a widget click](https://docs.doofinder.com/api-reference/recommendations/register-a-widget-click.md): Registers a click event on a product recommended by a specific widget
- [Register an add-to-cart event](https://docs.doofinder.com/api-reference/recommendations/register-an-add-to-cart-event.md): Registers that a product recommended by a specific widget was added to the cart
- [Get item details](https://docs.doofinder.com/api-reference/recommendations/get-item-details.md): Retrieves details for a single product identified by its dfid, in the context of a specific widget's search engine
- [Category Merchandising API](https://docs.doofinder.com/category-merchandising/overview.md): Retrieve search results for category listing pages, with URL-pattern-driven filtering and merchandising rules applied.
- [Get category page results](https://docs.doofinder.com/api-reference/category-merchandising/get-category-page-results.md): Returns search results for the category page whose URL pattern matches the provided `url`.

## OpenAPI Specs

- [category-merchandising-v1](/openapi/category-merchandising-v1.yaml)
- [management-v2](/openapi/management-v2.yaml)
- [recommendations-v1](/openapi/recommendations-v1.yaml)
- [search-v6](/openapi/search-v6.yaml)
- [stats-v2](/openapi/stats-v2.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.