post

/api/analytics/v1/searches/performance

Returns the performance of a search term such as the total items ordered, refinements ratio, click ratio, and conversion score.

Authorization

apiKey - Authorization

Request Body

2 Examples
Schema
object
start
string

The start of the time interval to analyze in UTC (inclusive >=)

required
end
string

The end of the time interval to analyze in UTC (exclusive <)

required
customerArea
string

The customer area to target

required
deviceType
string

The device type to filter such as desktop, phone, or tablet. Accepts a comma-separated list. Example: desktop,phone,tablet

searchTerm
string

The search term to target

matchType
string

The matching strategy for the search term. Possible Values: exact,contains,prefix, or suffix.

1 validation
size
string

The size of the results to return

1 validation
sortTarget
string

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
1 validation
sortOrder
string

The order in which to sort results by, must be either asc (ascending) or desc (descending)

1 validation
minSearches
integer

The minimum number of searches to filter on.

1 validation

Responses

1 Example
Schema
object
status
object
result
array[object]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
customerid
Authorization