Page element visibility and interaction tracking

Page element tracking captures user interactions with specific elements on your web pages, including buttons, forms, and any other visible components.

Use page element tracking to:

Measure button click engagement across your site
Track form interactions including focus, changes, and submissions
Understand which page sections users actually see
Build funnel analysis based on element visibility and interactions
Measure content consumption and scroll depth

Button clicks

Button click tracking automatically captures clicks on <button> and <input type="button"> elements.

This table shows the support for button click tracking across the main client-side Snowplow tracker SDKs:

Tracker	Supported	Since version	Auto-tracking	Notes
Web	✅	3.18.0	✅	Requires button click plugin
iOS	❌
Android	❌
React Native	❌
Flutter	❌
Roku	❌
Google Tag Manager	✅	v4	✅	Integrates with button click plugin

We recommend using the Base web tracking plan template for web tracking. It includes button clicks.

button_click

Event

Schema for a button click event

Schema URIiglu:com.snowplowanalytics.snowplow/button_click/jsonschema/1-0-0

Example

json
{
  "label": "Submit",
  "id": "submit-btn",
  "classes": [
    "btn",
    "btn-primary"
  ],
  "name": "submit"
}

Properties and schema

Table
JSON schema

Property	Description
`label` string	Required. The text on the button, or a user-provided override
`id` string	Optional. The ID of the button
`classes` array	Optional. The classes of the button
`name` string	Optional. The name attribute of the button

json
{
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
  "description": "Schema for a button click event",
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "button_click",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "description": "The text on the button, or a user-provided override"
    },
    "id": {
      "type": "string",
      "description": "The ID of the button"
    },
    "classes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The classes of the button"
    },
    "name": {
      "type": "string",
      "description": "The name attribute of the button"
    }
  },
  "required": [
    "label"
  ],
  "additionalProperties": false
}

Warehouse query

Snowflake
BigQuery
Databricks
Redshift & Postgres

sql
select
unstruct_event_com_snowplowanalytics_snowplow_button_click_1 button_click_1
from
atomic.events
where
events.collector_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'button_click'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_button_click_1_0_0
from
PIPELINE_NAME.events events
where
events.collector_tstamp > timestamp_sub(current_timestamp(), interval 1 hour)
and events.event = 'unstruct'
and events.event_name = 'button_click'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_button_click_1
from
atomic.events events
where
events.collector_tstamp > timestampadd(HOUR, -1, current_timestamp())
and events.event = 'unstruct'
and events.event_name = 'button_click'
and events.event_vendor = 'com.snowplowanalytics.snowplow'
and unstruct_event_com_snowplowanalytics_snowplow_button_click_1 is not null

sql
select
"button_click_1".*
from
atomic.events events
join atomic.com_snowplowanalytics_snowplow_button_click_1 "button_click_1"
  on "button_click_1".root_id = events.event_id and "button_click_1".root_tstamp = events.collector_tstamp
where
events.collector_tstamp > getdate() - interval '1 hour'
and "button_click_1".root_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'button_click'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

Form interactions

Form tracking captures three types of events: when a user focuses on a form field, when a field value changes, and when a form is submitted.

This table shows the support for form tracking across the main client-side Snowplow tracker SDKs:

Tracker	Supported	Since version	Auto-tracking	Notes
Web	✅	2.1.0 (directly), 3.0.0 (as plugin)	✅	Requires form tracking plugin
iOS	❌
Android	❌
React Native	❌
Flutter	❌
Roku	❌
Python	❌			The Python tracker has deprecated form tracking APIs; use custom events with form schemas instead
Google Tag Manager	✅	v3	✅	Integrates with form tracking plugin

Focus form event

Triggered when a user focuses on a form field.

focus_form

Event

Schema for a form field focus event

Schema URIiglu:com.snowplowanalytics.snowplow/focus_form/jsonschema/1-0-0

Example

json
{
  "formId": "contact-form",
  "elementId": "email",
  "nodeName": "INPUT",
  "elementType": "email",
  "elementClasses": [
    "form-control"
  ],
  "value": ""
}

Properties and schema

Table
JSON schema

Property	Description
`formId` string	Required. The ID of the form
`elementId` string	Optional. The ID of the element
`nodeName` string	Required. The node name of the element Must be one of: `INPUT`, `TEXTAREA`, `SELECT`
`elementType` string	Optional. The type of the element
`elementClasses` array	Required. The classes of the element
`value` string	Optional. The value of the element

