Get search queries that are over-represented in the window specified with comparison to a larger background set. The background set is 8-times the window size.

Authorization

apiKey - Authorization

Request Body

1 Example

Schema

object

window

string

Defines the previous time period, ending now, that the response will include events from. Defaults to different values depending on the endpoint, see the API definition for details.

The windows are day, week, and `month, representing a rolling 24 hour, 7 day and 30 day window respectively.

size

integer

Number of results to return.

1 validation

matchPartial

object

matchPartial will match a subset of a query, after splitting by spaces.

For example, matchPartial: { search: { query: 'coffee' }} will match: black coffee, coffee, coffee grinder.

In all cases the or and not filter objects are identical to the `and filter shown.

matchPrefix

object

Object defining the prefix matches to filter the events by, by matching against the beginning of the target field.

For example, matchPrefix: { search: { query: 'coff' }} will match: coffee, coffee grinder.

This filter can only be applied to the Recommendation Search APIs. matchPrefix currently only applies on queries that return search strings, and only filters on those search strings.

matchExact

object

This JSON object that defines the exact full length String or exact value match against target field(s).

Supports and, or, and not options wherever there are arrays in the original event object.

Responses

1 Example

Schema

object

serverTimestamp

string

result

array[object]

status

object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

$$.env

2 variables not set

customerid

Authorization