Skip to main content
waffle.svg
Domo Knowledge Base

Adobe Analytics Realtime Connector

Version 11

 

Intro

Turn insights into real-time, data-driven responses with Adobe Analytics Realtime. Use Domo's Adobe Analytics Realtime Connector to retrieve data from a selected Adobe Analytics Report Suite. To learn more about the Adobe Analytics API, visit their website (https://marketing.adobe.com/developer/en_US/get-started/introduction/c-introduction ).

You connect to your Adobe Analytics account in the Data Center. This topic discusses the fields and menus that are specific to the Adobe Analytics Realtime connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

Prerequisites

To connect to Adobe Analytics v2 and create a dataset, you must create an Adobe Analytics Service Account (JWT) project in the Adobe Developer Console and provide the following:

  • Client ID (API Key)
  • Client Secret

  • Technical Account ID

  • Organization ID

  • Private Key for your Adobe integration in PEM format

Creating a new OAuth project in Adobe Developer Console

To create a new project in Adobe Developer Console, do the following:

  1. Log into https://console.adobe.io/projects.
  2. Click Create new project button.

clipboard_ef81dc4702e9ec901a750b1daefa4f685.png

3. Click on Add API to start using the Adobe services.

clipboard_e9fa4bfa5ba02957d8e4ca627dca3f9c2.png

4. The APIs available to you will be listed in the Add an API window. Select Adobe Analytics

clipboard_e30473dadccfa45b21d3f59a8e48b5052.png

5. Now, you need to select the authentication type. Select Service Account (JWT) here.

clipboard_e0811478a601e379f270fc8a3b7eef542.png

6. Select Generate a key pair and click Next.

clipboard_ec04827cda14dfb1165cdd61e2bfed68b.png

7. A new key pair will be generated and downloaded to your system. The public key will be uploaded to your JWT project. The private key will be downloaded.

clipboard_e65ebb69a12cf56217141df856f205ee1.png

8. Unzip the file "config.zip", open the directory "config", and open the file "private.key" with a basic text editor. This is the Private Key you will paste into Domo, in Credentials section.

9. Now, click Next.

10. Select the desired product profiles, then click Save Configured API.

11. This takes you to the Project APIs and Services page. If you scroll down, you will see the Client ID, Client Secret, Technical Account ID and Organization ID that you will use to create the Adobe Analytics JWT account in Domo.

clipboard_ea325480b3973555fffe80bb393e6d94c.png
12. (Optional) Rename the project to something you will recognize later. Navigate to the Project Overview page, then click Edit Project.

Connecting to Your Adobe Analytics Realtime Account

This section enumerates the options in the Credentials and Details panes in the Adobe Analytics Realtime Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

This pane contains fields for entering credentials to connect to your Adobe Analytics Realtime account. The following table describes what is needed for each field:  

Field

Description

Client ID (API Key) Enter your client ID.
Client Secret Enter your client secret.
Technical Account ID Enter your technical account ID.
Organization ID Enter your organization ID.
Private Key Paste the private key for your Adobe integration here, in PEM format.

Once you have entered valid Adobe Analytics Realtime credentials, you can use the same account any time you go to create a new Adobe Analytics Realtime DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

Details Pane

This pane contains two primary menus, Report Suite and Report Type, along with various other menus which may or may not appear depending on the report type you select.

Menu

Description

Company Enter your company's name as featured on Adobe Analytics, which is used as a parameter for the Company.GetEndpoint method (see https://github.com/AdobeDocs/analyti...GetEndpoint.md)

Report Suite

Select the Adobe Analytics Report Suite you want to pull data from.

Report Type

Select a report type. The report type determines the set of inputs needed to configure the DataSet.

Report types are as follows:

Intermediate - Custom

Lets you specify the elements, metrics, segments, and date-time information for your report.

Advanced - Query

Lets you pull data using an Adobe Analytics Web Service API Explorer Query. For more information about queries, see https://marketing.adobe.com/develope...r#Report.Queue.

"Easy - Predefined" Report Type Options 

Predefined Report

Select the report you want to run. For a list of report types, see the next section.

Report

Select a predefined report. These reports are available only when you select Easy - Predefined as your Report Type.

Base Metrics

Returns data about page views; average time spent on website; unique visitors by month, week, and day; new visitors; etc.

Commerce Metrics

Returns data about number of visits, orders, checkouts, revenue, new and returning customers, etc.

Existing Customer Campaigns

Returns data about visits, orders, and revenue, broken down by existing customer campaign.

Existing Customer Products

Returns data about existing customer visits, orders, checkouts, and revenue, broken down by product.

Mobile Device Types

Returns data about mobile views, visits, and daily unique visitors, broken down by device type.

Mobile Metrics

Returns metrics about mobile device usage, such as device type, OS, views, visits, and daily unique visitors.

Natural Search Conversion

Returns data about number of visits, orders, and revenue, broken down by natural search keyword.

Natural Search Visits

Returns data about number of visits, page views, and daily unique visitors, broken down by natural search keyword.

