Wel­come to the start of the Web Ser­vices API Series. In part 1, I will describe what you can do with Omniture’s Report­ing API and what to pay atten­tion to.   So stick with me and you will soon learn how you can take advan­tage of this tool that gives you the power to enhance your report­ing experience.

What is Omniture’s Report­ing API?

Omniture’s report­ing API is an inter­face that will allow you to pro­gram­mat­i­cally con­nect to Site­Cat­a­lyst and pull reports.

Think of Site­Cat­a­lyst in the palm of your hand or on your desk­top, or any­where you want it to be and inside of any tool you can think of.  That is the report­ing API in a nut­shell, you pull reports and do with them any­thing you can imagine.http://blogs.omniture.com/wp-includes/js/tinymce/plugins/wordpress/img/trans.gif

Exam­ples to get your idea fac­tory running

Exam­ple 1:

You have an inter­nal por­tal and you want to dis­play Site­Cat­a­lyst reports so they are quickly acces­si­ble and do not require any­one to log into Omni­ture tools.  Well this is eas­ily solved with the report­ing API.  Build an inter­face and inte­grate it with your inter­nal por­tal and you quickly have almost any report you can imag­ine right at your fin­ger tips.

Exam­ple 2:

Let’s say you sub­scribe to Dale Carnegie’s meth­ods to influ­ence peo­ple and you want to impose a lit­tle com­pe­ti­tion inside your com­pany. Well one way you could do that is pull Site­Cat­a­lyst reports and dis­play them on a screen or on the front page of your inter­nal portal.

Exam­ple 3:

You use soft­ware to build reports for your com­pa­nies exec­u­tives.  Nor­mally, you would need to use the Excel client to pull the desired reports and import them into the soft­ware on a reg­u­lar basis.  Well, assum­ing the soft­ware has some type of appli­ca­tion inter­face you can pull reports from Omni­ture and import them auto­mat­i­cally into your report­ing software.

Get­ting Started

The Report­ing API is a pro­gram­matic solu­tion, so you will need a devel­oper if you don’t know how to code.  Also, if you are short on resources you can request Omniture’s Engi­neer­ing Ser­vices team to build the solu­tion for you.  Just con­tact your Omni­ture Account Man­ager and they will get the process started.

First step is to set up your web ser­vices accounts. Go into Site­Cat­a­lyst then go to Admin > Admin Con­sole.  Then click User Access, then Groups, finally Web Ser­vice Access. Book­mark it so you can eas­ily find it again. Inside this inter­face you can add users to the Web Ser­vices Access group.  This will allow that user to pull reports from the report­ing API.  (Warn­ing: giv­ing some­one access to web ser­vices gives them the abil­ity to use all web ser­vices func­tions which include admin­is­tra­tive functionality.)

Next step get your Web Ser­vices API User­name and Shared Secret.   First, you want to go into Site­Cat­a­lyst then go to Admin > Admin Con­sole.  Then in the menu on the left you go Admin Con­sole > Com­pany.  And finally you click Web Ser­vices.  This inter­face will dis­play the num­ber of tokens each user has used and how many tokens your com­pany has left.  This is also where you will get the user­name and shared secret you or your devel­oper will use to access the APIs.


devel​oper​.Omni​ture​.com — This is your one stop loca­tion for tons of infor­ma­tion related to Omniture’s APIs.   Here you will find exam­ple code and all the meth­ods that are offered.

Code Gallery — Part of devel​oper​.Omni​ture​.com.  Is a loca­tion for a ton of pre­built solu­tions that uti­lize Omniture’s APIs.

Here are some of the solu­tions you can find in the code gallery that use the report­ing api.

Daily Time PartingMy team mate Mark Hei­d­brink and I built one of the solu­tions called Daily Time Part­ing.  It is desk­top graph­ing pro­gram that allow you to graph reports side by side.  It’s main ben­e­fits are the usage of C# and a sim­ple exam­ple that any devel­oper should be able to down­load and run with­out hav­ing to code any­thing.
Geo MoneySean Gubler, Aaron Wil­son and Nate Purser are three mem­bers of my team that built the Geo Money web appli­ca­tion that is not only nice to look at but also a great way to com­pare met­rics across the United States.  This inter­ac­tive flash appli­ca­tion will allow you to com­pare con­ver­sion state by state and see the effec­tive­ness of your sales at a glance.

As always, post your com­ments or e-mail me at pau­rigemma (at) omni​ture​.com.  It is your com­ments and e-mails that keep me post­ing and give me ideas for future posts.  If you do decide to pur­chase an Engi­neer­ing Ser­vices solu­tion, make sure you men­tion the blog and you will get white glove treat­ment.

Bill White
Bill White

Does the SiteCatalyst Reporting API now include Video metrics? SC version 14 now gives Video reporting (video views, daily unique video viewers, etc.) but I need to enhance my API-based application with these video reports. Is this possible? -- Bill