Quick tip: Reporting API & Bookmarks

Somewhere, not long ago, in an office, not far away, friendly marketer met developer. The following dialog took place:

Friendly Marketer: hey, about that custom report display…

Developer: the one using the Adobe Reporting API?

FM: yup. I still owe you an exact description of the report… so I sat down yesterday and tried to get the data in the right format out of Adobe Analytics like the Webanalytics for Developers blog says. I got pretty close. Can I show you and can we discuss?

Dev: sure

FM: I bookmarked my report, so just drop by whenever you have time, and I …

Developer: you bookmarked it? What’s the name of the bookmark?

FM: uh… “report for display”, I think, why?

Developer: no need to talk then anymore. You’ll have a prototype by the end of the week.

FM: really? cool!

Bookmarks

Did you know that the API gives you access to Bookmarks?

And that you can actually download a ReportDescription for a Bookmark out of that API which you can plug straight into the Reporting API?

Oh yes.

Let me show you, using the API Explorer and a bookmark called “Blog eComm Funnel” (I might write about that at some point).

Go log into the API Explorer.

Step 1 – Find the Bookmark

So we have the name of the Bookmark, but we need the ID. Easy:

[Screnshot]
Step 1 – API Request
Run it, and:

[Screenshot]
Step 1 – API Response

Step 2 – Get the ReportDescription

Just use the GetReportDescription method and copy the ID you got in step 1:

[Screenshot]
Step 2 – API Request
Run it, and:

[Screenshot]
Step 2 – API Response
That’s it.

Notes

The ReportDescriptions you get back include everything you need, including Segment IDs if the report has a segment applied.

Here is one more example of a ranked report with a filter:

[Screenshot]
API Response – Ranked Report with Filter
You might also get this:

[Screenshot]
API Response – Bookmark not Supported
Remember how not all Analytics reports are available in the Reporting API? You probably tried to pull a ReportDescription for one of those that aren’t.

In that case you will have to go back to your friendly marketer and work out another way of getting the data she needs.

If your friendly marketer built a Dashboard instead of making a Bookmark, you have a couple of options as well.

The GetDashboards method returns a structure that describes the content of each Dashboard. A lot of the content is actually handled similarly to Bookmarks, so you could use the bookmark IDs you get out of this report as well.

Now this should make it a lot easier for you and your friendly marketer to specify what exactly she wants.

P.S.: it feels wrong to dedicate something as profane as a blog post to a man who made such an impact in the world. LLAP.

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