Skip to main content

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.

Adobe Analytics 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.

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

Data Sources#

Select Company#

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

InputNotes
Input
Connection
connection
/ Required
connection
Notes
 

Select Report Suite#

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

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

Select Report Suite Dimension#

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

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

Select Report Suite Metric#

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

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

Select Virtual Report Suite#

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

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

Actions#

Get Current User#

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

InputNotes
Input
Connection
connection
/ Required
connection
Notes
 

Get Report Suite#

Get a report suite by ID | key: getReportSuite

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

Output Example Payload#

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

List Companies#

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

InputNotes
Input
Connection
connection
/ Required
connection
Notes
 

List Dimensions for Report Suite#

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

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

Output Example Payload#

{  "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

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

Output Example Payload#

{  "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

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

Output Example Payload#

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

List Virtual Report Suites#

Retrieve a list of virtual report suites | key: listVirtualReportSuites

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

Raw Request#

Send Raw Request to Adobe Analytics | key: rawRequest

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

Run Report#

Run a report | key: runReport

InputDefaultNotesExample
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Example
 
Input
Dimension
string
/ Required
dimension
Default
Notes
 
Example
variables/daterangeday
Input
Global Company ID
string
/ Required
globalCompanyId
Default
Notes
 
Example
exampl123
Input
Report Request Body
code
reportRequestBody
Default
{  "globalFilters": [    {      "type": "dateRange",      "dateRange": "YYYY-12-31T00:00:00.000/YYYY-01-31T23:59:59.999"    }  ],  "metricContainer": {    "metrics": [      {        "columnId": "0",        "id": "metrics/pageviews",        "filters": [          "0"        ]      }    ],    "metricFilters": [      {        "id": "0",        "type": "dateRange",        "dateRange": "YYYY-12-31T00:00:00.000/YYYY-01-31T23:59:59.999"      }    ]  },  "settings": {    "dimensionSort": "asc",    "limit": "10",    "page": "2"  }}
Notes
The body of the report request. Specify all fields besides dimension and report ID here.
Example
 
Input
Report Suite ID
string
/ Required
reportSuiteId
Default
Notes
 
Example
exampletest