Flurries Schema

When the inclusion of flurries has been requested, the following will be added to the standard response schema:

{
  "sessions": [
    {
      "...": "...",
      "flurries": [
        {
          "keypress_count": 6,
          "click_count": 0,
          "change_count": 1,
          "total_time_preparing_data": 2608,
          "html_tag_name": "INPUT",
          "html_type": "text",
          "html_id": "",
          "html_name": "",
          "started_at": "2023-03-01T00:06:33Z",
          "completed_at": "2023-03-01T00:06:36Z"
        }
      ]
    }
  ],
  "...": "..."
}

flurries

The value of this key is an array containing flurry objects for every field that was interacted within the session.

Each flurry has a series of metrics.

We also include the attributes used to identify the field which the metrics belong to.

keypress_count

The total amount of key presses within the flurry.

click_count

The total amount of clicks within the flurry.

change_count

The total amount of times that the field was changed in the flurry.

total_time_preparing_data

The total amount of time that the visitor spent interacting the field in the flurry.

This metric is in milliseconds.

html_tag_name

The tagName of the field element. E.g. INPUT

html_type

The type attribute of the field element. E.g. email

html_name

The name attribute of the field element. E.g. user-email

html_id

The id attribute of the field element. E.g. user-email

started_at

A string containing a ISO 8601 formatted timestamp of when the visitor starts interacting with the field that the flurry belongs to.

completed_at

A string containing a ISO 8601 formatted timestamp of when the visitor finishes interacting with the field that the flurry belongs to.