A while back, I dis­cussed Suc­cess Events which are part of the Con­ver­sion area of Omni­ture Site­Cat­a­lyst.  More recently, in the Prod­ucts Vari­able post, the term Incre­men­tor Event sur­faced.  In my expe­ri­ence, many Omni­ture clients are not famil­iar with Incre­men­tor Events, so I thought I would spend a few min­utes explain­ing what Incre­men­tor Events are and how they can be used.

Under­stand­ing Incre­men­tor Events
I find that the most dif­fi­cult part of under­stand­ing Incre­men­tor (you may also see it referred to as Incrementer) Events is get­ting over their name!  I am not sure how the name came to pass, but I find it con­fuses many clients so I pre­fer to sim­ply focus on what they do, mem­o­rize the name and move on!  The pur­pose of Incre­men­tor Events is to pro­vide a way to pass a cur­rency or numeric value of your choos­ing to a Suc­cess Event as a met­ric.  For those of you who have been read­ing the blog for a while, you will know that nor­mal (Counter) Suc­cess Events move up one value (notice I resisted the urge to say incre­ment!) each time the Suc­cess Event is set.  For most Key Per­for­mance Indi­ca­tors (KPIs) that is what you want to hap­pen, but there are times when you want to pass a numeric value to Omni­ture so that it can be totaled as a met­ric in reports and in cal­cu­lated met­rics.  This func­tion­al­ity is sim­i­lar to what clients use the Rev­enue met­ric for through the use of the pur­chase event.

So when would you want to use an Incre­men­tor Event?  In the Prod­ucts Vari­able post we saw an exam­ple where the client wanted to cap­ture a Ship­ping Cost asso­ci­ated with an order sep­a­rate from the Rev­enue met­ric.  The fol­low­ing are some other exam­ple uses of Incre­men­tor Events:

  • Pass Tax infor­ma­tion as a dis­tinct met­ric from Revenue
  • Cap­ture a Dis­count Amount as a dis­tinct met­ric from Revenue
  • Cap­ture a page value or score
  • Pass esti­mated Adver­tis­ing Impres­sion Rev­enue to an “Ad Rev­enue” met­ric sep­a­rate from Rev­enue gen­er­ated by prod­uct sales

Enabling Incre­men­tor Events
So how do you enable Incre­men­tor Events?  Like other Suc­cess Events, you enable Incre­men­tor Suc­cess Events through the Admin­is­tra­tion Con­sole.  Sim­ply open the Suc­cess Events def­i­n­i­tion page, click the “Add New” link after your last Suc­cess Event, enter a Suc­cess Event name and then choose the Event Type drop-down box as shown here:

When select­ing the Event Type, even though there are sev­eral choices, the main ones used are Counter, Cur­rency and Numeric (for now, you can ignore the options with no sub­re­la­tions).  Counter Events are the default and used for most Suc­cess Events.  Incrementor Events are cre­ated when you select either Cur­rency or Numeric.  As the names indi­cate, you select Cur­rency if the val­ues you will be pass­ing are related to Cur­rency, oth­er­wise you select Numeric.  The only dif­fer­ence between the two is that Cur­rency Incre­men­tor Events have the Cur­rency set­tings asso­ci­ated with the report suite applied to them (i.e. show local­ized cur­rency sym­bol in reports and have cur­rency con­ver­sion applied if appropriate).

Impor­tant Things To Know About Incre­men­tor Events
The fol­low­ing are some impor­tant things to know about Incre­men­tor Events:

  1. Incre­men­tor Events are nor­mally set from within the Prod­ucts Vari­able (see pre­vi­ous post for syntax)
  2. Most met­rics passed into the Con­ver­sion area through Data Sources are passed to Incre­men­tor Events (I will cover Data Sources in an upcom­ing post)

Real-World Exam­ple
In this week’s real-world example, we will show how a bank­ing sub­sidiary of Greco Inc. uses an Incre­men­tor Event.  In this sce­nario, the bank would like to under­stand the value of home loan mort­gages site vis­i­tors are request­ing so they can com­pare it to the loan amounts that are ulti­mately pro­vided.  For exam­ple, if it is the case that the bank con­sis­tently ends up loan­ing out 79% of the amount of home loans that are requested online, it can use this infor­ma­tion for future estimates.

