Adobe Analytics extension

Once you have installed the analytics integration framework, you must connect to your data supplier. This page describes how to connect to a Adobe Analytics data supplier.

You must have an appropriate account and credentials to connect to Adobe Analytics.

Licensing

The associated framework is included with your DX Core license and is free of charge. However, this extension is paid and requires an additional special license.

Accessing Adobe Client Credentials

To get your values for the credential parameters below:

Log into https://developer.adobe.com/console/
Select the Project tab at the top of the page and create new project.
Select the project you just created.
Go to OAuth Server-to-Server in the Credentials section on the left.
Take the values from this section and add them as values to the corresponding properties in your adobeDataSupplier.yaml configuration file.

Connecting Adobe Analytics as your data supplier

Define the data suppliers for the charts to be displayed in the Analytics app dashboard. Marketers or editors can select the data suppliers you configure when they create dashboards and widgets in the Analytics app.

Data suppliers are defined under: /<module name>/dataSuppliers/<dataSupplierRegistryFile.yaml>.

/adobe-analytics/dataSuppliers/adobeDataSupplier.yaml

class: info.magnolia.analytics.adobe.datasource.AdobeDataSupplier (1)
credentials: (2)
  parameters:
    serviceUrl: https://analytics.adobe.io/api/exchan213/reports
    imsHost: https://ims-na1.adobelogin.com
    imsExchange: https://ims-na1.adobelogin.com/ims/token/v3
    companyId: <your companyId>
    clientId: <your clientId>
    clientSecret: <your clientSecret>
    scope: <your scope>
    orgId: <your orgId>
    technicalAccountId: <your technicalAccountId>
parameters:
  rsid: emagmgnl
  gFilterType: dateRange
  startDate: '2020-01-01'
  endDate: '2020-01-15'
  metricId: metrics/revenue
  dimension: variables/daterangeday

1	You can find a specific example of this data supplier in Configure your Magnolia Adobe Analytics IUX slot.
2	See Migrating Adobe credentials if you’re using credentials from JWT and want to migrate to OAuth Server-to-Server.

Property Description

class

required info.magnolia.analytics.adobe.datasource.AdobeDataSupplier

credentials

required

parameters

required

serviceUrl

required

The URL of your Adobe Analytics service, which includes your companyId issued by Adobe when you register.

For example: https://analytics.adobe.io/api/exchan213/reports where exchan213 is the companyId.

clientId

required

Your client ID.

To find your client ID, see Accessing Adobe Client Credentials.

clientSecret

required

Client secret for your Adobe Analytics account or the path to the Magnolia Passwords app.

To find your client secret, see Accessing Adobe Client Credentials.

scope

required

Scopes control the access and privileges an Adobe user grants authorization to a third-party application for.

For example: openid, AdobeID, additional_info.projectedProductContext

See the Adobe OAuth scopes documentation.

companyId

required

Your Company ID issued by Adobe when you register.

You can also use the Adobe swagger API to retrieve it (login required): https://adobedocs.github.io/analytics-2.0-apis/

orgId

required

Your Organization ID.

To find your Organization ID, see Accessing Adobe Client Credentials.

technicalAccountId

required

Your Technical Account ID.

To find your Technical Account ID, see Accessing Adobe Client Credentials.

imsHost

required

Adobe IMS (Identity Management System) host URL typically refers to the base domain used for authentication and identity-related services within Adobe’s ecosystem.

Currently it’s: https://ims-na1.adobelogin.com

This is the host URL where OAuth token requests are directed.

imsExchange

required

Adobe IMS (Identity Management System) server URL used for authentication and authorization when integrating with Adobe services.

Currently it’s: https://ims-na1.adobelogin.com/ims/token/v3

This is the endpoint where OAuth requests are directed.

In Analytics module 1.2, JWT authentication was used. In 1.3 and later, JWT credentials are no longer supported and must be replaced with OAuth Server-to-Server credentials. For information on how to migrate an existing project, see How to migrate Adobe credentials from JWT to OAuth Server-to-Server. For information on how to configure a new project, see Accessing Adobe Client Credentials above.

parameters

required

The parameters used in the REST call to configure the JSON results retrieved. These parameters vary depending on the data supplier used.

Each parameter is a key-value pair.

All the parameters shown in the example are required:

rsid - Adobe Report Suite ID. To find this, see: https://webanalyticsfordevelopers.com/2013/05/14/finding-a-report-suite-id/
gFilterType - Global filter type (for example you want to see data in dateRange format or something else).
startDate, endDate - Default date range configuration for data in the report. You can later change this in the chart displayed in the Analytics app using the date filters.
metricId - Specifies which kind of report data you want to see. For more information, see Metrics overview.
dimension - Type of breakdown filter, such as variables/daterangeday or variables/daterangehour.

Adobe Analytics extension

Licensing

Accessing Adobe Client Credentials

Connecting Adobe Analytics as your data supplier

Further reading

Location

Main doc sections