Events captured in the SmartHub Analytics default schema

The following tables outline the various artifact properties that are captured by SmartHub when events are triggered. These properties and artifacts can help provide you with detailed information of a user's search journey, including the SmartHub search environment, the user who initiated the search, the executed query, the document that was opened or previewed by the user, the refiners that were applied or removed from the search query, and more.

To visualize this data, you can build a custom dashboard in Kibana and add it to your SmartHub Analytics reports site

When viewing your Analytics index, you may notice multiple properties that are not listed in the tables below, such as ArtifactMessageId, pax_sequence, pax_ixevent, etc. These properties are for internal use only.

Common properties

The following properties are common to all artifact types:

Property Name Description
Time This provides the timestamp of when the action occurred.
Site This identifies the URL of the site that the action was performed on.
WebUrl This identifies the URL of the web page that the action was performed on.
Tab This identifies the tab ID that the user interacted with.
TabId This identifies the unique identifier of the tab.
TabName This identifies the display name of the tab.
PAXArtifactType

This identifies the type of artifact involved in the action. The possible value include the following:

User profile module properties

The following properties are added by the user profile module to all artifact types:

Property Name Description
User This identifies the name of the user who performed the action.
PreferredName This identifies the user's login used to authenticate.
AccountName This identifies the user's login used to authenticate.
Department This identifies the organizational unit the user belongs to.
Office This identifies the specific office location tied to the user’s profile
JobTitle This identifies the user's job role or function in the organization.
Title This identifies the professional or honorific title of the user. This may overlap with JobTitle in some cases.
UserLocation This identifies the geographic location where the user is based.
Birthday

This identifies the user's birth date.
TimeZone This identifies the user's time zone.
Manager This identifies the user's direct manager.
Skills This identifies the relevant skills associated with the user
HireDate This identifies the date the user started with the company.
YearsWithCompany This is a calculated field showing how long the user has been with the organization.

Specific proprieties

Common specific proprieties

The following proprieties are common for LoadPage, Query, Refiner, Document, PreviewDocument, and DocumentRatedType artifacts:

Property Name Description
Action This identifies the name of the performed action.
Query This identifies the search term or phrase entered by the user.
PageURL This identifies the URL of the page where the user action occurred.

LoadPage properties

The following are the specific properties for the LoadPage artifact:

Property Name Description
Refiners This provides detailed information about the refiners that were applied to the search to narrow down the results.
LoadTime This identifies the amount of time it takes for the page to fully load and be ready for interaction.
ActionValue This identifies the value of the performed action. For the LoadPage artifact it will be the page URL.
UsageMode

This identifies the platform, application, or environment through which the user is accessing or interacting with the system. The possible values are the following:

  • Web Integration (Chrome)

  • Microsoft Dynamics

  • Microsoft Teams

  • Outlook

  • Sales Force

  • Service Now

  • SharePoint Online

  • Iframe Integration

  • Editor

  • Browser

  • Not Specified
Location This identifies the geographic coordinates (latitude and longitude) of the user’s physical location when the action was recorded.

Query properties

The following are the specific properties for the Query artifact:

Property Name Description
Issues

This Indicates any problems that occurred during the user action. The possible values are the following:

  • NoIssues

  • ZeroResults

  • Latency

  • SelectionRank
SearchURL This identifies the full URL that was used to perform the search, including parameters like the query, sort, refiners etc.
Refiners

This provides detailed information about the refiners that were applied to the search to narrow down the results.
Latency This identifies the time taken to complete the action, measured in milliseconds.
ActionValue This identifies the value of the performed action. For the Query artifact, it will be the query terms
UnderlyingQuery This identifies the actual query string processed by the system.
QueryTerms This identifies the individual keywords or tokens that were extracted from the original query input.
QuerySource This identifies the origin of the query.
FromShowMoreResults This indicates whether the results were accessed using the "Show more results" interaction (true/false).
WasSuggested This indicates if the query was based on a system suggestion or recommendation (true/false).
IsNLQ This indicates if the query was written in natural language form (true/false).
Results This identifies the number of search results returned.

Document properties

The following are the specific properties for the Document artifact:

Property Name Description
Issues

This indicates any problems that occurred during the user action. The possible values are the following:

  • NoIssues

  • ZeroResults

  • Latency

  • SelectionRank

