@yext/search-core/dist/commonjs/src/models/core/Visitor.d.ts

Typescript Networking Library for the Yext Search API

/**
 * Information used to associate requests with a particular user.
 *
 * @remarks
 * Visitor information is included with every request with the exception of question submission requests.
 *
 * @public
 */
export interface Visitor {
    /** The ID associated with the user. Max of 64 characters. */
    id: string;
    /** The type of visitor. Max of 16 characters.
     *
     * @example 'YEXT_USER' for Yext Auth
     */
    idMethod?: string;
}