Metrics Platform/Interaction data

This page documents the interaction data supported by the Metrics Platform base schemas. For property descriptions, types and other constraints (like their maximum length), see the base schema definitions.

Unmanaged data

Metrics Platform supports interaction data that you can customize to fit the needs of your instrument. You can set these properties to any meaningful value to provide the data required for your event. See the API docs for information about how to set these properties when submitting events.

action (required)

Examples: "click", "type", "scroll"

action_subtype

Examples: "submit" or "cancel" for click actions; "up" or "down" for scroll actions

action_context

A short (maximum of 64 characters) human-readable phrase to provide meaningful context for the event. Given the length limit, it is not recommend to stuff data via JSON-encoded strings into this field.

action_source

A short (maximum of 64 characters) human-readable set of words to indicate the source of the event. For example: "sidebar" or "visualeditor uploadwizard modal"

element_friendly_name

Analyst-friendly name of the UI element interacted with. For example: "Donate"

element_id

ID of the UI element interacted with

funnel_entry_token

A randomly generated identifier for linking multiple events belonging to a (work)flow. A single session (identified by performer.session_id may have multiple pageviews (identified by performer.pageview_id) which may have multiple instances of funnel_name that are separately identified by this token.

funnel_name

Analyst-friendly name such as "emergency-flow" or "Add a Link suggestion"

Managed data

These properties are not manually set by your instrument but are instead managed by the client libraries (as long as you use the Instrument class).

funnel_event_sequence_position

0 for the first event submitted by instrument, incremented by 1 for each subsequent event