elevio-kb-events

@elevio/kb-events / Exports / events

Namespace: events

Table of contents

Type aliases

• Events
• SendOptions

Functions

• alterEvent
• articleFeedbackReaction
• pageViewArticle
• pageViewCategory
• pageViewIndex
• searchClick
• searchQuery

Type aliases

Events

Ƭ Events: EventsUnion<typeof pageViewIndex | typeof pageViewArticle | typeof pageViewCategory | typeof searchQuery | typeof searchClick | typeof articleFeedbackReaction>

Defined in: events.ts:123

---

SendOptions

Ƭ SendOptions: object

Options for altering the events before they are sent. forceTimestamp will force the timestamp to allow backfilling of events. customAttributes allows you to pass custom event data, for your own debugging purposes.

Type declaration:

Name	Type
customAttributes?	CustomAttributes
forceTimestamp?	number

Defined in: events.ts:137

Functions

alterEvent

▸ alterEvent(event: Events, opts: SendOptions): Events

Alters a given event with optional parameters before being sent.

Parameters:

Name	Type	Description
event	Events	the event to be sent
opts	SendOptions	the optional parameters

Returns: Events

Defined in: events.ts:109

---

articleFeedbackReaction

▸ articleFeedbackReaction(data: { articleId: string ; articleTitle: string ; isPositive: boolean }): EventWithContext<article_feedback_reaction, { event_ctx_id: string ; event_ctx_reaction: number ; event_ctx_title: string }>

Triggered when article feedback reaction is submited.

Parameters:

Name	Type
data	object
data.articleId	string
data.articleTitle	string
data.isPositive	boolean

Returns: EventWithContext<article_feedback_reaction, { event_ctx_id: string ; event_ctx_reaction: number ; event_ctx_title: string }>

Defined in: events.ts:92

---

pageViewArticle

▸ pageViewArticle(data: { articleId: string ; articleTitle: string }): EventWithContext<page_view_article, { event_ctx_id: string ; event_ctx_title: string }>

Triggered when an article page is viewed in the knowledge base.

Parameters:

Name	Type
data	object
data.articleId	string
data.articleTitle	string

Returns: EventWithContext<page_view_article, { event_ctx_id: string ; event_ctx_title: string }>

Defined in: events.ts:16

---

pageViewCategory

▸ pageViewCategory(data: { categoryId: string ; categoryTitle: string }): EventWithContext<page_view_category, { event_ctx_categoryId: string ; event_ctx_title: string }>

Triggered when a category page is viewed in the knowledge base.

Parameters:

Name	Type
data	object
data.categoryId	string
data.categoryTitle	string

Returns: EventWithContext<page_view_category, { event_ctx_categoryId: string ; event_ctx_title: string }>

Defined in: events.ts:32

---

pageViewIndex

▸ pageViewIndex(): Event<page_view_index>

Triggered when the the home page is viewed in the knowledge base.

Returns: Event<page_view_index>

Defined in: events.ts:6

---

searchClick

▸ searchClick(data: { articleId: string ; articleTitle: string ; resultIndex: number ; searchTerm: string }): EventWithContext<search_click, { event_ctx_id: string ; event_ctx_index: number ; event_ctx_query: string ; event_ctx_title: string }>

Triggered when a user clicks on a search result.

Parameters:

Name	Type
data	object
data.articleId	string
data.articleTitle	string
data.resultIndex	number
data.searchTerm	string

Returns: EventWithContext<search_click, { event_ctx_id: string ; event_ctx_index: number ; event_ctx_query: string ; event_ctx_title: string }>

Defined in: events.ts:70

---

searchQuery

▸ searchQuery(data: { articleIds: string[] ; numberResults: number ; searchTerm: string }): EventWithContext<search_query, { event_ctx_articleIds: string[] ; event_ctx_queryTerm: string ; event_ctx_totalResults: number }>

Triggered when a search has been completed.

Parameters:

Name	Type
data	object
data.articleIds	string[]
data.numberResults	number
data.searchTerm	string

Returns: EventWithContext<search_query, { event_ctx_articleIds: string[] ; event_ctx_queryTerm: string ; event_ctx_totalResults: number }>

Defined in: events.ts:49