Skip to main content

Adobe Analytics Component

Adobe Analytics

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.

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.

Data Sources​

Select Company​

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

Select Report Suite​

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

Select Report Suite Dimension​

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

Select Report Suite Metric​

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

Select Virtual Report Suite​

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

Actions​

Get Current User​

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

Get Report Suite​

Get a report suite by ID | key: getReportSuite

Output Example Payload​

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

List Companies​

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

List Dimensions for Report Suite​

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

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

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

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

Raw Request​

Send a raw HTTP request to Adobe Analytics API | key: rawRequest

Run Report​

Run a report | key: runReport