❗️

Contact your sales representative if you are interested in obtaining a license for the Analytics Module for your SmartIQ environment

The Analytics module is responsible for the collection and presentation of both the raw question response data (captured at submission time) and user interaction with a form, their location, and device information. This raw produce usage data is maintained in the SmartIQ database, and accessed as Data Objects through the SmartIQ Data Source, for consumption in other projects like a reporting dashboard.

📘

Analytics is not access to System Data

The API is the only integration point to retrieve the system data pertaining to Transaction Data, Projects, Published Projects, Project Results, Workflow, SmartIQ Users, and User Groups.

📘

Interface Feature Availability

Data being captured is of the Produce web interface only.

Analytics Data Objects

These data objects are accessible through the SmartIQ Data Source

Analytics Project Results

Project Results refers to the actual data captured by form submissions. This data can be consumed by multiple methods;

This can be used to create projects based on the results of submissions of other projects.

The "Data Object Name/Definition" field can be used to define a Project Name in the SmartIQ instance. Projects whose titles start with the same sequence will be displayed in the drop-down menu for selection. The Available Filter Fields for the Data Source are the Answers in that particular Project. If the project has Repeaters, the repeated data elements will appear in the pages panel.

📘

Default Filter Field values are, Completed = 1 and WorkflowInProgress = 0

Analytics Device Log

🚧

Web Only

Device and Location Log data is captured via the Produce App only

The device (location) log captures information about the user interacting with the system, such as GPS location data and more general region data from IP such as country, city and time zone. Device data includes information such as devices, operating systems, browsers, versions, and language.

Location data is categorized into high and low accuracy readings. SmartIQ always adds a low accuracy record by default and then attempts a second high accuracy reading where the SmartIQ application is hosted on a secure server and the user has agreed to do so, usually by answering yes to a browser pop-up.

Regardless of the low or high accuracy reading SmartIQ can attempt to convert the IP address into a more reportable regional field such as Country, City, Region, etc. SmartIQ must request regional information from an external service. By default, SmartIQ makes requests to https://ipapi.co over a secure SSL connection.

Free services generally have a small daily limit (eg: 1000 requests) if you wish to use the location log for a large number of calls you will need to sign up to one the paid services.

🚧

Where it is not appropriate to make a call to a location service, the feature can be disabled from Retention Settings, deselecting the Store Location Data option.

📘

Raw Device Log Data

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

SELECT TOP (1000) [IPAddress],[OS],[OSVersionMajor],[OSVersionMinor],[City],[Country],[CountryCode],[Region],[RegionCode],[PostalCode],[TimeZone],[Browser],[BrowserVersionMajor],[BrowserVersionMinor],[Device],[Model],[Platform],[Latitude],[Longitude],[Languages],[UserGuid],[LoginTimeUtc],[LocationAccuracy]
FROM [Analytics_DeviceLog]

Analytics Interaction Log

The interaction log captures every user interaction within a form allowing detailed analysis of a users journey through the form, including the navigation path, time spent on each question, or page, drop-offs, save points, every key stroke and click made by the user during a form, etc

🚧

The interaction log is stored as unencrypted raw text

Any personally identifiable information (PII) that makes its way into the interaction log will not be encrypted.

The interaction log can contain Layout Block names which can contain question references. If these question references contain PII it will be as unencrypted raw text.

To enable this data gathering the 'Form Interaction Log' Publish Option must be enabled.

Due to the large volumes of data captured by the interaction log configuration to record data for only particular forms is possible.

Records are added to the interaction log in batch asynchronously as the user makes their way through the form.

As the interaction log is a capture of everything, records from are usually filtered to answer a specific question or populate a graph. Some inbuilt queries are provided to answer generic questions like drop-offs or average time spent on each page.

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.

Analytics Interaction Time Log

Returns the time of each interaction together with a calculated 'Interaction Time' column. The interaction time column is the time span between the interaction with the current interaction and the next interaction.

Analytics Drop-off Log

Returns forms that were forcibly exited. It includes the last page the user was on together with the last question the user interacted with. If no questions were interacted with on the page question columns will resolve to null.

A drop-off is defined as a form that is exited in a manner that is NOT: Submitted, Reassigned, Go to Project (Tile Question), or Saved (A saved form can be exited without counting as a drop off).

Analytics Save Log

When projects was last saved together with the total amount of saves.

Returns when projects were last saved together with the total amount of saves.

Analytics Page Log

Which pages were visited during a form and how much time was spent on each page. Note the endpoint of being 'on' a page is either going to another page or as per the list above.

Returns which pages were visited during a form and how much time was spent on each page. Note the endpoint of being 'on' a page is either going to another page or: Submitted, Reassigned, Go to Project (Tile Question), or Saved (A saved form can be exited without counting as a drop off).