events

Dimensions and metrics are vital components to reports. The events variable is responsible for data collection of many metrics on your site. Events typically increment metrics in reports.

Before implementing events, make sure that you create and configure them under Success events in Report suite settings. If you plan to use custom events in link tracking hits, make sure that linkTrackVars and linkTrackEvents are set correctly.

Events using the Web SDK

If using the XDM object, custom events use the following XDM fields:

If using the data object, all events use data.__adobe.analytics.events, following AppMeasurement string syntax. If you set this field, any events set in the XDM object are overwritten and not sent to Adobe Analytics.

Events using the Adobe Analytics extension

You can set events either while configuring the Analytics extension (global variables) or under rules.

Several features are available:

s.events in AppMeasurement and the Analytics extension custom code editor

The s.events variable is a string that contains a comma-delimited list of events to include in the hit. The variable allows up to 64k bytes, effectively allowing as many events as a hit needs. Valid values include:

// Set the events variable to a single value
s.events = "event1";

// Set the events variable to multiple values
s.events = "event1,event13,purchase";

Increment counter events multiple times

You can count custom events more than once if desired. Assign an integer to the desired event within the string. Events created in report suite settings are counter events by default.

// Count event1 ten times
s.events = "event1=10";

// Count event1 twice and event2 once
s.events = "event1=2,event2";

Use currency events

You can change a custom event to use currency instead of integers. Currency events automatically convert to the report suite’s currency if the report suite currency and the currencyCode variable do not match. They are useful to help calculate shipping costs, discounts, or refunds. You can set currency events in the products variable if you want to attribute the event to only that product.

Before implementing currency events, make sure that you set the desired event to ‘Currency’ under Success events in Report suite settings.

// Send $9.99 USD in event1 using the events variable. Make sure the event type for event1 is Currency in Report suite settings
s.currencyCode = "USD";
s.events = "event1=9.99";

// Send $9.99 USD in event1 using the products variable. Make sure the event type for event1 is Currency in Report suite settings
s.currencyCode = "USD";
s.events = "event1";
s.products = "Example category;Example product;1;0;event1=9.99";

Use numeric events

You can change a custom event accept decimal values instead of integers. Numeric events behave similarly to currency events, except they do not use currency conversion. You can set numeric events in the products variable if you want to attribute the event to only that product.

Before implementing numeric events, make sure that you set the desired event to ‘Numeric’ under Success events in Report suite settings.

// Send 4.5 in event1 using the events variable. Make sure the event type for event1 is Numeric in Report suite settings
s.events = "event1=4.5";

// Send 4.5 in event1 using the products variable. Make sure the event type for event1 is Numeric in Report suite settings
s.events = "event1";
s.products = "Example category;Example product;1;0;event1=4.5";