@interopio/desktop API Reference

Configuration for User Journey trace behavior. Controls how significant User Journey milestones are tracked throughout the platform session.

Properties (5)

Property Type Default Required Description
chainLength⚓︎ number 0 x

If specified, this number of previously focused applications and their focus times will be added as attributes to the User Journey span. This is useful for some kinds of querying.
descriptiveName⚓︎ boolean true x

If true, the User Journey trace spans will be named interopio.desktop.userJourney... If false, the User Journey trace spans will be named interopio.api.userJourney.
enabled⚓︎ boolean x

Whether the User Journey trace is enabled.
includeWorkspaceInfo⚓︎ boolean true x

Unless false, focus spans for windows that sit in a workspace also carry the workspace context - workspaceId, workspaceName and workspaceTitle. Only workspace membership is resolvable synchronously; the id/name/title are fetched from the workspaces frame asynchronously (two round trips per focus change into a workspace window) and added to the still-open focus span when they arrive - a focus change racing the lookup loses only these attributes.
structure⚓︎ "sibling" | "nested" "sibling" x

If sibling, all spans in the User Journey trace will be nested under the same root span. This is useful when working with visualization interfaces that do not handle arbitrarily nested spans.

If nested, every span in the User Journey trace will be nested under the previous span. This is useful for some kinds of querying.