post

/api/analytics/v1/searches/trending

Returns the search terms that were trending over the past week/month as well as the volume in the past 7 days, 30 days, 30 days (before the past 7) and 90 days (before the past 30).

Authorization

apiKey - Authorization

Request Body

2 Examples
Schema
object
date
string

The date to analyze.

1 validation
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, one of exact, contains, prefix (starts with), and suffix (ends with)

1 validation
size
integer

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:

  • trend7
  • trend30
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 occurrences to filter by (based on occurrence in the week prior to date)

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