Skip to main content
adobe-analytics icon

Adobe Analytics Connector

SourceAPI DocsAPI ChangelogConnector 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

Triggers​

New Records​

Checks for new report suites or companies in Adobe Analytics on a configured schedule. | key: pollChangesTrigger

InputNotesExample
Connection

The Adobe Analytics connection to use.

Global Company ID

The unique identifier for the analytics company.

exampl123
Resource Type

The type of resource to poll for new records.

Show New Records

Include newly created records in trigger results.

true

This trigger polls the Adobe Analytics API for new records across a selected resource type on a configured schedule.

How It Works​

  1. The trigger runs on the configured schedule (e.g., every 5 minutes)
  2. It fetches all records from the selected Adobe Analytics resource, using paginated requests (up to 1,000 records per page) for Report Suites, or a single request to the /discovery/me endpoint for Companies
  3. Records are compared against the set of previously known IDs; only newly appearing records are captured
  4. The trigger updates its internal state after each poll, storing the current set of known IDs

The first recurrence records the IDs that already exist and returns no records; later recurrences report IDs that appear after it. The trigger has no Look-back Date input, so existing records are never backfilled.

Batching

Batching is enabled per flow on this trigger: each changed record is dispatched as its own execution, or grouped by the configured batch size. Batch size and batch concurrency can both be overridden per instance. Raising concurrency increases the request volume sent to Adobe Analytics.

To turn it on, select the flow's trigger, open the Flow control tab, and switch on Enable Batching. Under Batch Size, keep Trigger default or choose Custom batch size. Batch Concurrency is optional; leave it blank for no batch-level limit.

With batching off a downstream step reads body.data.created (body.data.updated is always empty). With batching on those fields do not exist: each execution receives one { "changeType": "created", "record": ... } item, or an array of them when the batch size is greater than 1. Any step reading the older shape must be updated before batching is enabled. Because batching is enabled per flow, that change is scoped to the flow rather than to the component or to other flows using the same trigger.

Returned Data​

With batching off, the trigger returns an object with two arrays: created for new records and updated for modified records. Because both resource types use ID-based change detection, updated is always an empty array. Fields shown are representative. The full response object includes additional properties.

Example Response
{
  "data": {
    "created": [
      {
        "rsid": "exampleco.main",
        "name": "Main Site"
      }
    ],
    "updated": []
  }
}

Notes​

  • When Resource Type is Report Suites, the Global Company ID input must be set; requests will fail without it
  • ID-based tracking cannot detect updates to existing records; only the appearance of new IDs is reported

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.

Example Payload for Get Current User⤓
Loading…

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
Example Payload for Get Report Suite⤓
Loading…

List Companies​

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

InputNotesExample
Connection

The Adobe Analytics connection to use.

Example Payload for List Companies⤓
Loading…

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
Example Payload for List Dimensions for Report Suite⤓
Loading…

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
Example Payload for List Metrics for Report Suite⤓
Loading…

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
Example Payload for List Report Suites⤓
Loading…

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
Example Payload for List Virtual Report Suites⤓
Loading…

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"}
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
Example Payload for Raw Request⤓
Loading…

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.

{
  "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"
  }
}
Report Suite ID

The unique identifier for the report suite to query.

exampletest
Example Payload for Run Report⤓
Loading…

Changelog​

2026-10-13​

Added opt-in batching to the New Records trigger, dispatching each changed record individually or in configured batches; enabling it changes the shape a downstream step receives

2026-04-30​

Updated spectral version

2026-04-21​

Added New Records polling trigger that checks for new report suites or companies in Adobe Analytics on a configured schedule, using ID-based change detection

2026-04-07​

Added global debug support across all actions for improved troubleshooting

2026-04-01​

Various modernizations and documentation updates