Skip to content

analytics.viewedSearchResults

analytics.viewedSearchResults is an event on the Event Bus that occurs after a user has viewed search results. This event only dispatches when analytics is enabled in the shop.

Event body

none

Example

In this example we listen to analytics.viewedSearchResults event and perform an action whenever it's emitted.

useStorefront(async (storefront) => {
    storefront.eventBus.on('analytics.viewedSearchResults', () => {
        console.log('A user has viewed search results')
    });
});

Example

In this example we use a Message Storage API to retrieve an array of past analytics.viewedSearchResults events.

useStorefront((storefront) => {
    const messageStorageApi = storefront.getApiSync('messageStorageSystemApi');

    const pastViewedSearchResultsEvents = messageStorageApi.getChannelMessages('analytics.viewedSearchResults');

    if (pastViewedSearchResultsEvents.length > 0) {
        pastViewedSearchResultsEvents.forEach(({ body: eventBody }) => {
            console.log('perform action on every past event');
        });
    }
});

JS API reference