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 https://oauth2\.prismatic\.io
Take note of your Client ID and Client Secret

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

Input	Default	Notes
Authorize URL string / Required authorizeUrl	https://ims-na1.adobelogin.com/ims/authorize/v2	The OAuth 2.0 Authorization URL for Adobe
Client ID string / Required clientId		Client ID of your app for the API. Generate in the developer console.
Client Secret password / Required clientSecret		Client Secret of your app for the API
Scopes string / Required scopes	openid AdobeID read_organizations additional_info.projectedProductContext additional_info.job_function	Scopes required for your app
Token URL string / Required tokenUrl	https://ims-na1.adobelogin.com/ims/token/v3	The OAuth 2.0 Token URL for Adobe

Data Sources

Select Company

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

Input	Notes
Connection connection / Required connection

Select Report Suite

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

Input	Notes	Example
Connection connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123

Select Report Suite Dimension

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

Input	Notes	Example
Connection connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123
Report Suite ID string / Required reportSuiteId		exampletest

Select Report Suite Metric

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

Input	Notes	Example
Connection connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123
Report Suite ID string / Required reportSuiteId		exampletest

Select Virtual Report Suite

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

Input	Notes	Example
Connection connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123

Actions

Get Current User

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

Input	Notes
Connection connection / Required connection

Get Report Suite

Get a report suite by ID | key: getReportSuite

Input	Notes	Example
Connection connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123
Report Suite ID string / Required reportSuiteId		exampletest

Example Payload for Get Report Suite

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

List Companies

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

Input	Notes
Connection connection / Required connection

List Dimensions for Report Suite

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

Input	Notes	Example
Connection connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123
Report Suite ID string / Required reportSuiteId		exampletest

Example Payload for List Dimensions for Report Suite

{
  "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 connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123
Report Suite ID string / Required reportSuiteId		exampletest

Example Payload for List Metrics for Report Suite

{
  "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 connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123

Example Payload for List Report Suites

{
  "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 connection / Required connection
Global Company ID string / Required globalCompanyId		exampl123

Raw Request

Send raw HTTP request to Adobe Analytics | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Run Report

Run a report | key: runReport

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

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

Description​

API Documentation​

Connections​

Adobe Analytics OAuth 2.0 Connection​

Data Sources​

Select Company​

Select Report Suite​

Select Report Suite Dimension​

Select Report Suite Metric​

Select Virtual Report Suite​

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​