json
{
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
  "description": "Schema for a form field focus event",
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "focus_form",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "type": "object",
  "properties": {
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    },
    "elementId": {
      "type": "string",
      "description": "The ID of the element"
    },
    "nodeName": {
      "type": "string",
      "enum": [
        "INPUT",
        "TEXTAREA",
        "SELECT"
      ],
      "description": "The node name of the element"
    },
    "elementType": {
      "type": [
        "string",
        "null"
      ],
      "description": "The type of the element"
    },
    "elementClasses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The classes of the element"
    },
    "value": {
      "type": [
        "string",
        "null"
      ],
      "description": "The value of the element"
    }
  },
  "required": [
    "formId",
    "nodeName",
    "elementClasses"
  ],
  "additionalProperties": false
}

Warehouse query

Snowflake
BigQuery
Databricks
Redshift & Postgres

sql
select
unstruct_event_com_snowplowanalytics_snowplow_focus_form_1 focus_form_1
from
atomic.events
where
events.collector_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'focus_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_focus_form_1_0_0
from
PIPELINE_NAME.events events
where
events.collector_tstamp > timestamp_sub(current_timestamp(), interval 1 hour)
and events.event = 'unstruct'
and events.event_name = 'focus_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_focus_form_1
from
atomic.events events
where
events.collector_tstamp > timestampadd(HOUR, -1, current_timestamp())
and events.event = 'unstruct'
and events.event_name = 'focus_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'
and unstruct_event_com_snowplowanalytics_snowplow_focus_form_1 is not null

sql
select
"focus_form_1".*
from
atomic.events events
join atomic.com_snowplowanalytics_snowplow_focus_form_1 "focus_form_1"
  on "focus_form_1".root_id = events.event_id and "focus_form_1".root_tstamp = events.collector_tstamp
where
events.collector_tstamp > getdate() - interval '1 hour'
and "focus_form_1".root_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'focus_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

Change form event

Triggered when a user changes the value of a form field.

change_form

Event

Schema for a form field change event

Schema URIiglu:com.snowplowanalytics.snowplow/change_form/jsonschema/1-0-0

Example

json
{
  "formId": "contact-form",
  "elementId": "email",
  "nodeName": "INPUT",
  "elementType": "email",
  "elementClasses": [
    "form-control"
  ],
  "value": "user@example.com"
}

Properties and schema

Table
JSON schema

Property	Description
`formId` string	Required. The ID of the form
`elementId` string	Optional. The ID of the element
`nodeName` string	Required. The node name of the element Must be one of: `INPUT`, `TEXTAREA`, `SELECT`
`elementType` string	Optional. The type of the element
`elementClasses` array	Required. The classes of the element
`value` string	Required. The value of the element

json
{
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
  "description": "Schema for a form field change event",
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "change_form",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "type": "object",
  "properties": {
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    },
    "elementId": {
      "type": "string",
      "description": "The ID of the element"
    },
    "nodeName": {
      "type": "string",
      "enum": [
        "INPUT",
        "TEXTAREA",
        "SELECT"
      ],
      "description": "The node name of the element"
    },
    "elementType": {
      "type": [
        "string",
        "null"
      ],
      "description": "The type of the element"
    },
    "elementClasses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The classes of the element"
    },
    "value": {
      "type": [
        "string",
        "null"
      ],
      "description": "The value of the element"
    }
  },
  "required": [
    "formId",
    "nodeName",
    "elementClasses",
    "value"
  ],
  "additionalProperties": false
}

Warehouse query

Snowflake
BigQuery
Databricks
Redshift & Postgres

sql
select
unstruct_event_com_snowplowanalytics_snowplow_change_form_1 change_form_1
from
atomic.events
where
events.collector_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'change_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_change_form_1_0_0
from
PIPELINE_NAME.events events
where
events.collector_tstamp > timestamp_sub(current_timestamp(), interval 1 hour)
and events.event = 'unstruct'
and events.event_name = 'change_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_change_form_1
from
atomic.events events
where
events.collector_tstamp > timestampadd(HOUR, -1, current_timestamp())
and events.event = 'unstruct'
and events.event_name = 'change_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'
and unstruct_event_com_snowplowanalytics_snowplow_change_form_1 is not null

