Skip to main content

Event Object Structure

When the user interacts with RateParity, it pushes event data into the dataLayer object. This data includes comprehensive information about user interactions with the app's interactive elements, allowing developers to track and analyze user behavior effectively. Below is the structure of an event object:

{
event: "rp_filter",
action: "click",
category: "option",
label: "Offers rating filter",
transaction_id: "",
container: "offer",
view: "main",
section: "side",
data: {
filters: { rating: 8, season: 'summer' }
}
}

Properties

PropertyTypeDescriptionExample
eventstringGeneric event name, used for capturing the event in GTM'rp_filter' for a filter application event.
actionstringDescribes the specific way the user interacted with the element, such as click, submit, or hover.'click' indicates a click action.
categorystringSpecifies the type of element interacted with, like a button, link, option etc.'option' for a select option interaction.
labelstringProvides a brief, human-readable description of the event.'Go to checkout' as a summary of the interaction.
containerstringA unique name for the module of the app where the action was triggered.'offer'
viewstringIndicates the view/page of the module where the action was triggered.'main'
sectionstringIndicates the section inside the view where the interaction took place.'side'
dataobjectHolds additional information related to the user action, such as form data or applied filters.{ filters: { season: 'summer' } }