Skip to main content

Search Queries

This document explains the difference between a user search query and a Search API query in AddSearch. Understanding this distinction helps you track your search quota usage and analyze search trends accurately.

User Search Query​

A user search query is the complete search phrase a user enters in the search field. These queries are logged in the Analytics section of the AddSearch dashboard.

  • When a user types in a search-as-you-type interface, intermediate results update dynamically.
  • All intermediate results plus the final search result collectively count as one user search query.
  • If the user enters another distinct search phrase—even within the same session—it counts as an additional user search query.

You can view data about your search quota usage for your index on the AddSearch dashboard.

Search API Query​

A Search API query is any request received and processed by AddSearch's APIs. This includes:

Each API query corresponds to an event and includes:

  • Each suggestion or result the API returns.
  • Additional results loaded via pagination or "show more" actions.
  • New queries triggered by using facets or filters in your search configuration.

Because of this, one user search query often triggers multiple Search API queries.

Recommendations for Search-as-You-Type​

If your search UI implements search-as-you-type functionality:

  • Use throttling with at least a 200 ms delay between API requests to avoid excessive queries.
  • In the AddSearch search designer tool, adjust the "API throttle time" setting to control this.

Note that on a traditional search results page, a query is sent only once per search phrase. If you enable search-as-you-type on such a page, it will generate more API requests accordingly.

By distinguishing between user search queries and Search API queries, you can better interpret your search analytics and manage your search quota efficiently.