sql
select
"change_form_1".*
from
atomic.events events
join atomic.com_snowplowanalytics_snowplow_change_form_1 "change_form_1"
  on "change_form_1".root_id = events.event_id and "change_form_1".root_tstamp = events.collector_tstamp
where
events.collector_tstamp > getdate() - interval '1 hour'
and "change_form_1".root_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'change_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

Submit form event

Triggered when a user submits a form. Contains data about all form fields.

submit_form

Event

Schema for a form submission event

Schema URIiglu:com.snowplowanalytics.snowplow/submit_form/jsonschema/1-0-0

Example

json
{
  "formId": "contact-form",
  "formClasses": [
    "contact-form",
    "validated"
  ],
  "elements": [
    {
      "name": "email",
      "value": "user@example.com",
      "nodeName": "INPUT",
      "type": "email"
    },
    {
      "name": "message",
      "value": "Hello",
      "nodeName": "TEXTAREA",
      "type": null
    }
  ]
}

Properties and schema

Table
JSON schema

Property	Description
`formId` string	Required. The ID of the form
`formClasses` array	Required. The classes of the form
`elements` array	Required. The form elements and their values

json
{
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
  "description": "Schema for a form submission event",
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "submit_form",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "type": "object",
  "properties": {
    "formId": {
      "type": "string",
      "description": "The ID of the form"
    },
    "formClasses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The classes of the form"
    },
    "elements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": [
              "string",
              "null"
            ]
          },
          "nodeName": {
            "type": "string",
            "enum": [
              "INPUT",
              "TEXTAREA",
              "SELECT"
            ]
          },
          "type": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "name",
          "nodeName"
        ],
        "additionalProperties": false
      },
      "description": "The form elements and their values"
    }
  },
  "required": [
    "formId",
    "formClasses",
    "elements"
  ],
  "additionalProperties": false
}

Warehouse query

Snowflake
BigQuery
Databricks
Redshift & Postgres

sql
select
unstruct_event_com_snowplowanalytics_snowplow_submit_form_1 submit_form_1
from
atomic.events
where
events.collector_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'submit_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_submit_form_1_0_0
from
PIPELINE_NAME.events events
where
events.collector_tstamp > timestamp_sub(current_timestamp(), interval 1 hour)
and events.event = 'unstruct'
and events.event_name = 'submit_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_submit_form_1
from
atomic.events events
where
events.collector_tstamp > timestampadd(HOUR, -1, current_timestamp())
and events.event = 'unstruct'
and events.event_name = 'submit_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'
and unstruct_event_com_snowplowanalytics_snowplow_submit_form_1 is not null

sql
select
"submit_form_1".*
from
atomic.events events
join atomic.com_snowplowanalytics_snowplow_submit_form_1 "submit_form_1"
  on "submit_form_1".root_id = events.event_id and "submit_form_1".root_tstamp = events.collector_tstamp
where
events.collector_tstamp > getdate() - interval '1 hour'
and "submit_form_1".root_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'submit_form'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

Page element visibility and lifecycle

Element visibility tracking enables declarative tracking of page elements as they are created, become visible, leave view, or are removed from the page. It's only available for web.

This table shows the support for page element visibility tracking across the main client-side Snowplow tracker SDKs:

Tracker	Supported	Since version	Auto-tracking
Web	✅	4.6.0	✅
iOS	❌
Android	❌
React Native	❌
Flutter	❌
Roku	❌
Google Tag Manager	❌

Events

The element tracking plugin generates four event types:

create_element: when a matching element is added to the page
expose_element: when a matching element scrolls into view
obscure_element: when a matching element scrolls out of view
destroy_element: when a matching element is removed from the page

All of these events have a single property, element_name. The plugin adds an element entity with information about the tracked element.

You can also configure the tracker to attach element_statistics, element_content, or component_parents entities.

Create element event

Triggered when an element matching a named configuration is added to the page or detected on page load.

create_element

Event

Event that fires when an element matching a named configuration is detected as existing in or being added to a document.

Schema URIiglu:com.snowplowanalytics.snowplow/create_element/jsonschema/1-0-0

Example

json
{
  "element_name": "newsletter signup"
}

Properties and schema

Table
JSON schema

Property	Description
`element_name` string	Required. The name of the element that was created. Should match the element name field in entities that describe this particular element.

