THIS IS ARCHIVED DOCUMENTATION

InsightAnalyticsActions (Deprecated)

InsightAnalyticsActions (Deprecated)

In this article

Loader Function
InsightAnalyticsActionCreators
Related Types

In this article

Loader Function
InsightAnalyticsActionCreators
Related Types

The insight analytics action creators.

See Dispatch Actions.

Loader Function

`loadInsightAnalyticsActions`

Returns possible insight analytics action creators.

Parameters

engine: InsightEngine

The insight engine.

Returns InsightAnalyticsActionCreators: The insight analytics action creators.

InsightAnalyticsActionCreators

`logCategoryFacetBreadcrumb`

The event to log when a category facet breadcrumb is deselected.

Parameters

payload: LogCategoryFacetBreadcrumbActionCreatorPayload

The action creator payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logClearBreadcrumbs`

The event to log when clearing breadcrumbs.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logDateFacetBreadcrumb`

The event to log when a date facet breadcrumb is deselected.

Parameters

payload: LogDateFacetBreadcrumbActionCreatorPayload

The action creator payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logFacetBreadcrumb`

The event to log when a facet breadcrumb is deselected.

Parameters

payload: LogFacetBreadcrumbActionCreatorPayload

The action creator payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logFacetClearAll`

The event to log when all selected values in a facet are deselected.

Parameters

facetId: string

The facet id.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logFacetDeselect`

The event to log when a selected facet value is deselected.

Parameters

payload: LogFacetDeselectActionCreatorPayload

The action creator payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logFacetSelect`

The event to log when an idle facet value is selected.

Parameters

payload: LogFacetSelectActionCreatorPayload

The action creator payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logFacetShowLess`

The event to log when shrinking a facet to show fewer values.

Parameters

facetId: string

The facet id.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logFacetShowMore`

The event to log when expanding a facet to show more values.

Parameters

facetId: string

The facet id.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logFacetUpdateSort`

The event to log when the facet sort criterion is changed.

Parameters

payload: LogFacetUpdateSortActionCreatorPayload

The action creator payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logInterfaceChange`

The event to log when a tab is selected.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logInterfaceLoad`

The event to log when a insight interface loads for the first time.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logNumericFacetBreadcrumb`

The event to log when a numeric facet breadcrumb is deselected.

Parameters

payload: LogNumericFacetBreadcrumbActionCreatorPayload

The action creator payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logPageNext`

The event to log when navigating to the next page of results.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logPageNumber`

The event to log when selecting a page in the pager.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logPagePrevious`

The event to log when navigating to the previous page of results.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logResultsSort`

The event to log when the results sort criterion is changed.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`logStaticFilterDeselect`

The event to log when a static filter value is deselected.

Parameters

payload: LogStaticFilterToggleValueActionCreatorPayload

The action creation payload.

Returns AsyncThunkAction<{ analyticsType: AnalyticsType.Search; }, void, AsyncThunkInsightAnalyticsOptions<StateNeededByInsightAnalyticsProvider>>: A dispatchable action.

`DateFacetValue`

Properties

end: string

The ending value for the date range, formatted as YYYY/MM/DD@HH:mm:ss or the Relative date format "period-amount-unit"
endInclusive: boolean

Whether or not the end value is included in the range.
numberOfResults: number

The number of results that have the facet value.
start: string

The starting value for the date range, formatted as YYYY/MM/DD@HH:mm:ss or the Relative date format "period-amount-unit"
state: 'idle' | 'selected'

The state of the facet value, indicating whether it is filtering results (selected) or not (idle).

`LogCategoryFacetBreadcrumbActionCreatorPayload`

Properties

categoryFacetId: string

The category facet id.
categoryFacetPath: string[]

The category facet selected path.

`LogDateFacetBreadcrumbActionCreatorPayload`

Properties

facetId: string

The facet id of the date facet corresponding to the breadcrumb.
selection: DateFacetValue

The date facet value deselected using the breadcrumb.

`LogFacetBreadcrumbActionCreatorPayload`

Properties

facetId: string

The facet id associated with the breadcrumb.
facetValue: string

The facet value displayed in the breadcrumb.

`LogFacetDeselectActionCreatorPayload`

Properties

facetId: string

The facet id.
facetValue: string

The facet value that was deselected.

`LogFacetSelectActionCreatorPayload`

Properties

facetId: string

The facet id.
facetValue: string

The facet value that was selected.

`LogFacetUpdateSortActionCreatorPayload`

Properties

facetId: string

The facet id.
sortCriterion: FacetSortCriterion | RangeFacetSortCriterion

The updated sort criterion.

`LogNumericFacetBreadcrumbActionCreatorPayload`

Properties

facetId: string

The facet id of the numeric facet corresponding to the breadcrumb.
selection: NumericFacetValue

The numeric facet value deselected using the breadcrumb.

`LogStaticFilterToggleValueActionCreatorPayload`

Properties

staticFilterId: string

The static filter id.
staticFilterValue: StaticFilterValueMetadata

The static filter value.

`NumericFacetValue`

Properties

end: number

The ending value for the numeric range.
endInclusive: boolean

Whether or not the end value is included in the range.
numberOfResults: number

The number of results that have the facet value.
start: number

The starting value for the numeric range.
state: 'idle' | 'selected'

The state of the facet value, indicating whether it is filtering results (selected) or not (idle).

`StaticFilterValueMetadata`

Properties

caption: string

The caption displayed to the user.
expression: string

The query expression.