/api/analytics/v1/searches
Returns all details related to the search term such as the performance, navigations, and retrieved products.
The start of the time interval to analyze in UTC (inclusive >=)
The end of the time interval to analyze in UTC (exclusive <)
The customer area to target
The device type to filter such as desktop, phone, or tablet. Accepts a comma-separated list. Example: desktop,phone,tablet
The search term to target
The matching strategy for the search term. Possible Values: exact,contains,prefix, or suffix.
The size of the results to return
The output field to sort the results by, must be one of performance or base count fields. For the performance fields, prepend by "performance."Must be one of the following:
- performance.uniqueSearches
- performance.totalSearches
- performance.uniqueViewProductRatio
- performance.uniqueSearchViews
- performance.totalViewProductRatio
- performance.totalViewProducts
- performance.uniqueAddToCartRatio
- performance.uniqueSearchAdds
- performance.totalAddToCartRatio
- performance.totalAddToCarts
- performance.uniqueOrderRatio
- performance.uniqueSearchOrders
- performance.totalOrderRatio
- performance.totalOrders
- performance.totalOrderQuantity
The order in which to sort results by, must be either asc (ascending) or desc (descending)
The minimum number of searches to filter on.