The variable is used to record common shopping cart success events as well as custom success events.
|Max Size||Debugger Parameter||Reports Populated||Default Value|
Shopping Cart Events
An event should be considered a milestone within a site. Success events are most commonly populated on the final confirmation page of a process, such as a registration process or newsletter sign-up. Custom events are defined by populating the events variable with the literal values defined in the Possible Values section below.
By default, success events are configured as counter events. Counter events count the number of times a success event is set (x+1). Events can also be configured as numeric events. Numeric events allow you to specify the number to increment (as might be necessary when counting dynamic or arbitrary values, such as the number of results returned by an internal search).
A final event type, currency , allows you to define the amount to be added (similar to numeric events), but displays as currency in reports, and is subject to currency conversions based on the s. currencyCode value and the default currency setting for your report suite. For additional information on using numeric and currency events, see Products .
Configuring the Variable
The s.events variable is enabled by default for all implementations. The seven pre-configured conversion events are automatically enabled for all new report suites. New custom events (event1- event100 or event1000 ) can be enabled by any admin-level user using the Admin Console.
The following is a list of possible values for the events variable:
Open / Initialize a new shopping cart
Add item(s) to the shopping cart
Remove item(s) from the shopping cart
View shopping cart
Beginning of the checkout process
Completion of a purchase (order)
event1 - event1000 (event100 for point product)
Syntax and Examples
Counter events are set by placing the desired events in the s.events variable, in a comma-separated list (if multiple events are to be passed).
If on H23 code or higher, counter events can have integers greater than one assigned to them.
Implementing counter events with assigned integer values treat the event as if it fired multiple times within the image request. Counter events do not allow decimals- it is recommended to use numeric events instead if this functionality is required. Numeric and currency events must be included in the s.events variable, though they typically receive their numerical value (e.g., 24.99) in the s.products variable. This allows you to tie specific numeric and currency values to individual product entries.
By default, an event is counted every time the event is set on your site.
See Event Serialization for more information.