⦿ Adobe Analytics API Guide

ACCESSING THE ADOBE ANALYTICS CONNECTOR

To access your Adobe Analytics account using our connector, you must link your credentials first.

To find your Adobe Analytics login details (username and secret), follow the steps below:

  • Log in to Adobe Analytics

  • click on the Account Profile icon > Edit Profile in the top right corner of the screen

  • On the Account Information page, under Web Services, you’ll see the Username and Shared Secret. If you don’t see it, ask someone with Admin rights to give you access to Web Services.

In order to use the Adobe Analytics connector, your Adobe account needs to be API-enabled by the account admin. Here's a screenshot that should help your admin enable your Adobe account.

 

ADOBE ANALYTICS API LIMITATIONS 

  • The Adobe API is really slow. Feel free to write a message to Adobe’s Client Care and ask them to put more power behind their API.

  • Certain metrics may only be requested along with certain elements (dimensions)

  • Elements (dimensions) have restrictions on which other elements (dimensions) they can be combined within a report

  • The maximum number of top elements that can be requested is 50,000

  • A report may have a maximum number of three or four elements (dimensions)

For more info regarding the Adobe API, please refer to their documentation.

 

ADOBE ANALYTICS API REPORTING 

*Adobe Analytics API documentation refers to dimensions as 'elements'.

To find calculated metrics from your Adobe Analytics account in the connector drop-down menu, make sure they’re shared with everyone in your Adobe Analytics account.

Certain metrics may only be requested along with certain dimensions, and dimensions can only be queried with certain dimensions.

The tables below help you build a valid API query.

The following elements (dimensions) can only be queried with the metrics in the right column.

Element (dimension)

Metric Whitelist

Fallout

Pageviews

Videos

Cart Additions, Cart Removals, Carts, Cart views, Checkouts, Orders, Revenue, Units, Event

 

The following elements(dimensions) can be queried with any metric except for those that appear in the right column.

Element (dimension)

Metric Blacklist

Browser Height

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video start, Video time, Event, Participation Event

Browser Type

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Browser Width

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Connection Type

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Cookies Enabled

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Geo City

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Geo Country

Average Page Depth, Averaged Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Geo DMA

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Geo Region

Average Page Depth, Averaged Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Java Enabled

Average Page Depth, Average Time Spent On Page, Video Complete, Videosegmentviews, Video Start, Video Time, Event, Participation Event

Javascript Enabled

Average Page Depth, Averaged Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Javascript Version

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Listvar

Instances

Mobile Carrier

Video Complete, Video Segment Views, Video Start, Video Time

Monitor Color Depth

Average Page Depth, Average Timespentonpage, Video Complete, Videosegmentviews, Video Start, Video Time, Event, Participation Event

Page Depth

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Pages Not Found

Average Page Depth, Averaged Timespentonpage, Cart Additions, Cart Removals, Carts, Cart views, Checkouts, Orders, Participation Revenue, Participation Units, Reloads, Revenue, Units, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Prop

Average Timespentonsite, Average Visit Depth, Bots, Total Cart Additions, Total Cart Removals, Total Carts, Total Cart Views, Total Checkouts, Total Orders, Total Page Views, Total Revenue, Total Units, Total Visitors Daily, Total Visitors Hourly, Total Visitors Monthly, Total Visitors Quarterly, Total Visitors Weekly, Total Visitors Yearly, Total Visits, Video Segment Views, Visitors New, Total Event

Referrer

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Referrer Type

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Return Frequency

Average Page Depth, Average Time Spent On Page, Video Complete, Video Segment Views, Video Start, Video Time, Event, Participation Event

Search Engine Paid

Instances

Search Engine Paid Keyword

Instances

Server

Average Time Spent On Site, Average Visit Depth, Bots, Total Cart Additions, Total Cart Removals, Total Carts, Total Cart Views, Total Checkouts, Total Orders, Total Page Views, Total Revenue, Total Units, Total Visitors Daily, Total Visitors Hourly, Total Visitors Monthly, Total Visitors Quarterly, Total Visitors Weekly, Total Visitors Yearly, Total Visits, Video Segment Views, Visitors New, Total events

Site Section

Single Access

Survey Base

Instances

Tnt Base

Instances

 

ADOBE ANALYTICS API ERRORS

If you run into an error message when submitting a query, feel free to contact us on our website through our chat box, in the lower right corner.

We'll get back to you in one business day.

Send us your error message, along with the specifics of your issue (screenshot of the complete query that generated the error) so we can replicate the error and troubleshoot it.

The following adjectives in error codes have specific meanings:

Adjective

Meaning

invalid

The provided value is wrong in some way. If the user changes it, things will work.

missing

A required value is missing. If the user provides it, things will work.

inaccessible

The user doesn't have permission to access the feature.

unsupported

The particular functionality requested is not supported at this time. It may be supported in the future.

unavailable

The feature requested isn't available. The user can usually fix this but not by changing the report description.

failure

The system has failed and it's not the user's fault.

For more info regarding the 1.4 API Error messages, please refer to Adobe’s documentation.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request