SearchURL This identifies the full URL used to perform the search, including parameters like the query, sort, refiners etc.
Refiners

This provides detailed information about the refiners that were applied to the search to narrow down the results.
Page This identifies the page number of the search results where the open document action occurred.
Document This identifies the URL of the document that was opened by the user.
ActionValue This identifies the value of the performed action. For Document artifact, it will be the document URL.
Position This identifies the position of the document in the search results list.
Source This identifies the name of the content source from which the document originates.
Size This identifies the size of the document.
IsDocument This indicates whether the item is a document or not. If the item is a site, person or non-document type, then IsDocument will be false. It will be true for .pdf, .txt, .xlsx, etc.
ActionsSequence This identifies the ordered sequence of user actions leading up to the current event.
QueriesLeadingToDocument This identifies the list of queries performed by the user that led to accessing the document.

PreviewDocument properties

The following are the specific properties for the PreviewDocument artifact:

Property Name Description
Refiners

This provides detailed information about the applied refiners to the search to narrow down the results.
ViewerId

This is the id of the viewer: DocumentViewer
Document This identifies the URL of the document previewed by the user.
FileExtension

This identifies the file type extension of the previewed document.
Pages This identifies a list of previewed page numbers in the document.
PageChangedCount This identifies the number of times the user switched pages during the preview session.
AddedToWorkspace This indicates whether the document was added to a user’s workspace during the preview (true/false).
SearchInside This indicates whether the user performed a search within the previewed document (true/false).
Size This identifies the size of the previewed document.
Viewer This is the name of the viewer: DocumentViewer
LoadFirstPage This identifies the time taken to load the first page of the previewed document.
LoadSwitchPage This identifies the time taken to load a page when the user navigates to a different page during preview.
ActionValue This identifies the value of the performed action. For the PreviewDocument artifact it will be the document URL.

Refiner properties

The following are the specific properties for the Refiner artifact:

Property Name Description
Issues

This indicates any problems that occurred during the user action. The possible values are the following:

  • NoIssues

  • ZeroResults

  • Latency

  • SelectionRank

SearchURL

This identifies the full URL used to perform the search, including parameters like the query, sort, refiners etc.
RefinerName This identifies the name of the applied/removed refiner.
RefinerValues

This identifies a list of applied/removed refinement values.
RefinerType

This identifies the type of the refiner. The possible values are the following:

  • Facet

  • Slider Facet

  • Hierarchical Facet

  • Date Picker Facet

  • unknown
NumberOfValues This identifies the number of values selected by the user in the refiner.
ShowMore This indicates whether the user applied the refiner after clicking the "Show More" button (true/false).
SearchWithin This indicates whether the user applied the refiner after searching within the refiner values (true/false).
KeepFilters This indicates whether the ‘Keep refiners in new searches’ functionality was enabled/disabled.
RefinerState This represents the current state of the refiner: expanded/collapsed.
ActionValue This identifies the value of the performed action. For Refiner artifact it will be the name of the refiner.
Results This identifies the number of results matching the refiner.
Latency This identifies the time taken to complete the action measured in milliseconds.

DocumentRatedType properties

The following are the specific properties for the DocumentRatedType artifact:

Property Name Description
Document

This identifies the URL of the document rated by the user.
NoOfStars

This identifies the number of stars given to the document by the user (e.g., 1 to 5 stars).
MaximumGrade This identifies the highest possible rating value in the system (e.g., 5 stars).
FederatorBackend

This identifies the name of the search engine from which the document was retrieved.
ContentSource

This identifies the name of the content source from which the document originates.

Task properties

The following are the specific properties for the Task artifact:

Property Name Description
Query

This identifies the full URL used to perform the search, including parameters like the query, sort, refiners etc.
Issues

This indicates any problems that occurred during the user action. The possible values are the following:

  • NoIssues

  • ZeroResults

  • Latency

  • SelectionRank
SearchURL

This identifies the full URL used to perform the search, including parameters like the query, sort, refiners etc.
sessionType

