Interface InsightAnalyticsActionCreators

The insight analytics action creators.

interface InsightAnalyticsActionCreators {
    logCaseSendEmail(result: Result): InsightAction;
    logCategoryFacetBreadcrumb(
        payload: LogCategoryFacetBreadcrumbActionCreatorPayload,
    ): InsightAction;
    logClearBreadcrumbs(): InsightAction;
    logCopyToClipboard(result: Result): InsightAction;
    logCreateArticle(payload: CreateArticleMetadata): InsightAction;
    logDateFacetBreadcrumb(
        payload: LogDateFacetBreadcrumbActionCreatorPayload,
    ): InsightAction;
    logFacetBreadcrumb(
        payload: LogFacetBreadcrumbActionCreatorPayload,
    ): InsightAction;
    logFacetClearAll(facetId: string): InsightAction;
    logFacetDeselect(
        payload: LogFacetDeselectActionCreatorPayload,
    ): InsightAction;
    logFacetSelect(payload: LogFacetSelectActionCreatorPayload): InsightAction;
    logFacetShowLess(facetId: string): InsightAction;
    logFacetShowMore(facetId: string): InsightAction;
    logFacetUpdateSort(
        payload: LogFacetUpdateSortActionCreatorPayload,
    ): InsightAction;
    logFeedItemTextPost(result: Result): InsightAction;
    logInterfaceChange(): InsightAction;
    logInterfaceLoad(): InsightAction;
    logNumericFacetBreadcrumb(
        payload: LogNumericFacetBreadcrumbActionCreatorPayload,
    ): InsightAction;
    logOpenUserActions(): InsightAction;
    logPageNext(): InsightAction;
    logPageNumber(): InsightAction;
    logPagePrevious(): InsightAction;
    logResultsSort(): InsightAction;
    logStaticFilterDeselect(
        payload: LogStaticFilterToggleValueActionCreatorPayload,
    ): InsightAction;
}

Methods

logCaseSendEmail

logCaseSendEmail(result: Result): InsightAction
The event to log when the Case Send As Email result action is clicked.
Parameters
- result: Result
  The result.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:251

logCategoryFacetBreadcrumb

logCategoryFacetBreadcrumb(
payload: LogCategoryFacetBreadcrumbActionCreatorPayload,
): InsightAction
The event to log when a category facet breadcrumb is deselected.
Parameters
- payload: LogCategoryFacetBreadcrumbActionCreatorPayload
  The action creator payload.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:113

logClearBreadcrumbs

logClearBreadcrumbs(): InsightAction
The event to log when clearing breadcrumbs.

Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:83

logCopyToClipboard

logCopyToClipboard(result: Result): InsightAction
The event to log when the Copy To Clipboard result action is clicked.
Parameters
- result: Result
  The result.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:243

logCreateArticle

logCreateArticle(payload: CreateArticleMetadata): InsightAction
The event to log when the create article button is clicked.
Parameters
- payload: CreateArticleMetadata
  The metadata tied to the create article event.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:105

logDateFacetBreadcrumb

logDateFacetBreadcrumb(
payload: LogDateFacetBreadcrumbActionCreatorPayload,
): InsightAction
The event to log when a date facet breadcrumb is deselected.
Parameters
- payload: LogDateFacetBreadcrumbActionCreatorPayload
  The action creator payload.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:185

logFacetBreadcrumb

logFacetBreadcrumb(
payload: LogFacetBreadcrumbActionCreatorPayload,
): InsightAction
The event to log when a facet breadcrumb is deselected.
Parameters
- payload: LogFacetBreadcrumbActionCreatorPayload
  The action creator payload.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:123

logFacetClearAll

logFacetClearAll(facetId: string): InsightAction
The event to log when all selected values in a facet are deselected.
Parameters
- facetId: string
  The facet id.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:133

logFacetDeselect

logFacetDeselect(payload: LogFacetDeselectActionCreatorPayload): InsightAction
The event to log when a selected facet value is deselected.
Parameters
- payload: LogFacetDeselectActionCreatorPayload
  The action creator payload.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:141