Dur­ing the loan appli­ca­tion process, appli­cants fill out a form and are required to enter a loan amount as shown here:

Greco Inc. would set-up an Incre­men­tor Suc­cess Event (Cur­rency) as shown above and use the Prod­ucts Vari­able to pass the Requested Loan Amount to the Incre­men­tor Event using the fol­low­ing syntax:

Now that the Requested Amount val­ues have been cap­tured in an Incre­men­tor Suc­cess Event, the bank is ready for step two in which they import the actual amount of loans that were made to cus­tomers.  Since the actual Loan Amount is not known dur­ing the online session, Greco Inc. uses Omni­ture Site­Cat­a­lyst Data Sources which is a tool that can be used to import non-website met­rics into Site­Cat­a­lyst (I will cover Data Sources in greater detail in a future blog post).  For now, all you need to know is that Greco Inc. will import all closed loan amounts and asso­ciate them with the Prod­uct for which the loan amount is related.  As was men­tioned above, met­rics imported through Data Sources must be set-up as Incre­men­tor Events so Greco Inc. would cre­ate a sec­ond Incre­men­tor Event (Cur­rency) and then use Data Sources to upload the data.

When all of this is com­pleted, Greco Inc. can cre­ate a cal­cu­lated met­ric that divides the two Incre­men­tor Event met­rics and then view all three met­rics by Prod­uct in the Prod­ucts report as shown here:

Have a ques­tion about any­thing related to Omni­ture Site­Cat­a­lyst?  Is there some­thing on your web­site that you would like to report on, but don’t know how?  Do you have any tips or best prac­tices you want to share?  If so, please leave a com­ment here or send me an e-mail at insidesitecatalyst@​omniture.​com and I will do my best to answer it right here on the blog so every­one can learn! (Don’t worry — I won’t use your name or com­pany name!).  If you are on Twit­ter, you can fol­low me at http://​twit​ter​.com/​O​m​n​i​_​man.

Learn more about Omni­ture Consulting
Learn more about Omni­ture University
6 comments
Ketav Sharma
Ketav Sharma

Wonderful  post.


I was just wondering what is the right way of capturing different type of revenue on site. For example some guys are taking loans other might be adding funds some others are doing say some x activity.


Now i am thinking of using a prop to capture the type of activity ( loan ,deposit, credit card payment and prepaid cards) and different events for all different activities, Is it the right way to tackle this scenario or do you have some other better approach for it.

Ben Gaines
Ben Gaines

Lucas: There are two options here; I've seen both of them used successfully, although I do have a preference. The first option is to divide the discount or shipping amount across all of the products in the order, as you've suggested. For example, a $10 discount could be applied like this: s.products=";prod1;5;20.00;event1=5,;prod2;3;15.00;event1=5" However, keep in mind that SiteCatalyst is going to associate $5 with each product when the event1 metric is pulled into the Products report. That may or may not be what you have in mind. My preference is option number two, which is to create a separate product to receive full credit for the discount. For example: s.products=";prod1;5;20.00,;prod2;3;15.00,;discount;;;event1=10" This will tie $10 of discount (event1) to the "discount" product, which will show up as a separate line item in your Products report.

Lucas Schultze
Lucas Schultze

All the examples I've seen here and in the Products post use a single product as an example. What do you do when you have multiple products to split a value across? So if you have Shipping or a discount, do you attach those events to each product? If shipping was 5 dollars total and there are 3 products in that order, would attaching 5 dollars to each populate the event by 15 total? Same with a discount of 10% off an entire order total. Do you attach the total discount to every product ordered, or do you divide the discount by the number of product and use that result instead? Thanks for you help.

ngan hang
ngan hang

Hi Adam Your post is nice, thanks so much for sharing.

Adam Greco
Adam Greco

Paul-While you do have to use the Products string to set Incrementor events, they do not have to be tied to the Products report.

Paul A
Paul A

Do Incrementor Events have to be associated with the products report?