New Visitor Best Campaigns

Returns data about visits, orders, revenue, and units, broken down by new visitor campaign.

New Visitor Geo

Returns data about visits, orders, revenue, and units, broken down by region.

New Visitor Geo Country

Returns data about visits, orders, revenue, and units, broken down by country.

New Visitor Keywords

Returns data about visits, orders, revenue, and units, broken down by paid search keyword.

New Visitor Products

Returns data about new customer visits, orders, checkouts, revenue, units, etc., broken down by product.

New Visitor Traffic
Source

Returns data about visits, orders, revenue, and units, broken down by referrer type.

Page Effectiveness

Returns data about page visits, entries and exists, bounces, and bounce rate, broken down by page. 

Page Metrics

Returns data about page views, visits, daily unique visitors, and exists, broken down by page.

Paid Search Conversion

Returns data about visits, orders, and revenue, broken down by paid search keyword.

Paid Search Visits

Returns data about page views, daily unique visitors, and visits, broken down by paid search keyword.

Products and Categories

Returns data about visits, orders, and revenue, broken down by product and category. 

"Intermediate - Custom" Report Type Options

Option

Description

Metrics

Select up to 30 metrics for your report. For more information about Adobe Analytics metrics, see https://marketing.adobe.com/develope...ng-1-4/metrics.

Elements

Select up to four element names.

An element is a structure that breaks down a report's metrics data. For example, you can generate a report that breaks down page views (metric) by the browsers used to access the page (element). The resulting report lists page views by browser type.

For more information about elements, see https://marketing.adobe.com/develope...g-1-4/elements.

Additional Element Information

Enter additional element information. Use the JSON format defined for elements in the API Explorer for complete customization.

For example:

{

"id": "(string)",

"top": "(int)",

"classification": "(string)",

"parentID": "(string)",

"pattern": [

[

"(string)"

]

],

"search":{

"keywords":[

"(string)"

],

"searches": [

"(reportDescriptionSearch)"

],

"type": "(string)"

},

"selected":[

"(string)"

]

}

Date Granularity

Specify a minute interval as minute:[interval]. The interval is an integer between 1 and 60. For example, minute:3 reports the requested date range in 3-minute intervals. 

Sort Method (Optional)

Enter a string indicating how you want the data to be sorted. For example:

mostpopular:.25:0:linear

Add Date Granularity Choose whether you would like to aggregate the data by the data granularity specified above or aggregate all the data.

Duration

Specify whether the data in this report is for a single date or a range of dates.

Report Date

Select whether the data in the report is for a specific date or for a relative date based on the selected Date Granularity. For example, if you selected Date Granularity > Day, you could select Today as your report date. Then, each time the data updated, it would show date for the current date.

Select Specific Date

Select the date you want to retrieve data for.

Date From

Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in Date To. Options in these menus are determined by the selected Date Granularity.

For example, if you selected Date Granularity > Week, you could then select Date From > Last Week and Date To > This Week. Each time your report updated, it would then show data for this week as well as last week.

Date To

Specify whether the last date in your date range is a specific or relative date. You select the first date in your range in Date From. Options in these menus are determined by the selected Date Granularity.

For example, if you selected Date Granularity > Week, you could then select Date From > Last Week and Date To > This Week. Each time your report updated, it would then show data for this week as well as last week.

 

"Advanced - Query" Report Type Options

Option

Description

Query

Enter an Adobe Analytics Web Service API Explorer Query to pull data for your report. For more information about queries, see https://marketing.adobe.com/develope...r#Report.Queue.

For example:

{"reportDescription":{
"reportSuiteID":"thankyoudev",
"dateFrom":"2014-09-07",
"dateTo":"2014-09-07",
"dateGranularity":"Day",
"elements":[
{"top":50,
"selected":[],
"classifications":[],
"id":"page",
"name":"Page"}],
"metrics":[
{"decimals":0,
"id":"pageviews",
"name":"Page Views"},
{"decimals":0,
"id":"visits",
"name":"Visits"}],
"segments":[],
"locale":"en_US"}}

Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.

FAQs

What's the difference between the Adobe Analytics v2 OAuth and Adobe Analytics Realtime JWT connectors?

The Adobe Analytics v2 OAuth connector uses the OAuth authentication whereas the Adobe Analytics Realtime JWT connector uses the JWT authentication. Adobe recommends that you use JWT authentication, as you will have to refresh the OAuth account every two weeks because the OAuth refresh token expires.

What version of the Adobe Analytics API does this connector use?

This connector uses version 1.4 of the Adobe Analytics API. 

What kind of credentials do I need to power up this connector?

You need the Client ID (API Key), Client Secret, Technical Account ID, Organization ID, and Private Key associated with your Adobe Analytics Realtime JWT project.

Are there any API limits that I need to know?

No

Which Adobe Analytics connector should I use?

Adobe recommends that you use Adobe Analytics Realtime JWT authentication. Adobe OAuth refresh tokens expire after two weeks, which requires you to refresh your account.