DocumentationPluginsAdobe Analytics data source for Grafana

Adobe Analytics Grafana data source

The Adobe Analytics data source plugin allows you to retrieve reports data from Adobe Analytics.

Requirements

This plugin has the following requirements:

• An Adobe Analytics account
• Any free or paid Grafana Cloud plan or an activated on-prem Grafana Enterprise license. Contracted Cloud customers should refer to their agreement.

Install the data source

To install the data source, refer to Installation.

Configure the data source in Grafana

Add a data source by filling in the following information:

Connection

Global Company ID

Global Company ID is being used for every API request in request URL. To find your Global Company ID follow these steps:

• Log into Adobe Experience Cloud
• Click “Analytics”
• In the top navigation bar click “Admin” → “All Admin”
• Click “Company Settings home”
• Click “API Access” tab and find your “Global Company Id” on the page that loads. It should be mentioned as:

  The global company id for the Analytics Company you are currently logged into is VALUE

Authentication

This plugin supports OAuth Server-to-Server API authentication. You need to provide Client ID and Client Secret as authentication credentials. To obtain your Client ID and Client Secret follow these steps:

• Go to “Projects” page under Adobe Developer Console
• Click on the project you want to access with the Adobe Analytics data source
• Make sure selected project contains Adobe Analytics API. If not, click “Add API” and choose “Adobe Analytics” from the list.
• Make sure selected project contains “OAuth Server-to-Server” credential. If not — add it. Read more on Credentials on Adobe Developer portal.
• Go inside “OAuth Server-to-Server” credential settings, copy Client ID and Client Secret from there and paste them into Adobe Analytics data source configuration page.

Configure the data source with provisioning

It is possible to configure data sources using configuration files with Grafana’s provisioning system. To read about how it works refer to Provisioning Grafana data sources.

Here is the provisioning example for this data source using OAuth Server-to-Server authentication:

yaml Copy

apiVersion: 1
datasources:
  - name: Adobe Analytics
    type: grafana-adobeanalytics-datasource
    jsonData:
      variables:
        global_company_id: <YOUR_GLOBAL_COMPANY_ID>
      services:
        adobe_analytics:
          auth:
            clientId: <YOUR_CLIENT_ID>
    secureJsonData:
      adobe_analytics.clientSecret: <YOUR_CLIENT_SECRET>

Query the data source

Plugin allows querying reports data.

There is also an option to query list of metrics, list of dimensions or list of reports, these queries might be useful for creating variables and then using those for querying reports data.

When querying reports you only get the data within the selected time range. Adjust the time range as necessary.

Getting metrics summary data

When getting report data, you can provide only metrics and no dimension in the query parameters. In this case only the summary data for each metric will be returned.

Getting time series data

To get time series metrics data select one of the time series dimensions (e.g. Hour, Minute, Day, etc.) alongside metrics.

Getting data for non-date related dimensions

When providing metrics parameters together with non-date related dimensions (e.g. Product), the response will contain only tabular data.

Using Limit parameter

Limit parameter impacts the maximum number of items to return in the response. The default value is 100. You might need to increase the Limit in order to get all data points for the selected time range.

Using Search clause parameter

You can use Search clause parameter for filtering dimensions. This is useful in case you want to limit the data returned so that reports show only the values you need. For example when using Product dimension and adding a search clause as ( NOT CONTAINS 'Product-1' ) will exclude all products that contain Product-1 in their name from the response.
Read more on using the search clause in Adobe API documentation.

Known limitations

At the moment there is no possibility to get breakdown dimensions data using the plugin. If you need it, feel free to create a feature request and let us know what is your use case.

Templates and variables

To add a new Adobe Analytics query variable, refer to Add a query variable. Use your Adobe Analytics data source as your data source and fill out the fields in the query builder.

After creating a variable, you can use it in your Adobe Analytics queries using Variable syntax. For more information about variables, refer to Templates and variables.

Learn more

• Add Annotations.
• Configure and use Templates and variables.
• Add Transformations.
• Set up alerting; refer to Alerts overview.