GenericAnalyticsActions

This is for:

Developer

The generic analytics action creators.

See Dispatch Actions.

Loader Function

loadGenericAnalyticsActions

Returns possible generic analytics action creators.

Parameters

  • engine: SearchEngine

    The headless engine.

Returns GenericAnalyticsActionCreators: The generic analytics action creators.

GenericAnalyticsActionCreators

logClickEvent

Creates a click analytics event.

Parameters

Returns ClickAction: A dispatchable action.

logCustomEvent

Creates a custom analytics event.

Parameters

Returns CustomAction: A dispatchable action.

logSearchEvent

Creates a search analytics event.

Parameters

Returns SearchAction: A dispatchable action.

HighlightKeyword

Properties

  • length: number

    The length of the offset.

  • offset: number

    The 0 based offset inside the string where the highlight should start.

LogClickEventActionCreatorPayload

Properties

  • evt: string

    The identifier of the click action (for example, documentOpen).

  • result: Result

    The result associated with the click event.

  • meta?: Record<string, unknown>

    The event metadata.

LogCustomEventActionCreatorPayload

Properties

  • evt: string

    The event cause identifier of the custom action

  • type: string

    The event type identifier of the custom action

  • meta?: Record<string, unknown>

    The event metadata.

LogSearchEventActionCreatorPayload

Properties

  • evt: string

    The identifier of the search action (for example, interfaceLoad).

  • meta?: Record<string, unknown>

    The event metadata.

Raw

Properties

  • [key: string]: unknown

    Custom keys that depend on the documents in the index.

Result

Properties

  • absentTerms: string[]

    The basic query expression terms which this query result item does not match. Note: This property is populated by terms from the query pipeline-processed q value (not from the original q value).

  • clickUri: string

    The hyperlinkable item URI. Notes: Use the clickUri value when you want to create hyperlinks to the item, rather than the uri or printableUri value.

  • excerpt: string

    The contextual excerpt generated for the item (see the excerptLength query parameter).

  • excerptHighlights: HighlightKeyword[]

    The length and offset of each word to highlight in the item excerpt string.

  • firstSentences: string

    The first sentences retrieved from the item (see the retrieveFirstSentences query parameter).

  • firstSentencesHighlights: HighlightKeyword[]

    The length and offset of each word to highlight in the item firstSentences string.

  • flags: string

    The flags that are set on the item by the index. Distinct values are separated by semicolons.

  • hasHtmlVersion: boolean

    Whether the index contains an HTML version of this item.

  • isRecommendation: boolean

    Whether the item score was boosted as a Coveo ML recommendation.

  • isTopResult: boolean

    Whether the item score was boosted by a featured result rule in the query pipeline.

  • percentScore: number

    The item ranking score expressed as a percentage (see the sortCriteria and rankingFunctions query parameters).

  • printableUri: string

    The human readable item URI. Note: Avoid using the printableUri value to create hyperlinks to the item. Use the clickUri value instead.

  • printableUriHighlights: HighlightKeyword[]

    The length and offset of each word to highlight in the item printableUri string.

  • rankingInfo: string | null

    The raw debug information generated by the index to detail how the item was ranked. This property is null unless the debug query parameter is set to true.

  • raw: Raw

    The values of the fields which were retrieved for this item (see the fieldsToInclude and fieldsToExclude query parameters).

  • score: number

    The total ranking score computed for the item (see the sortCriteria and rankingFunctions query parameters).

  • summary: null

    The item summary (see the summaryLength query parameter).

  • summaryHighlights: HighlightKeyword[]

    The length and offset of each word to highlight in the item summary string.

  • title: string

    Contains the title of the item.

  • titleHighlights: HighlightKeyword[]

    The length and offset of each word to highlight in the item title string.

  • uniqueId: string

    The unique item identifier. You should consider the uniqueId value as an opaque string.

  • uri: string

    The item URI. Notes: Avoid using the uri value to create hyperlinks to the item. Use the clickUri value instead.

  • rankingModifier?: string

    If applicable, represents the type of ranking modification that was applied to this result.