Adobe Analytics Component

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

Component key: adobe-analytics

Description

Adobe Analytics lets you mix, match, and analyze data from any digital point in the customer journey. This component lets you manage Adobe Analytics report suites and generate reports from data gathered.

API Documentation

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

Connections

Adobe Analytics OAuth 2.0 Connection

To create an Adobe Analytics OAuth 2.0 app, first visit the Adobe Developer Console.

• Create a new project
• Add the Adobe Analytics API to the project
• Select User Authentication, OAuth for the type of authentication you need, and then select Web for the type of application you're trying to integrate with Adobe
• For Redirect URI enter https://oauth2.prismatic.io/callback
• For Redirect URI Pattern enter your OAuth 2.0's base URL (minus the /callback portion).
• Take note of your Client ID and Client Secret

Enter your client ID and client secret when you create an Adobe Analytics connection.

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for Adobe	https://ims-na1.adobelogin.com/ims/authorize/v2
Client ID	Client ID of your app for the API. Generate in the developer console.
Client Secret	Client Secret of your app for the API
Scopes	Scopes required for your app	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

Input	Notes	Example
Connection

---

Select Report Suite

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

Input	Notes	Example
Connection
Global Company ID		exampl123

---

Select Report Suite Dimension

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

Input	Notes	Example
Connection
Global Company ID		exampl123
Report Suite ID		exampletest

---

Select Report Suite Metric

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

Input	Notes	Example
Connection
Global Company ID		exampl123
Report Suite ID		exampletest

---

Select Virtual Report Suite

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

Input	Notes	Example
Connection
Global Company ID		exampl123

---

Actions

Get Current User

Get authenticated user and associated organizations and companies | key: getCurrentUser

Input	Notes	Example
Connection

---

Get Report Suite

Get a report suite by ID | key: getReportSuite

Input	Notes	Example
Connection
Global Company ID		exampl123
Report Suite ID		exampletest

{
  "data": {
    "collectionItemType": "reportsuite",
    "id": "exampletest",
    "rsid": "exampletest",
    "name": "test"
  }
}

---

List Companies

List all companies the authenticate user can access | key: listCompanies

Input	Notes	Example
Connection

---

List Dimensions for Report Suite

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

Input	Notes	Example
Connection
Global Company ID		exampl123
Report Suite ID		exampletest

{
  "data": [
    {
      "id": "variables/averagepagetime",
      "title": "Time Spent on Page - Bucketed",
      "name": "Time Spent on Page - Bucketed",
      "type": "ordered-enum",
      "category": "Metrics",
      "support": [
        "oberon"
      ],
      "pathable": false,
      "segmentable": true,
      "reportable": [
        "oberon"
      ],
      "supportsDataGovernance": false,
      "description": "The amount of time a visitor spends on the page. The amount of time is categorized into different time ranges or \"buckets.\" This can help you understand how long visitors interact with a given metric on the site.",
      "multiValued": false,
      "standardComponent": true
    },
    {
      "id": "variables/browser",
      "title": "Browser",
      "name": "Browser",
      "type": "string",
      "category": "Audience",
      "support": [
        "oberon",
        "dataWarehouse"
      ],
      "pathable": false,
      "segmentable": true,
      "reportable": [
        "oberon"
      ],
      "supportsDataGovernance": true,
      "description": "Shows the name and version of the browser used to access the site. This can help you prioritize which browsers and browser versions you use when testing new features or versions of your site.",
      "multiValued": false,
      "standardComponent": true
    }
  ]
}

---

List Metrics for Report Suite

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

Input	Notes	Example
Connection
Global Company ID		exampl123
Report Suite ID		exampletest

{
  "data": [
    {
      "id": "metrics/averagepagedepth",
      "title": "Average Page Depth",
      "name": "Average Page Depth",
      "type": "int",
      "category": "Traffic",
      "support": [
        "oberon"
      ],
      "allocation": false,
      "precision": 0,
      "calculated": false,
      "segmentable": false,
      "supportsDataGovernance": false,
      "polarity": "positive",
      "standardComponent": true
    }
  ]
}

---

List Report Suites

Retrieve a list of report suites | key: listReportSuites

Input	Notes	Example
Connection
Global Company ID		exampl123

{
  "data": [
    {
      "collectionItemType": "reportsuite",
      "id": "exampletest",
      "rsid": "exampletest",
      "name": "test"
    }
  ]
}

---

List Virtual Report Suites

Retrieve a list of virtual report suites | key: listVirtualReportSuites

Input	Notes	Example
Connection
Global Company ID		exampl123

---

Raw Request

Send raw HTTP request to Adobe Analytics | key: rawRequest

Input	Notes	Example
Connection
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.	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.	false
Retry Delay (ms)	The delay in milliseconds between retries.	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.	false

---

Run Report

Run a report | key: runReport

Input	Notes	Example
Connection
Dimension		variables/daterangeday
Global Company ID		exampl123
Report Request Body	The body of the report request. Specify all fields besides dimension and report ID here.
Report Suite ID		exampletest

---