Type alias SearchEvent

SearchEvent: Client & InteractionEvent & Source & {
    searchQuery?: string;
    originalSearchQuery?: string;
    categoryId?: string;
    searchFacetList?: string;
    searchType?: string;
    numberOfResultsRequested?: number;
    resultPageOffset?: number;
    sortType?: string;
    resultsReturnedQuantity?: number;
    searchEngineName?: string;
    webStoreId?: string;
    searchResultId?: string;
}

A product search event. This event is used for both direct queries (interactionName=search) and for finding all of the products within a category (interactionName=category-search).

Type declaration

  • Optional searchQuery?: string

    Search query which was executed. Could be either entered by user or a selected search suggestion.

  • Optional originalSearchQuery?: string

    Search query which that was entered by the user, before selecting a search suggestion.

  • Optional categoryId?: string

    If the search is for a product category search (interactionName=category-search), the category identifier.

  • Optional searchFacetList?: string

    Any facets used in the search, comma separated.

  • Optional searchType?: string

    Any number of search modifiers which are selected by the user, comma delimited. For example, regular, sku, typeTolerant.

  • Optional numberOfResultsRequested?: number

    The maximum number of search results requested.

  • Optional resultPageOffset?: number

    The page number of the search from which this search was executed. Note- A new Search should not be sent when clicking through pages of an original search. This field would only be populated if there is a change to the search criteria that results in a new search.

  • Optional sortType?: string

    The type of sort that is requested by the user.

  • Optional resultsReturnedQuantity?: number

    The total number of results returned by the search, independent of pagination. If that total number is not known, minimally a 0 or non-zero value is expected to indicate whether the search yielded any results.

  • Optional searchEngineName?: string

    The name of the search engine used for the search.

  • Optional webStoreId?: string

    The web store associated with the event.

  • Optional searchResultId?: string

    Identifier used to associate search to search results across events.

Settings

Member Visibility

Theme