Fields Schema

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

{
  "sessions": [
    {
      "...": "...",
      "fields": [
        {
          "total_field_returns": 1,
          "total_time_preparing_data": 3780,
          "html_tag_name": "BUTTON",
          "html_type": "submit",
          "html_id": "submit",
          "html_name": "submit"
        }
      ]
    }
  ],
  "...": "..."
}

fields

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

Each field has a series of metrics.

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

total_field_returns

The total amount of times that a particular field was returned to during a session.

total_time_preparing_data

The total amount of time that the visitor spent interacting with a particular field.

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