json
{
  "description": "Event that fires when an element matching a named configuration is detected as existing in or being added to a document.",
  "properties": {
    "element_name": {
      "description": "The name of the element that was created. Should match the element name field in entities that describe this particular element.",
      "type": "string",
      "maxLength": 255
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "element_name"
  ],
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "create_element",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#"
}

Warehouse query

Snowflake
BigQuery
Databricks
Redshift & Postgres

sql
select
unstruct_event_com_snowplowanalytics_snowplow_create_element_1 create_element_1
from
atomic.events
where
events.collector_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'create_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_create_element_1_0_0
from
PIPELINE_NAME.events events
where
events.collector_tstamp > timestamp_sub(current_timestamp(), interval 1 hour)
and events.event = 'unstruct'
and events.event_name = 'create_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_create_element_1
from
atomic.events events
where
events.collector_tstamp > timestampadd(HOUR, -1, current_timestamp())
and events.event = 'unstruct'
and events.event_name = 'create_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'
and unstruct_event_com_snowplowanalytics_snowplow_create_element_1 is not null

sql
select
"create_element_1".*
from
atomic.events events
join atomic.com_snowplowanalytics_snowplow_create_element_1 "create_element_1"
  on "create_element_1".root_id = events.event_id and "create_element_1".root_tstamp = events.collector_tstamp
where
events.collector_tstamp > getdate() - interval '1 hour'
and "create_element_1".root_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'create_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

Expose element event

Triggered when a tracked element scrolls into the viewport and becomes visible to the user.

expose_element

Event

Event that fires when an element matching a named configuration is detected as intersecting with the viewport, becoming visible to the user.

Schema URIiglu:com.snowplowanalytics.snowplow/expose_element/jsonschema/1-0-0

Example

json
{
  "element_name": "newsletter signup"
}

Properties and schema

Table
JSON schema

Property	Description
`element_name` string	Required. The name of the element that was exposed. Should match the element name field in entities that describe this particular element.

json
{
  "description": "Event that fires when an element matching a named configuration is detected as intersecting with the viewport, becoming visible to the user.",
  "properties": {
    "element_name": {
      "description": "The name of the element that was exposed. Should match the element name field in entities that describe this particular element.",
      "type": "string",
      "maxLength": 255
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "element_name"
  ],
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "expose_element",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#"
}

Warehouse query

Snowflake
BigQuery
Databricks
Redshift & Postgres

sql
select
unstruct_event_com_snowplowanalytics_snowplow_expose_element_1 expose_element_1
from
atomic.events
where
events.collector_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'expose_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_expose_element_1_0_0
from
PIPELINE_NAME.events events
where
events.collector_tstamp > timestamp_sub(current_timestamp(), interval 1 hour)
and events.event = 'unstruct'
and events.event_name = 'expose_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_expose_element_1
from
atomic.events events
where
events.collector_tstamp > timestampadd(HOUR, -1, current_timestamp())
and events.event = 'unstruct'
and events.event_name = 'expose_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'
and unstruct_event_com_snowplowanalytics_snowplow_expose_element_1 is not null

sql
select
"expose_element_1".*
from
atomic.events events
join atomic.com_snowplowanalytics_snowplow_expose_element_1 "expose_element_1"
  on "expose_element_1".root_id = events.event_id and "expose_element_1".root_tstamp = events.collector_tstamp
where
events.collector_tstamp > getdate() - interval '1 hour'
and "expose_element_1".root_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'expose_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

Obscure element event

Triggered when a tracked element scrolls out of the viewport or becomes hidden from the user.

obscure_element

Event

Event that fires when an element matching a named configuration is detected as becoming hidden from a user or moving out of the viewport.

Schema URIiglu:com.snowplowanalytics.snowplow/obscure_element/jsonschema/1-0-0

Example

json
{
  "element_name": "newsletter signup"
}

Properties and schema

Table
JSON schema

Property	Description
`element_name` string	Required. The name of the element that was obscured. Should match the element name field in entities that describe this particular element.

json
{
  "description": "Event that fires when an element matching a named configuration is detected as becoming hidden from a user or moving out of the viewport.",
  "properties": {
    "element_name": {
      "description": "The name of the element that was obscured. Should match the element name field in entities that describe this particular element.",
      "type": "string",
      "maxLength": 255
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "element_name"
  ],
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "obscure_element",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#"
}

Warehouse query

Snowflake
BigQuery
Databricks
Redshift & Postgres

sql
select
unstruct_event_com_snowplowanalytics_snowplow_obscure_element_1 obscure_element_1
from
atomic.events
where
events.collector_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'obscure_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_obscure_element_1_0_0
from
PIPELINE_NAME.events events
where
events.collector_tstamp > timestamp_sub(current_timestamp(), interval 1 hour)
and events.event = 'unstruct'
and events.event_name = 'obscure_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_obscure_element_1
from
atomic.events events
where
events.collector_tstamp > timestampadd(HOUR, -1, current_timestamp())
and events.event = 'unstruct'
and events.event_name = 'obscure_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'
and unstruct_event_com_snowplowanalytics_snowplow_obscure_element_1 is not null

sql
select
"obscure_element_1".*
from
atomic.events events
join atomic.com_snowplowanalytics_snowplow_obscure_element_1 "obscure_element_1"
  on "obscure_element_1".root_id = events.event_id and "obscure_element_1".root_tstamp = events.collector_tstamp
where
events.collector_tstamp > getdate() - interval '1 hour'
and "obscure_element_1".root_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'obscure_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

Destroy element event

Triggered when a tracked element is removed from the page.

destroy_element

Event

Event that fires when an element matching a named configuration is detected as being removed from a document.

Schema URIiglu:com.snowplowanalytics.snowplow/destroy_element/jsonschema/1-0-0

Example

json
{
  "element_name": "newsletter signup"
}

Properties and schema

Table
JSON schema

Property	Description
`element_name` string	Required. The name of the element that was destroyed. Should match the element name field in entities that describe this particular element.

json
{
  "description": "Event that fires when an element matching a named configuration is detected as being removed from a document.",
  "properties": {
    "element_name": {
      "description": "The name of the element that was destroyed. Should match the element name field in entities that describe this particular element.",
      "type": "string",
      "maxLength": 255
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "element_name"
  ],
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "destroy_element",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#"
}

Warehouse query

Snowflake
BigQuery
Databricks
Redshift & Postgres

sql
select
unstruct_event_com_snowplowanalytics_snowplow_destroy_element_1 destroy_element_1
from
atomic.events
where
events.collector_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'destroy_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_destroy_element_1_0_0
from
PIPELINE_NAME.events events
where
events.collector_tstamp > timestamp_sub(current_timestamp(), interval 1 hour)
and events.event = 'unstruct'
and events.event_name = 'destroy_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

sql
select
unstruct_event_com_snowplowanalytics_snowplow_destroy_element_1
from
atomic.events events
where
events.collector_tstamp > timestampadd(HOUR, -1, current_timestamp())
and events.event = 'unstruct'
and events.event_name = 'destroy_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'
and unstruct_event_com_snowplowanalytics_snowplow_destroy_element_1 is not null

sql
select
"destroy_element_1".*
from
atomic.events events
join atomic.com_snowplowanalytics_snowplow_destroy_element_1 "destroy_element_1"
  on "destroy_element_1".root_id = events.event_id and "destroy_element_1".root_tstamp = events.collector_tstamp
where
events.collector_tstamp > getdate() - interval '1 hour'
and "destroy_element_1".root_tstamp > getdate() - interval '1 hour'
and events.event = 'unstruct'
and events.event_name = 'destroy_element'
and events.event_vendor = 'com.snowplowanalytics.snowplow'

Element entity

The element entity is attached to all element tracking events and contains information about the tracked element's position, dimensions, and attributes.

element

Entity

Schema for element context

Schema URIiglu:com.snowplowanalytics.snowplow/element/jsonschema/1-0-0

Example

json
{
  "element_name": "newsletter signup",
  "width": 560,
  "height": 137,
  "position_x": 320,
  "position_y": 1953.5,
  "doc_position_x": 320,
  "doc_position_y": 5392.5,
  "element_index": 2,
  "element_matches": 2,
  "originating_page_view": "02e30714-a84a-42f8-8b07-df106d669db0",
  "attributes": []
}

Properties and schema

Table
JSON schema

Property	Description
`element_name` string	Required. The name of the element
`width` number	Optional. The width of the element
`height` number	Optional. The height of the element
`position_x` number	Optional. The x position of the element in the viewport
`position_y` number	Optional. The y position of the element in the viewport
`doc_position_x` number	Optional. The x position of the element in the document
`doc_position_y` number	Optional. The y position of the element in the document
`element_index` integer	Optional. The index of this element among all matching elements
`element_matches` integer	Optional. The total number of elements matching the rule
`originating_page_view` string	Optional. The page view ID when the element was first observed
`attributes` array	Optional. Custom attributes extracted from the element

json
{
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
  "description": "Schema for element context",
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "element",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "type": "object",
  "properties": {
    "element_name": {
      "type": "string",
      "description": "The name of the element"
    },
    "width": {
      "type": "number",
      "description": "The width of the element"
    },
    "height": {
      "type": "number",
      "description": "The height of the element"
    },
    "position_x": {
      "type": "number",
      "description": "The x position of the element in the viewport"
    },
    "position_y": {
      "type": "number",
      "description": "The y position of the element in the viewport"
    },
    "doc_position_x": {
      "type": "number",
      "description": "The x position of the element in the document"
    },
    "doc_position_y": {
      "type": "number",
      "description": "The y position of the element in the document"
    },
    "element_index": {
      "type": "integer",
      "description": "The index of this element among all matching elements"
    },
    "element_matches": {
      "type": "integer",
      "description": "The total number of elements matching the rule"
    },
    "originating_page_view": {
      "type": "string",
      "description": "The page view ID when the element was first observed"
    },
    "attributes": {
      "type": "array",
      "description": "Custom attributes extracted from the element"
    }
  },
  "required": [
    "element_name"
  ],
  "additionalProperties": false
}

Element statistics entity

The element_statistics entity contains information about element visibility and scroll depth.

element_statistics

Entity

Schema for element statistics

Schema URIiglu:com.snowplowanalytics.snowplow/element_statistics/jsonschema/1-0-0

Example

json
{
  "element_name": "article_content",
  "element_index": 1,
  "element_matches": 1,
  "current_state": "unknown",
  "min_size": "800x3928",
  "current_size": "800x3928",
  "max_size": "800x3928",
  "y_depth_ratio": 0.203,
  "max_y_depth_ratio": 0.493,
  "max_y_depth": "1937/3928",
  "element_age_ms": 298379,
  "times_in_view": 0,
  "total_time_visible_ms": 185000
}

Properties and schema

Table
JSON schema

Property	Description
`element_name` string	Required.
`element_index` integer	Optional.
`element_matches` integer	Optional.
`current_state` string	Optional.
`min_size` string	Optional.
`current_size` string	Optional.
`max_size` string	Optional.
`y_depth_ratio` number	Optional.
`max_y_depth_ratio` number	Optional.
`max_y_depth` string	Optional.
`element_age_ms` integer	Optional.
`times_in_view` integer	Optional.
`total_time_visible_ms` integer	Optional.

json
{
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
  "description": "Schema for element statistics",
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "element_statistics",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "type": "object",
  "properties": {
    "element_name": {
      "type": "string"
    },
    "element_index": {
      "type": "integer"
    },
    "element_matches": {
      "type": "integer"
    },
    "current_state": {
      "type": "string"
    },
    "min_size": {
      "type": "string"
    },
    "current_size": {
      "type": "string"
    },
    "max_size": {
      "type": "string"
    },
    "y_depth_ratio": {
      "type": "number"
    },
    "max_y_depth_ratio": {
      "type": "number"
    },
    "max_y_depth": {
      "type": "string"
    },
    "element_age_ms": {
      "type": "integer"
    },
    "times_in_view": {
      "type": "integer"
    },
    "total_time_visible_ms": {
      "type": "integer"
    }
  },
  "required": [
    "element_name"
  ],
  "additionalProperties": false
}

Element content entity

The element_content entity captures data extracted from a tracked element, including its position within a parent component hierarchy.

element_content

Entity

Entity describing the content of an element matching a named configuration.

Schema URIiglu:com.snowplowanalytics.snowplow/element_content/jsonschema/1-0-0

Example

json
{
  "parent_name": "product grid",
  "parent_index": 1,
  "element_name": "product card",
  "element_index": 3,
  "attributes": [
    {
      "source": "dataset",
      "attribute": "product_id",
      "value": "SKU-12345"
    },
    {
      "source": "content",
      "attribute": "price",
      "value": "$49.99"
    }
  ]
}

Properties and schema

Table
JSON schema

Property	Description
`parent_name` string	Required. The name of the configuration for the element/component that contains the element described by this entity.
`parent_index` integer	Required. The index of this element's parent element/component's within it's parent's other matches for it's element configuration.
`element_name` string	Required. The name of the configuration for the element/component that contains this data. This will usually match the corresponding element_name in an event payload or other entity.
`element_index` integer	Required. The position of this element's within it's parent's other matches for the element's configuration.
`attributes` array	Optional. Results of configured contents descriptions found on this element.

json
{
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
  "description": "Entity describing the content of an element matching a named configuration.",
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "element_content",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "type": "object",
  "properties": {
    "parent_name": {
      "description": "The name of the configuration for the element/component that contains the element described by this entity.",
      "type": "string",
      "maxLength": 255
    },
    "parent_index": {
      "description": "The index of this element's parent element/component's within it's parent's other matches for it's element configuration.",
      "type": "integer",
      "minimum": 1
    },
    "element_name": {
      "description": "The name of the configuration for the element/component that contains this data. This will usually match the corresponding element_name in an event payload or other entity.",
      "type": "string",
      "maxLength": 255
    },
    "element_index": {
      "description": "The position of this element's within it's parent's other matches for the element's configuration.",
      "type": "integer",
      "minimum": 1
    },
    "attributes": {
      "description": "Results of configured contents descriptions found on this element.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "description": "An individual contents description found on this element.",
        "type": "object",
        "required": [
          "source",
          "attribute",
          "value"
        ],
        "properties": {
          "source": {
            "description": "The type of content description that produced this result.",
            "enum": [
              "callback",
              "content",
              "selector",
              "dataset",
              "attributes",
              "properties",
              "child_text",
              "error"
            ],
            "maxLength": 40
          },
          "attribute": {
            "description": "The name of the discovered content attribute found.",
            "type": "string",
            "maxLength": 255
          },
          "value": {
            "description": "The value of the discovered content attribute found.",
            "type": "string",
            "maxLength": 2048
          }
        }
      }
    }
  },
  "required": [
    "parent_name",
    "parent_index",
    "element_name",
    "element_index"
  ],
  "additionalProperties": false
}

Component parents entity

The component_parents entity records the hierarchy of parent components that contain a tracked element.

component_parents

Entity

Entity describing the list of components that were found to contain the element with the named configuration.

Schema URIiglu:com.snowplowanalytics.snowplow/component_parents/jsonschema/1-0-0

Example

json
{
  "element_name": "add to cart button",
  "component_list": [
    "product grid",
    "product card",
    "card actions"
  ]
}

Properties and schema

Table
JSON schema

Property	Description
`element_name` string	Optional. Name of the element that this entity relates to, if any. If not provided, may apply to a subject of some other event, such as Link, Button, or Form Tracking events.
`component_list` array	Required. List of component names that were detected as containing the element that is the subject of this event.

json
{
  "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
  "description": "Entity describing the list of components that were found to contain the element with the named configuration.",
  "self": {
    "vendor": "com.snowplowanalytics.snowplow",
    "name": "component_parents",
    "format": "jsonschema",
    "version": "1-0-0"
  },
  "type": "object",
  "properties": {
    "element_name": {
      "description": "Name of the element that this entity relates to, if any. If not provided, may apply to a subject of some other event, such as Link, Button, or Form Tracking events.",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255
    },
    "component_list": {
      "description": "List of component names that were detected as containing the element that is the subject of this event.",
      "type": "array",
      "minItems": 1,
      "items": {
        "description": "Component name found to contain this element. This should match a component configuration name.",
        "type": "string",
        "maxLength": 255
      }
    }
  },
  "required": [
    "component_list"
  ],
  "additionalProperties": false
}

Button clicks​

button_click

Form interactions​

Focus form event​

focus_form

Change form event​

change_form

Submit form event​

submit_form

Page element visibility and lifecycle​

Events​

Create element event​

create_element

Expose element event​

expose_element

Obscure element event​

obscure_element

Destroy element event​

destroy_element

Element entity​

element

Element statistics entity​

element_statistics

Element content entity​

element_content

Component parents entity​

component_parents

Want to see a custom demo?

Button clicks

Form interactions

Focus form event

Change form event

Submit form event

Page element visibility and lifecycle

Events

Create element event

Expose element event

Obscure element event

Destroy element event

Element entity

Element statistics entity

Element content entity

Component parents entity