Adobe Analytics Connector

Adobe Analytics is a digital analytics platform for mixing, matching, and analyzing data from any digital point in the customer journey. This component allows managing Adobe Analytics report suites and generating reports from gathered data.

API Documentation

This component was built using the Adobe Analytics 2.0 API Reference.

Connections

OAuth 2.0

Authenticate using OAuth 2.0.

Create a connection of type OAuth 2.0 to authenticate with Adobe Analytics.

Prerequisites

An Adobe account with access to Adobe Analytics
Access to the Adobe Developer Console

Setup Steps

Navigate to the Adobe Developer Console and create a new project
Add the Adobe Analytics API to the project
Select User Authentication, OAuth for the type of authentication, then select Web for the application type
For Redirect URI, enter https://oauth2.integrations.acme.com/callback
For Redirect URI Pattern, enter the OAuth 2.0 base URL (minus the /callback portion)
Copy the Client ID and Client Secret from the project credentials

Configure the Connection

Enter the Client ID and Client Secret from the Adobe Developer Console project
The Authorize URL defaults to https://ims-na1.adobelogin.com/ims/authorize/v2
The Token URL defaults to https://ims-na1.adobelogin.com/ims/token/v3

For Scopes, the default value is:

openid AdobeID read_organizations additional_info.projectedProductContext additional_info.job_function

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Authorize URL	The OAuth 2.0 authorization URL for Adobe.	https://ims-na1.adobelogin.com/ims/authorize/v2
Token URL	The OAuth 2.0 token URL for Adobe.	https://ims-na1.adobelogin.com/ims/token/v3
Scopes	The space-delimited OAuth scopes required for API access.	openid AdobeID read_organizations additional_info.projectedProductContext additional_info.job_function
Client ID	The client ID for the Adobe Developer Console project.
Client Secret	The client secret for the Adobe Developer Console project.

Actions

Get Current User

Retrieves the authenticated user and associated organizations and companies.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.

Get Report Suite

Retrieves a report suite by ID.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.
Global Company ID	The unique identifier for the analytics company.
Report Suite ID	The unique identifier for the report suite to query.

List Companies

Lists all companies the authenticated user can access.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.

List Dimensions for Report Suite

Retrieves a list of dimensions for a given report suite.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.
Global Company ID	The unique identifier for the analytics company.
Report Suite ID	The unique identifier for the report suite to query.

List Metrics for Report Suite

Retrieves a list of metrics for a given report suite.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.
Global Company ID	The unique identifier for the analytics company.
Report Suite ID	The unique identifier for the report suite to query.

List Report Suites

Retrieves a list of report suites.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.
Global Company ID	The unique identifier for the analytics company.

List Virtual Report Suites

Retrieves a list of virtual report suites.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.
Global Company ID	The unique identifier for the analytics company.

Raw Request

Sends a raw HTTP request to Adobe Analytics.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.
URL	Input the path only (/discovery/me), The base URL is already included (https://analytics.adobe.io). For example, to connect to https://analytics.adobe.io/discovery/me, only /discovery/me is entered in this field.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Debug Request	Enabling this flag will log out the current request.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Run Report

Runs a report against a specified report suite.

Input	Comments	Default
Connection	The Adobe Analytics connection to use.
Global Company ID	The unique identifier for the analytics company.
Report Suite ID	The unique identifier for the report suite to query.
Dimension	The analytics dimension to break down the report by. Use the format variables/dimensionname.
Report Request Body	The JSON request body for the report. Specify all fields besides dimension and report suite ID here, including filters, metrics, and settings.	`{ "globalFilters": [ { "type": "dateRange", "dateRange": "YYYY-12-31T00:00:00.000/YYYY-01-31T23:59:59.999" } ], "metricContainer": { "metrics": [ { "columnId": "0", "id": "metrics/pageviews", "filters": [ "0" ] } ], "metricFilters": [ { "id": "0", "type": "dateRange", "dateRange": "YYYY-12-31T00:00:00.000/YYYY-01-31T23:59:59.999" } ] }, "settings": { "dimensionSort": "asc", "limit": "10", "page": "2" } }`

API Documentation​

Connections​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Actions​

Get Current User​

Get Report Suite​

List Companies​

List Dimensions for Report Suite​

List Metrics for Report Suite​

List Report Suites​

List Virtual Report Suites​

Raw Request​

Run Report​