HomeGuidesRecipesAPI
HomeGuidesAPILog In

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

Field

Description

Examples

Log_Guid

An 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

ControlID

An identifier for the control that is being selected or manipulated.

btnNextTop, fName_q2.2, btnSubmit, goToHome

FocusTimeUTC

The moment the user started the interaction.

2020-01-01 02:05:25.000

BlurTimeUTC

The 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 control

2020-01-01 02:05:25.000

EventType

The type of event that occurred using the specified control.

pageOpen, dataGridSort LastUpdatedUtc, next

Page Title

The 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.

EventType

Description

Control/Occurs When

createNew

Open a new form

Form Open

openAssigned

Open an assigned task for the first time

Form Open

resumeSaved

resume an in progress item

Form Open

questionHelp

Clicked question help icon

All Question Types

questionOpenComment

Clicked open comments icon

All Question Types

buttonToggle

Changed a toggle buttons position to on/off

Multiple Choice Question

contentTxtSearch

Clicked into the search box of a content library text box

Content Library

contentOpen

Opened a content library item

Content Library

contentPreview

Previewed a content library item

Content Library

contentOpenDocument

Opened a content library docuemnt

Content Library

fetchData

Clicked the data search text box (usually after entering a filter)

Data Source

dataGridSort

Sorted a data grid column, includes the column name that was sorted

Data Source

dataGridSearch

entered the data grid search text box

Data Source

popupOpen

Opened a data Source pop up. Usually containing a table of data that required the whole screen.

Data Source

inkUpload

Upload an image to an Ink question.

Ink

inkClear

Clear the drawn content entirely within an ink question

Ink

inkEraser

Use the eraser within an ink question

Ink

inkZoomIn, inkZoomOut

Zoom the ink question in or out so it fills the entire screen, for easier editing.

Ink

save

Click save button

Produce

next, back

Went back or forwards within a form

Produce

submit

Submitted a form

Produce

pageAdd

User added a repeating page

Produce

pageDelete

Deleted a repeating page

Produce

pageDuplicate

Duplciated a repeating page

Produce

sectionChkRow

Selected a repeating section row

Produce

sectionAdd

Added a repeating Section

Produce

sectionDelete

Deleted a repeating Section

Produce

sectionDuplicate

Duplicated a repeating Section

Produce

sectionExport, sectionIMport

Import or export a section into or from a CSV file.

Produce

saveAnswerFileYes, saveAnswerFileNo

User makes a selection indicated whether to save an answer File

Produce Finish Page

answerFileDescription

User typing an answer file destiption

Produce Finish Page

Typing in auto complete question

Data Source Auto Complete

Typing into a filter field

Data Field

Select Deselect a record

Data Source Multi Select

Use the latitude text box

Geo Location

Use the longitude text box

Geo Location

Selected an option

Multiple Choice

Click the home Button

Produce goToHome

Click the logoff button

Produce logOff

Click a Tab

Tab tabSelect

Mouse into text box and compete

Text Boxes

search for user to assign workflow to

last name and given name workflow

click the search button for users

workflowUserSearch