...
Gumband metrics is a feature set that allows you to draw meaningful insight as to how users are utilizing your exhibit. Out of the box, we provide a way to measure the session duration, and, if needed, we can build additional visualizations based on your bespoke use case.
...
Events are singular moments in time when something happens on the exhibit, typically due to a user action like a button push. An Interaction is simply a collection of events that occurred within a specific window of time, typically representing a single, complete user experience of the exhibit.
The most minimal approach to utilizing using the metrics modules can be seen below:
...
You get to choose the value of the event name (“Button Press”) and the payload ({buttonColor: "Blue"}). Once you call this function, the backend of Gumband will take this and any subsequent events and bucket them into the same interaction. If there is a lapse in events for 60 seconds (a the platform default), the backend will time out the interaction. You can take steps to configure the default interaction timeout if needed.
An event that describes how and when a user is interacting with your exhibit is much more interesting than one that simply describes how your exhibit works. For instance, you would not want to fire an event just because the content changed on a passive screen UNLESS that particular change was triggered by the user.
...
Calling gb.metrics.endInteraction() will take any interaction that is “open” and will close it, no longer accepting new events. Any subsequent events (either with create() or startInteraction()) will serve to open a brand new interaction.
...
Previously, we had discussed how the Gumband backend waits 60 seconds without seeing any new events before it closes the interaction; . Any new events will reset the 60 second countdown. Consequently, as long as your events continue to arrive in a timely manner, you can certainly have an interaction that lasts much longer than 60 seconds. In theory you can create an infinite event if you keep sending in gb.metrics.create events!
...