HomeGuidesRecipesAPI
HomeGuidesAPILog In
Guides
These docs are for v16. Click to read the latest docs for v31.

Interaction Log

The Interaction Log captures every key stroke and click made by the user during a form. This comprehensive data can be used to extract information often including (but not limited to).

  • If users successfully complete or drop off part way through a form
  • The point during a form at which users a dropping off
  • How long it takes users to complete questions, pages or the entire form.
  • The path a user takes through a form, for example do they take a logical forward path or do they go back and forwards to change or review answers.
  • If users save and resume the form at a later date

🚧

Analytics Module

Only available in environments with the analytics module license

Records are added to the interaction log in batch asynchronously as the user makes their way through the form each containing the following fields

FieldDescriptionExamples
Log_GuidAn identifier that groups interactions from the moment a user open's a form.
A new log_guid is generated each time a user opens a form including when they return to an in progress save and between workflow steps.
CF27B290-49ED-4A42-BF34-08109D6A1A8A
ControlIDAn identifier for the control that is being selected or manipulated.btnNextTop, fName_q2.2, btnSubmit, goToHome
FocusTimeUTCThe moment the user started the interaction.2020-01-01 02:05:25.000
BlurTimeUTCThe moment the user finished the interaction. For controls such as buttons this will be the same as the focus time, whereas controls like text boxes this will be the moment the user left the control2020-01-01 02:05:25.000
EventTypeThe type of event that occurred using the specified control.pageOpen, dataGridSort LastUpdatedUtc, next
Page TitleThe Page the control resides on.

As the interaction log is a capture of everything, records from are usually filtered to answer a specific question/populate a graph. Some inbuilt queries are provided to answer generic questions like drop-offs or average time spent on each page. See this article's sub articles for the specific queries available.

📘

Raw Interaction Log Data

To access the raw interaction log data the following query can be run against the SmartIQ Database.

SELECT TOP(1000) [Log_Guid]
,[ControlID]
,[FocusTimeUTC]
,[BlurTimeUTC]
,[EventType]
,[PageTitle]
FROM [Analytics_InteractionLog]
ORDER BY FocusTimeUTC DESC

All possible events are listed in the table below, where a control can do multiple things an event type is used to describe the specific event.

EventTypeDescriptionControl/Occurs When
createNewOpen a new formForm Open
openAssignedOpen an assigned task for the first timeForm Open
resumeSavedresume an in progress itemForm Open
questionHelpClicked question help iconAll Question Types
questionOpenCommentClicked open comments iconAll Question Types
buttonToggleChanged a toggle buttons position to on/offMultiple Choice Question
contentTxtSearchClicked into the search box of a content library text boxContent Library
contentOpenOpened a content library itemContent Library
contentPreviewPreviewed a content library itemContent Library
contentOpenDocumentOpened a content library docuemntContent Library
fetchDataClicked the data search text box (usually after entering a filter)Data Source
dataGridSortSorted a data grid column, includes the column name that was sortedData Source
dataGridSearchentered the data grid search text boxData Source
popupOpenOpened a data Source pop up. Usually containing a table of data that required the whole screen.Data Source
inkUploadUpload an image to an Ink question.Ink
inkClearClear the drawn content entirely within an ink questionInk
inkEraserUse the eraser within an ink questionInk
inkZoomIn, inkZoomOutZoom the ink question in or out so it fills the entire screen, for easier editing.Ink
saveClick save buttonProduce
next, backWent back or forwards within a formProduce
submitSubmitted a formProduce
pageAddUser added a repeating pageProduce
pageDeleteDeleted a repeating pageProduce
pageDuplicateDuplciated a repeating pageProduce
sectionChkRowSelected a repeating section rowProduce
sectionAddAdded a repeating SectionProduce
sectionDeleteDeleted a repeating SectionProduce
sectionDuplicateDuplicated a repeating SectionProduce
sectionExport, sectionIMportImport or export a section into or from a CSV file.Produce
saveAnswerFileYes, saveAnswerFileNoUser makes a selection indicated whether to save an answer FileProduce Finish Page
answerFileDescriptionUser typing an answer file destiptionProduce Finish Page
Typing in auto complete questionData Source Auto Complete
Typing into a filter fieldData Field
Select Deselect a recordData Source Multi Select
Use the latitude text boxGeo Location
Use the longitude text boxGeo Location
Selected an optionMultiple Choice
Click the home ButtonProduce goToHome
Click the logoff buttonProduce logOff
Click a TabTab tabSelect
Mouse into text box and competeText Boxes
search for user to assign workflow tolast name and given name workflow
click the search button for usersworkflowUserSearch