CaseAssistAnalyticsActions (Deprecated)

This is for:

Developer
Warning

Headless v1 has been deprecated. We recommend using the latest version of the Coveo Headless library.

The Case Assist analytics action creators.

See Dispatch Actions.

Loader Function

loadCaseAssistAnalyticsActions

Loads the case assist analytics actions.

Parameters

  • engine: CaseAssistEngine

    The case assist engine.

Returns CaseAssistAnalyticsActionCreators: The Case Assist analytics action creators.

CaseAssistAnalyticsActionCreators

logAbandonCase

Creates a Case Assist event for when the user leaves.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logCaseNextStage

Creates a Case Assist event for when the user moves to the next stage.

Parameters

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logCaseStart

Creates a Case Assist event for when the user enters the interface.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logClassificationClick

Creates a Case Assist event for when the user selects a classification suggestion.

Parameters

  • classificationId: string

    The unique identifier of the target classification.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logCreateCase

Creates a Case Assist event for when the user creates a case.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logDocumentSuggestionClick

Creates a Case Assist event for when the user selects a document suggestion.

Parameters

  • suggestionId: string

    The unique identifier of the target document.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logDocumentSuggestionRating

Creates a Case Assist event for when the user rates a document suggestion.

Parameters

  • suggestionId: string

    The unique identifier of the target document.

  • rating: number

    The rating.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logQuickviewDocumentSuggestionClick

Creates a Case Assist event for when the user previews a document suggestion from the quickview.

Parameters

  • suggestionId: string

    The unique identifier of the target document.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logSolveCase

Creates a Case Assist event for when the case is solved.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

logUpdateCaseField

Creates a Case Assist event for when the user updates a field.

Parameters

  • fieldName: string

    The target field name.

Returns AsyncThunkAction<void, void, AsyncThunkAnalyticsOptions<StateNeededByCaseAssistAnalytics>>: A dispatchable action.

NextStageOptions

Properties

  • stageName?: string