Welcome to the Adobe Analytics Connector setup guide! This document provides detailed instructions on how to configure Adobe Analytics to integrate seamlessly with the Savant App. You will follow the OAuth 2.0 authentication flow and set up the necessary connections to leverage Adobe Analytics data.
Features
The Adobe Analytics Connector allows you to:
Read and fetch reports data from Adobe Analytics
Requirements
Following requirements must be met to establish the connection between Savant and Adobe Analytics.
Access to Adobe Account with roles and permissions to authenticate
Access to a project in the Adobe Developer Console with the Adobe Analytics API configured.
Adobe Analytics service enabled for the user project in the Adobe Developer Console.
Adobe Analytics API enabled for the project (Adobe Analytics API is only available for paid subscriptions or licenses of Adobe services)
Authentication and Scopes
Authentication Flow
Authentication for Adobe Analytics is performed using the OAuth 2.0 flow. The required OAuth 2.0 scopes are:
openidread_organizationsadditional_info.projectedProductContextadditional_info.job_function
You must configure OAuth 2.0 within the Adobe Developer Console to obtain an Access Token.
Connection Steps:
Step 1: Create a Project and Configure Adobe Analytics API in developer console
Log into Adobe Developer Console: Visit the Adobe Developer Console and log in with your Adobe credentials. If you don’t have an Adobe account, you can create one here.
Create a New Project: In the Quick Start section, click on Create Project to start a new project (if you don't have an existing one).Name your project and click Create.
Add Adobe Analytics API to the Project:Click the + Add to Project button, select API, then choose Experience Cloud and select Adobe Analytics API, and click Next.
Step 2: Configure OAuth Settings
In the Configure API pop-up, choose OAuth > Web as the authentication type.
Enter the Default Redirect URI (e.g.,
https://app.savantlabs.io/api/callbackfor non-EU regions).Define any custom Redirect URI patterns as necessary.
You will be shown the available Scopes for the Adobe Analytics API (e.g.,
openid,read_organizations, etc.).Click Configure and Save API.
Step 3: Retrieve API Credentials
After saving the API configuration, go back to the Project Overview screen.
In the Credentials section, select OAuth Web.
Note down the Client ID, Client Secret, and the Scopes configured for the API.
Step 4: Generate the Access Token: Generate an access token using the Client ID and Client Secret by sending a request to Adobe's token endpoint.
curl --location 'https://ims-na1.adobelogin.com/ims/token/v3' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=client_credentials' \ --data-urlencode 'client_id=${CLIENT_ID}' \ --data-urlencode 'client_secret=${CLIENT_SECRET}' \ --data-urlencode 'scope=openid,AdobeID,read_organizations,additional_info.projectedProductContext,additional_info.job_function'The response will include an Access Token that can be used for authenticating subsequent API calls.
Step 5: Getting started in Savant
Once you’ve completed the steps above, follow these steps in Savant:
Go to the Systems page and click Add System
Select the Adobe Analytics connector and click Next
Enter your Client Id and Client Secret
Click Authenticate and then Confirm
Connection Information
When connecting to Adobe Analytics, you will need to define the External ID and External Name:
You can retrieve this information by querying Adobe’s discovery API.
curl --location 'https://analytics.adobe.io/discovery/me' \ --header 'x-api-key: ${CLIENT_ID}' \ --header 'Authorization: Bearer ${ACCESS_TOKEN}'External ID: Global Company ID (retrieved via API).
External Name: Company Name (retrieved via API).
Catalog: Company Name.
Schema: Report Suites.
Tables: List of all Report Suites for the Global Company.
To fetch the list of Report Suites for a company, use the following API call:
curl --location 'https://analytics.adobe.io/api/${COMPANY_ID}/reportsuites/collections/suites?limit=50' \ --header 'x-api-key: ${CLIENT_ID}' \ --header 'x-proxy-global-company-id: ${COMPANY_ID}' \ --header 'Authorization: Bearer ${ACCESS_TOKEN}'Troubleshooting
Follow these steps to resolve some of the common issues listed below
If you encounter issues during authentication, double-check the client ID and secret.
Ensure the required scopes (
openid,read_organizations, etc.) are configured in the Adobe Developer Console.Re-authenticate using OAuth to obtain a new access token.
Ensure you're using the correct API endpoints for the request.
Don’t see what you’re looking for? Contact us in the Community or reach out in Chat Support