Skip to main content

Adobe Analytics Component

Manage companies, report suites, metrics, dimensions and more within Adobe Analytics.

Component key: adobe-analytics · Changelog ↓

Description​

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​

key: adobeAnalyticsOauth

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

Prerequisites​

Setup Steps​

  1. Navigate to the Adobe Developer Console and create a new project
  2. Add the Adobe Analytics API to the project
  3. Select User Authentication, OAuth for the type of authentication, then select Web for the application type
  4. For Redirect URI, enter https://oauth2.prismatic.io/callback
  5. For Redirect URI Pattern, enter the OAuth 2.0 base URL (minus the /callback portion)
  6. 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
InputNotesExample
Authorize URL

The OAuth 2.0 authorization URL for Adobe.

https://ims-na1.adobelogin.com/ims/authorize/v2
Client ID

The client ID for the Adobe Developer Console project.

Client Secret

The client secret for the Adobe Developer Console project.

Scopes

The space-delimited OAuth scopes required for API access.

openid AdobeID read_organizations additional_info.projectedProductContext additional_info.job_function
Token URL

The OAuth 2.0 token URL for Adobe.

https://ims-na1.adobelogin.com/ims/token/v3

Data Sources​

Select Company​

Select a company from a picklist. | key: selectCompany | type: picklist

InputNotesExample
Connection

The Adobe Analytics connection to use.

Select Report Suite​

Select a report suite from a picklist. | key: selectReportSuite | type: picklist

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123

Select Report Suite Dimension​

Select a dimension from a picklist. | key: selectReportSuiteDimension | type: picklist

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123
Report Suite ID

The unique identifier for the report suite to query.

exampletest

Select Report Suite Metric​

Select a metric from a picklist. | key: selectReportSuiteMetric | type: picklist

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123
Report Suite ID

The unique identifier for the report suite to query.

exampletest

Select Virtual Report Suite​

Select a virtual report suite from a picklist. | key: selectVirtualReportSuite | type: picklist

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123

Actions​

Get Current User​

Retrieves the authenticated user and associated organizations and companies. | key: getCurrentUser

InputNotesExample
Connection

The Adobe Analytics connection to use.

{
  "data": {
    "imsUserId": "1B2A3C4D5E6F7A8B9C0D1E2F@AdobeID",
    "imsOrgs": [
      {
        "imsOrgId": "EA1234567890ABCDEF1234@AdobeOrg",
        "companies": [
          {
            "globalCompanyId": "testco0",
            "companyName": "Test Company",
            "apiRateLimitPolicy": "aa_api_tier10_tp"
          },
          {
            "globalCompanyId": "anothe0",
            "companyName": "Another Test Company",
            "apiRateLimitPolicy": "aa_api_tier10_tp"
          }
        ]
      }
    ]
  }
}

Get Report Suite​

Retrieves a report suite by ID. | key: getReportSuite

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123
Report Suite ID

The unique identifier for the report suite to query.

exampletest

{
  "data": {
    "collectionItemType": "reportsuite",
    "id": "examplersid",
    "rsid": "examplersid",
    "name": "Example Suite"
  }
}

List Companies​

Lists all companies the authenticated user can access. | key: listCompanies

InputNotesExample
Connection

The Adobe Analytics connection to use.

{
  "data": [
    {
      "globalCompanyId": "testco0",
      "companyName": "Test Company",
      "apiRateLimitPolicy": "aa_api_tier10_tp"
    },
    {
      "globalCompanyId": "anothe0",
      "companyName": "Another Test Company",
      "apiRateLimitPolicy": "aa_api_tier10_tp"
    }
  ]
}

List Dimensions for Report Suite​

Retrieves a list of dimensions for a given report suite. | key: listReportSuiteDimensions

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123
Report Suite ID

The unique identifier for the report suite to query.

exampletest

{
  "data": [
    {
      "id": "variables/campaign",
      "title": "Tracking Code",
      "name": "Tracking Code",
      "type": "string",
      "category": "Traffic Sources",
      "support": [
        "dataWarehouse",
        "oberon"
      ],
      "pathable": false,
      "segmentable": true,
      "reportable": [
        "oberon"
      ],
      "supportsDataGovernance": true,
      "description": "Displays the Tracking Codes that are generated from Campaign tracking on the site.",
      "multiValued": false,
      "standardComponent": true
    }
  ]
}

List Metrics for Report Suite​

Retrieves a list of metrics for a given report suite. | key: listReportSuiteMetrics

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123
Report Suite ID

The unique identifier for the report suite to query.

exampletest

{
  "data": [
    {
      "id": "metrics/campaigninstances",
      "title": "Campaign Click-throughs",
      "name": "Campaign Click-throughs",
      "type": "int",
      "category": "Traffic Sources",
      "support": [
        "oberon",
        "dataWarehouse"
      ],
      "allocation": true,
      "precision": 0,
      "calculated": false,
      "segmentable": true,
      "supportsDataGovernance": false,
      "polarity": "positive",
      "standardComponent": true
    }
  ]
}

List Report Suites​

Retrieves a list of report suites. | key: listReportSuites

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123

{
  "data": [
    {
      "collectionItemType": "reportsuite",
      "id": "examplersid",
      "rsid": "examplersid",
      "name": "Example Suite"
    }
  ]
}

List Virtual Report Suites​

Retrieves a list of virtual report suites. | key: listVirtualReportSuites

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123

{
  "data": [
    {
      "collectionItemType": "reportsuite",
      "id": "vrs_example01",
      "rsid": "vrs_example01",
      "name": "Example Virtual Report Suite"
    }
  ]
}

Raw Request​

Sends a raw HTTP request to Adobe Analytics. | key: rawRequest

InputNotesExample
Connection

The Adobe Analytics connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

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.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
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
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
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.

/discovery/me
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

{
  "data": {
    "data": {},
    "headers": {}
  }
}

Run Report​

Runs a report against a specified report suite. | key: runReport

InputNotesExample
Connection

The Adobe Analytics connection to use.

Dimension

The analytics dimension to break down the report by. Use the format variables/dimensionname.

variables/daterangeday
Global Company ID

The unique identifier for the analytics company.

exampl123
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.

Report Suite ID

The unique identifier for the report suite to query.

exampletest

{
  "data": {
    "totalPages": 1,
    "firstPage": true,
    "lastPage": true,
    "numberOfElements": 3,
    "number": 0,
    "totalElements": 3,
    "columns": {
      "dimension": {
        "id": "variables/evar2",
        "type": "string"
      },
      "columnIds": [
        "0"
      ]
    },
    "rows": [
      {
        "itemId": "1132341824",
        "value": "red t-shirt",
        "data": [
          1515
        ]
      },
      {
        "itemId": "2400044733",
        "value": "digital watches",
        "data": [
          1
        ]
      },
      {
        "itemId": "3614317595",
        "value": "running shoes",
        "data": [
          16
        ]
      }
    ],
    "summaryData": {
      "totals": [
        1532
      ]
    }
  }
}

Changelog​

2026-04-01​

Various modernizations and documentation updates