InsightAnalyticsActions
InsightAnalyticsActions
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
logCaseSendEmail
The event to log when the Case Send As Email result action is clicked.
Parameters
-
result:
Result
The result.
Returns InsightAction
: A dispatchable action.
logCategoryFacetBreadcrumb
The event to log when a category facet breadcrumb is deselected.
Parameters
-
payload:
LogCategoryFacetBreadcrumbActionCreatorPayload
The action creator payload.
Returns InsightAction
: A dispatchable action.
logClearBreadcrumbs
The event to log when clearing breadcrumbs.
Returns InsightAction
: A dispatchable action.
logCopyToClipboard
The event to log when the Copy To Clipboard result action is clicked.
Parameters
-
result:
Result
The result.
Returns InsightAction
: A dispatchable action.
logDateFacetBreadcrumb
The event to log when a date facet breadcrumb is deselected.
Parameters
-
payload:
LogDateFacetBreadcrumbActionCreatorPayload
The action creator payload.
Returns InsightAction
: A dispatchable action.
logFacetBreadcrumb
The event to log when a facet breadcrumb is deselected.
Parameters
-
payload:
LogFacetBreadcrumbActionCreatorPayload
The action creator payload.
Returns InsightAction
: A dispatchable action.
logFacetClearAll
The event to log when all selected values in a facet are deselected.
Parameters
-
facetId:
string
The facet id.
Returns InsightAction
: A dispatchable action.
logFacetDeselect
The event to log when a selected facet value is deselected.
Parameters
-
payload:
LogFacetDeselectActionCreatorPayload
The action creator payload.
Returns InsightAction
: A dispatchable action.
logFacetSelect
The event to log when an idle facet value is selected.
Parameters
-
payload:
LogFacetSelectActionCreatorPayload
The action creator payload.
Returns InsightAction
: A dispatchable action.
logFacetShowLess
The event to log when shrinking a facet to show fewer values.
Parameters
-
facetId:
string
The facet id.
Returns InsightAction
: A dispatchable action.
logFacetShowMore
The event to log when expanding a facet to show more values.
Parameters
-
facetId:
string
The facet id.
Returns InsightAction
: A dispatchable action.
logFacetUpdateSort
The event to log when the facet sort criterion is changed.
Parameters
-
payload:
LogFacetUpdateSortActionCreatorPayload
The action creator payload.
Returns InsightAction
: A dispatchable action.
logFeedItemTextPost
The event to log when the Feed Item Text Post result action is clicked.
Parameters
-
result:
Result
The result.
Returns InsightAction
: A dispatchable action.
logInterfaceChange
The event to log when a tab is selected.
Returns InsightAction
: A dispatchable action.
logInterfaceLoad
The event to log when a insight interface loads for the first time.
Returns InsightAction
: A dispatchable action.
logNumericFacetBreadcrumb
The event to log when a numeric facet breadcrumb is deselected.
Parameters
-
payload:
LogNumericFacetBreadcrumbActionCreatorPayload
The action creator payload.
Returns InsightAction
: A dispatchable action.
logPageNext
The event to log when navigating to the next page of results.
Returns InsightAction
: A dispatchable action.
logPageNumber
The event to log when selecting a page in the pager.
Returns InsightAction
: A dispatchable action.
logPagePrevious
The event to log when navigating to the previous page of results.
Returns InsightAction
: A dispatchable action.
logResultsSort
The event to log when the results sort criterion is changed.
Returns InsightAction
: A dispatchable action.
logStaticFilterDeselect
The event to log when a static filter value is deselected.
Parameters
-
payload:
LogStaticFilterToggleValueActionCreatorPayload
The action creation payload.
Returns InsightAction
: A dispatchable action.
Related Types
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' | 'excluded'
The state of the facet value, indicating whether it is filtering results (
selected
) or not (idle
).
HighlightKeyword
Properties
-
length:
number
The length of the offset.
-
offset:
number
The 0 based offset inside the string where the highlight should start.
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' | 'excluded'
The state of the facet value, indicating whether it is filtering results (
selected
) or not (idle
).
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.
-
isUserActionView:
boolean
Whether the result item has been previously viewed by one of the users specified in the
canSeeUserProfileOf
section of the search token generated to perform the search request. -
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.
StaticFilterValueMetadata
Properties
-
caption:
string
The caption displayed to the user.
-
expression:
string
The query expression.