Interface AnalyticsStrategy

The AnalyticsStrategy determines how search analytics are stored and retrieved for analysis.

interface AnalyticsStrategy {
    defineEntities?(): Type<any>[];
    getChartData(input: SearchAnalyticsChartInput): Promise<SearchAnalyticsChartData>;
    getEvents(input: SearchAnalyticsEventInput): Promise<SearchAnalyticsEventData>;
    getQueryData(input: SearchAnalyticsQueryInput): Promise<SearchAnalyticsQueryData>;
    logEvent(event: SearchEvent): Promise<void>;
    logQuery(logData: SearchQueryLogData): Promise<void>;
}

Hierarchy

  • InjectableStrategy
    • AnalyticsStrategy

Implemented by

Methods

defineEntities? getChartData getEvents getQueryData logEvent logQuery

Methods

OptionaldefineEntities

  • defineEntities(): Type<any>[]

  • Optionally allows the definition of database entities in the main server database.

    Returns Type<any>[]

getChartData

  • getChartData(input): Promise<SearchAnalyticsChartData>

  • Retrieves the chart data for the given input.

    Parameters

    • input: SearchAnalyticsChartInput

    Returns Promise<SearchAnalyticsChartData>

getEvents

  • getEvents(input): Promise<SearchAnalyticsEventData>

  • Retrieves the event data for the given input.

    Parameters

    • input: SearchAnalyticsEventInput

    Returns Promise<SearchAnalyticsEventData>

getQueryData

  • getQueryData(input): Promise<SearchAnalyticsQueryData>

  • Retrieves the query data for the given input.

    Parameters

    • input: SearchAnalyticsQueryInput

    Returns Promise<SearchAnalyticsQueryData>

logEvent

  • logEvent(event): Promise<void>

  • Logs a search event: either a list view or a result click.

    Parameters

    Returns Promise<void>

logQuery

  • logQuery(logData): Promise<void>

  • Logs a search query.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods