Event Reference (v1) / Cta Events
CTA Click / cta_click
Measures when a user clicks an intentionally styled element (usually a link, but sometimes not) that is meant to grab a users attention (e.g. take action).
This event is not meant to measure generic link click activity on a given page or screen. It is reserved for visual calls-to-action like buttons, inline-callouts, banners etc... Generic link click activity is not something we recommend measuring, as it will massively inflate your event count, and not provide much value to an analyst.
-
- Name
- Event Name Required
- Value
- event: cta_click
CTA Properties
These properties apply to all cta_* events.
-
- Name
- CTA Keyword Optional
- Type
- cta_keyword: string
- Description
Used to combine common or similar calls-to-action together for analysis. For example, if you have many 'Demo' buttons with slight variations in text like 'Book a Demo', 'Schedule a Demo', 'Get a Demo' etc... you could use the common keyword 'demo' to group all of these together for analysis.
- E.g.
button
Component Properties
Component properties that apply to all component related interactions. As such, these properites are meant to be generic and provide context to where user interactions are occuring on a page.
-
- Name
- Component Optional
- Type
- component: string
- Description
The name of the component that the event occurred directly on. This is usually something interactive, not a presentation element.
- E.g.
button:arrow
-
- Name
- Component Parent Optional
- Type
- component_parent: string
- Description
The name of the parent component that the event occurred within. This could be a container, form, card, or any other named/defined parent component of a page.
- E.g.
card
Section/UI Properites
These properties can be applied to any event to provide more contextual information about "where" an interaction occured within a given page.
-
- Name
- Section Name Optional
- Type
- section_name: string
- Description
More specific than
ui_location, this property can be used to describe the name of a section or container that the event occurred within.- E.g.
recent posts
-
- Name
- UI Location Optional
- Type
- ui_location: string
- Description
The name of the section or container that the event occurred within. This could be a sidebar, header, footer, or any other named/defined section of a page.
- E.g.
sidebar
Link Properties
These properties apply to many *_click events.
-
- Name
- Link URL Required
- Type
- link_url: string
- Description
The
hrefattribute of the link that was clicked. The value should be a fully qualified URL.- E.g.
https://www.level.agency/contact/#form
-
- Name
- Link Domain Required
- Type
- link_domain: string
- Description
The hostname of the link that was clicked. This can be useful for grouping links by domain.
- E.g.
www.level.agency
-
- Name
- Link Path Required
- Type
- link_path: string
- Description
The path of the link that was clicked. This can be useful for grouping links by path.
- E.g.
/contact/
-
- Name
- Link Fragment Required
- Type
- link_fragment: string
- Description
The fragment identifier of the link that was clicked. This can be useful for analyzing clicks on anchor links that point to a specific section of a page.
- E.g.
form
-
- Name
- Link Text Required
- Type
- link_text: string
- Description
The text (innerText) of the link that was clicked. It's recommended to lowercase this value for easier analysis.
- E.g.
Contact Us
-
- Name
- Outbound Link Optional
- Type
- outbound: boolean
- Description
A boolean value indicating if the link is an outbound link (i.e. it goes to a different domain).