logFacetSelect

logFacetSelect(payload: LogFacetSelectActionCreatorPayload): InsightAction
The event to log when an idle facet value is selected.
Parameters
- payload: LogFacetSelectActionCreatorPayload
  The action creator payload.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:151

logFacetShowLess

logFacetShowLess(facetId: string): InsightAction
The event to log when shrinking a facet to show fewer values.
Parameters
- facetId: string
  The facet id.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:159

logFacetShowMore

logFacetShowMore(facetId: string): InsightAction
The event to log when expanding a facet to show more values.
Parameters
- facetId: string
  The facet id.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:167

logFacetUpdateSort

logFacetUpdateSort(
payload: LogFacetUpdateSortActionCreatorPayload,
): InsightAction
The event to log when the facet sort criterion is changed.
Parameters
- payload: LogFacetUpdateSortActionCreatorPayload
  The action creator payload.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:175

logFeedItemTextPost

logFeedItemTextPost(result: Result): InsightAction
The event to log when the Feed Item Text Post result action is clicked.
Parameters
- result: Result
  The result.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:259

logInterfaceChange

logInterfaceChange(): InsightAction
The event to log when a tab is selected.

Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:97

logInterfaceLoad

logInterfaceLoad(): InsightAction
The event to log when a insight interface loads for the first time.

Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:90

logNumericFacetBreadcrumb

logNumericFacetBreadcrumb(
payload: LogNumericFacetBreadcrumbActionCreatorPayload,
): InsightAction
The event to log when a numeric facet breadcrumb is deselected.
Parameters
- payload: LogNumericFacetBreadcrumbActionCreatorPayload
  The action creator payload.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:195

logOpenUserActions

logOpenUserActions(): InsightAction
The event to log when opening the user actions panel.

Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:266

logPageNext

logPageNext(): InsightAction
The event to log when navigating to the next page of results.

Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:204

logPageNumber

logPageNumber(): InsightAction
The event to log when selecting a page in the pager.

Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:211

logPagePrevious

logPagePrevious(): InsightAction
The event to log when navigating to the previous page of results.

Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:218

logResultsSort

logResultsSort(): InsightAction
The event to log when the results sort criterion is changed.

Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:225

logStaticFilterDeselect

logStaticFilterDeselect(
payload: LogStaticFilterToggleValueActionCreatorPayload,
): InsightAction
The event to log when a static filter value is deselected.
Parameters
- payload: LogStaticFilterToggleValueActionCreatorPayload
  The action creation payload.
Returns InsightAction
A dispatchable action.
- Defined in packages/headless/src/features/analytics/insight-analytics-actions-loader.ts:233

Interface InsightAnalyticsActionCreators

Index

Methods

Methods

logCaseSendEmail

Parameters

Returns InsightAction

logCategoryFacetBreadcrumb

Parameters

Returns InsightAction

logClearBreadcrumbs

Returns InsightAction

logCopyToClipboard

Parameters

Returns InsightAction

logCreateArticle

Parameters

Returns InsightAction

logDateFacetBreadcrumb

Parameters

Returns InsightAction

logFacetBreadcrumb

Parameters

Returns InsightAction

logFacetClearAll

Parameters

Returns InsightAction

logFacetDeselect

Parameters

Returns InsightAction

logFacetSelect

Parameters

Returns InsightAction

logFacetShowLess

Parameters

Returns InsightAction

logFacetShowMore

Parameters

Returns InsightAction

logFacetUpdateSort

Parameters

Returns InsightAction

logFeedItemTextPost

Parameters

Returns InsightAction

logInterfaceChange

Returns InsightAction

logInterfaceLoad

Returns InsightAction

logNumericFacetBreadcrumb

Parameters

Returns InsightAction

logOpenUserActions

Returns InsightAction

logPageNext

Returns InsightAction

logPageNumber

Returns InsightAction

logPagePrevious

Returns InsightAction

logResultsSort

Returns InsightAction

logStaticFilterDeselect

Parameters

Returns InsightAction

Settings

On This Page