Web Services API Series — SAINT API, Your New Best Friend
Welcome to the second post in the Web Services API Series. Here I will describe what you can do with the SAINT API and what to pay attention to. So stick with me and you will soon learn how you can take advantage of this tool that gives you the power to enhance your reporting experience.
What is SAINT?
SAINT is the tool for uploading classifications of data. In other words, it is a method for you to upload metadata to provide more detailed information about data in SiteCatalyst. For example, you can classify a product with the products color, size, shape, weight, etc. with SAINT.
What is the SAINT API?
The SAINT API is an interface for you or developers at your company to interface with Omniture and build automatic classifications. Let’s look at some examples.
Let’s say you want to classify keywords into branded and un-branded or product and general, but you have over 10,000 paid and natural search keywords. Now that new intern might be kind of annoying and you want to give him a task that will keep him busy for a long LONG time. If you do that, who will get you coffee in the morning?
We have a solution for your coffee problem. Naturally, your keywords will have some pattern to them, such as your brand name, product name or branch name. So you use these patterns to classify your keywords programmatically and then use the SAINT API to upload the data into SiteCatalyst. It will take you less time to program it than it would to classify half of the keywords and you can use the same programming logic over and over again.
You are importing data into SiteCatalyst such as offline data or data from another company.
When you are uploading data into Omniture, most of the time you don’t need to upload all the possible data points into traffic variables (s.props) and conversion variables (eVars). You can use the SAINT API to upload classifications on that data, which will save you variables and allow you to change the data retroactively.
You are importing micro blogging **cough**cough**twitter**cough**cough** data into SiteCatalyst.
Ok… it is no secret, the Twitter integration uses the SAINT API but it is worth noting that with the Twitter integration you get tons of reports and you only ever data source in the Twitter ID. Everything else is based off of classifications!
Benefits of the SAINT API
You will be able to know exactly when the classifications are uploaded so you can then pull the associated reports knowing the classifications are done processing. Also, you can upload classifications for more than one report suite in single request.
Things to know
- Omniture’s Engineering Services Team can provide consulting for the SAINT API and all other Omniture APIs. If you would like a resource to help you get started to advance your current setup, then contact your account manager and they will point you in the right direction.
- You will need to set up one of your user accounts to have Web Services Access ( See Getting Started below). My suggestion is to create a unique user for each application; it makes it easier to keep track of how many tokens an application is using.
The SAINT API is a programmatic solution, so you will need a developer. First step is to set up your web services accounts. Go into SiteCatalyst then in the upper right hand corner of the page go to Admin > Admin Console. Then click Manage User Access, then Edit Groups, finally Web Service Access. Inside this interface you can add users to the Web Services Access group. This will allow that user to pull reports from the reporting API. (Warning: giving someone access to web services gives them the ability to use all web services functions which includes administrative functionality.)
Next step, get your Web Services API Username and Shared Secret. First, you want to go into SiteCatalyst then in the upper right hand corner of the page go to Admin > Admin Console. Then in the menu on the left you go Admin Console > Company. And finally you click Web Services. This interface will display the number of tokens each user has used and how many tokens your company has left. This is also where you will get the username and shared secret you or your developer will use to access the APIs.
developer.Omniture.com — This is your one stop location for tons of information related to Omniture’s APIs. Here you will find example code and all the methods that are offered.
Code Gallery — Part of developer.Omniture.com. Is a location for a ton of prebuilt solutions that utilize Omniture’s APIs.
As always, post your comments or e-mail me at paurigemma (at) omniture.com. It is your comments and e-mails that keep me posting and give me ideas for future posts. If you do decide to purchase an Engineering Services solution, make sure you mention the blog and you will get white glove treatment.