useSearchEvents

The useSearchEvents hook is used for tracking user interactions with search results. This is essential for analytics and for training machine learning models for personalized search and recommendations.

import { useSearchEvents } from '@archibald/search';

const { trackSearchClick, trackSearchImpression } = useSearchEvents();

Return value

• Type: SearchEventsTracking

The return object provides a set of methods for tracking search-related events:

Method	Description
trackSearchClick	Tracks when a user clicks on a search result.
trackSearchImpression	Tracks when search results are displayed to the user.

Example

import { useSearchEvents } from '@archibald/search';

function SearchResultItem({ product, query }) {
    const { trackSearchClick } = useSearchEvents();

    const handleClick = () => {
        trackSearchClick({
            productCode: product.code,
            searchTerm: query,
            position: product.position
        });
    };

    return (
        <div onClick={handleClick}>
            <h3>{product.name}</h3>
        </div>
    );
}