More APIs (Administration)

It’s yet another “5 Tuesdays” month. Since I have ridden mobile to death by now, I thought I’d give you a very short post around my other favourite subject: APIs.

Enterprise API

Starting off, I’d like to point you to the Enterprise API Overview documentation on the Developer Connection.

It has a nice graphic that shows you where the different APIs sit or what they can do for you. It also has entry points for each individual API, which is a) practical for you and b) a good hook for me to line up articles against.

There are two (plus one) APIs that allow you to push data into SiteCatalyst Reports & Analytics and two for pulling data back out. I have so far only written about one of those 4 (5), so lots of potential.

Admin API

But today I want to introduce yet another API: the Analytics Administration API.

That API can be used to automate some of the administrative aspects of working with Adobe Analytics. Biggest one being users and permissions, I guess.

(Note: if you have previously worked with this API, make sure you read about the Changes in 1.4!)

Let’s go through the different possibilities.

Bookmarks

The API gives you access to Bookmarks and Dashboards that users have set up. “Access” in this case meaning you can find out how many they have. For Bookmarks, you can also get the complete ReportDescription, which is rather cool because it allows you to run the same report against the Reporting API!

Use case: surprise a key user with a beautifully rendered, auto-updating screen of one of their beloved reports.

Take a look at Bookmark.GetReportDescription for parameters.

Company

A couple of methods that deal with access to the API and report suite management.

I’d like to point out Company.GetLoginKey, which allows you to get a login key for a specified user, which you could then use to query the Reporting API as that user.

And Company.GetReportSuites will return a list of all existing report suites in the account, which you can use to let users of your tool select one, if you want.

Permissions

The documentation says “Use the Permissions methods to create, edit, and delete Users and Groups in the Marketing Cloud” and there is not much to add.

These methods are highly valuable if you are in a big organisation and the users that look at Analytics data fluctuate or should simply be tied to your own credentials system. One obvious option is to use SSO, but you can also handle creation od users and permissions via the methods in this section of the API.

Take a look at Permissions.AddLogin, Permissions.SaveLogin, Permissions.DeleteLogin and the various methods dealing with groups.

To point out one method: Permissions.GetLogins allows you to pull a list of all existing users. You can provide a search parameter which allows you to filter the results you’ll get back, say by last name.

Report Suite

Last but not least, there is a bunch of methods that allow you to manipulate all sorts of things around report suites. The list is actually too long to fit on one screen (at least on mine). Pretty much every single setting that your friendly marketer can access in the Admin Console has an equivalent Getter and Setter here.

To mention but a few that you might start with:

Using ReportSuite.GetClassifications you can query the classifications setup on all variables in a given report suite. This is helpful if you want to use the SAINT Classifications API and make sure you classify the right thing.

The methods ReportSuite.GetEvars, ReportSuite.GetEvents, ReportSuite.GetProps and GetListVariables allow you to retrieve information about the setup of all custom variables for a report suite. You could use this to a) make sure your custom reports pull the right data, and b) let users select the data they want to see in a tool you write.

Using ReportSuite.GetProcessingStatus you can find out whether processing of data is looking ok or whether there is some unduly latency.

If you want to work with real time reports, take a look at ReportSuite.GetRealTimeSettings.

ReportSuite.GetSegments lets you retrieve the segments for a report suite. Useful for both, reporting as well as segment management.

Needles to say all these Getters have a corresponding SaveXYZ method, so you can actually change the setup. Make sure your friendly marketer knows that you’re changing things, otherwise she might no longer be friendly.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s