This identifies the type of the session. For Task artifacts, the value is search.
PageURL This identifies the URL of the page where the task session occurred.
Actions This is a list of tracked user interactions during a task/search session. Each item in the array represents a specific action performed by the user. For example, loading a page, submitting a query, opening a result, applying/removing a filter etc.
RefinerNames This is a list of all refiner names, regardless of whether they have been applied or removed during the session.
NumberOfRefiners This identifies the number of refiners interacted with, regardless of whether they were applied or removed during the session.
Refiners This provides detailed information about the applied refiners to the search to narrow down the results.
RefinersSequence This is an ordered list representing the sequence in which refiners were applied or removed.
Efficiency This identifies a score reflecting how effectively the user’s actions contributed toward achieving goals. If the user performed 5 or fewer non-goal actions, efficiency is 100 (optimal). Otherwise, it’s a weighted average where goal actions count fully (weight 100) and non-goal actions count half as much (weight 50), indicating overall interaction efficiency during the session.
Progress This identifies a score reflecting how quickly the user reached their first goal during the search session, based on the number of actions taken. Higher values indicate faster progress toward the goal. The score is benchmarked with 100 as an ideal maximum, with possible negative values if goals are not reached promptly.
SearchQuality This identifies a score reflecting the quality of the search session by penalizing issue occurrences. It counts how many actions went well versus how many had problems, giving bigger penalties for serious issues. The higher the score, the better the search quality.
Experience

This identifies a numeric score (1 to 4) to indicate the quality of the user’s search experience based on goal achievement and issues encountered:

  • 4: Goal achieved, no issues (ideal experience).

  • 3: Goal achieved, but with issues (content reached, but with effort).

  • 2: No goal, no issues (search works, but user didn't find desired content).

  • 1: No goal, with issues (user stuck, poor experience).
ExperienceGrade

This identifies a letter grade (A to D) that corresponds to the numeric experience score, where:

  • 4 = A (best)

  • 3 = B

  • 2 = C

  • 1 = D (worst)
Duration This identifies the total time spent in the search session, measured in seconds.
ActionsCount This identifies the total number of user actions tracked in the search session.

Visit properties

The following are the specific properties for the Visit artifact:

Property Name Description
Browser

This identifies the web browser and version used during the session.
StartPage

This identifies the first page accessed at the beginning of the visit session.
sessionType

This identifies the type of the session. For Visit artifacts, the value is visit.
VisitedPagesSequence

This is an ordered list representing the sequence in which pages were visited.
QueriesSequence This is an ordered list representing the sequence in which searches were performed.
Actions This identifies a list of tracked user interactions during a visit session. Each item in the array represents a specific action performed by the user. For example, loading a page, submitting a query, opening a result, applying/removing a filter, etc.
RefinersSequence This is an ordered list representing the sequence in which refiners were applied or removed.
NumberOfActions This identifies the total number of user interactions recorded during the visit session.
Queries This identifies a list of all search queries executed by the user during the visit session.
VisitedPages This is identifies a list of all web pages visited during the visit session.
NumberOfVisitedPages This identifies the total number of all visited pages.
Efficiency This indicates the average efficiency across all search sessions in the visit. It represents how effectively the user performed goal-directed actions during the entire visit. Higher values indicate more efficient interaction overall.
Progress This indicates the average progress score from the search sessions within the visit. It represents how quickly the user typically reached their first goal across the visit. Higher scores reflect faster goal achievement; lower or negative scores suggest delays or failure to reach goals.
SearchQuality This indicates the average quality of search sessions during the visit. It measures how well the search interactions went, factoring in problems or issues encountered. A higher score means fewer issues and higher-quality search behavior across the visit.
Experience This indicates the average user experience score across all search sessions in the visit, based on goal achievement and presence of issues. This value ranges from 1 (worst) to 4 (best), and reflects the overall user satisfaction and success during the visit.
ExperienceGrade

This identifies a letter grade (A to D-) summarizing the average experience score for the visit:

• A: Perfect experience - Goals achieved with no issues.

• A-: Nearly excellent - Goals consistently achieved with minimal friction.

• B+: Strong experience - Most goals achieved, few issues.

• B: Good - Goals achieved, but some noticeable issues.

• B-: Decent - Goals often achieved, but more effort or issues present.

• C+: Mixed experience - Limited success, some interaction problems.

• C: Unsuccessful but smooth - No goals reached, but no major issues.

• D+: Poor - Goals not achieved, minor issues present.

• D: Very poor - No goals and several issues.

• D-: Extremely poor - User experience was heavily problematic.
Duration

This identifies the total time spent in the search session, measured in minutes.
QueriesCount This identifies the total number of queries executed in the current visit session.