User clicked

This event tracks when a user interacts with the screen. Here, "click" is a general term that covers any pointing interaction, whether it's a mouse click, a tap on a touchscreen, or a press with a digital pen.

To avoid flooding with rapid clicks, only one event is recorded per 500ms interval.

Automatically tracked

The SDK automatically tracks this event when a user clicks or taps on the screen.

Input properties

This event has no input properties.

Processed properties

These properties are automatically tracked:

point

object

The absolute click coordinates, in pixels, relative to the top-left corner of the surface.

x

number

The horizontal position of the click, in pixels.

y

number

The vertical position of the click, in pixels.

surfaceSize(optional)

object

The total dimensions of the interactive surface, in pixels.

This represents the entire area where interactions can occur, not just the visible portion. For example, on a web page, this would be the full document size, including content below the fold. In a mobile app, it would be the entire scrollable screen area.

width

number

The total width of the surface, in pixels.

height

number

The total height of the surface, in pixels.

Payload examples

Below are some payload examples for this event:

{  "type": "userClicked",  "point": {    "x": 450,    "y": 320  },  "surfaceSize": {    "width": 1920,    "height": 3200  }}