dc-management-sdk-js/build/module/lib/model/SearchIndexTopSearches.d.ts

Amplience Dynamic Content Management SDK

import { HalResource } from '../hal/models/HalResource';
import { EmbeddedCollection } from './EmbeddedCollection';
export declare enum SearchesOrderBy {
    SEARCH_COUNT = "searchCount",
    CLICK_THROUGH_RATE = "clickThroughRate",
    CONVERSION_RATE = "conversionRate",
    AVERAGE_CLICK_POSITION = "averageClickPosition"
}
/**
 * Class representing search analytics for an Algolia Search Index
 */
export declare class SearchIndexTopSearches extends HalResource {
    /**
     * The queried search term
     */
    search: string;
    /**
     * The number of impressions
     */
    count: number;
    /**
     * Number of returned results
     */
    nbHits: number;
    /**
     * Click through rate
     */
    clickThroughRate?: number | null;
    /**
     * Conversion rate
     */
    conversionRate?: number | null;
    /**
     * Average position in the results set when clicked
     */
    averageClickPosition?: number | null;
    /**
     * Number of searches used for click analytics
     */
    trackedSearchCount?: number;
    /**
     * Number of clicks
     */
    clickCount?: number;
    /**
     * Number of conversions
     */
    conversionCount?: number;
}
/**
 * @hidden
 */
export declare class SearchIndexTopSearchesCollection extends EmbeddedCollection<SearchIndexTopSearches> {
    constructor(data?: any);
}