Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

The node interacts with the Adobe Analytics API to retrieve detailed information about metrics defined in an Adobe Analytics account. Specifically, the "Get Metric" operation under the "Metric" resource fetches the definition and metadata of a single metric by its ID within a specified global company context.

This node is useful when you want to programmatically access metric definitions for building or validating analytics queries, integrating Adobe Analytics data into workflows, or automating reporting processes. For example, you might use it to fetch a metric's details before running a report that uses that metric or to synchronize metric metadata with another system.

Properties

Name Meaning
Global Company ID The unique identifier of the Adobe Analytics company (tenant) to query against. Required.
Metric ID The identifier of the specific metric to retrieve.
Query Parameters Optional parameters to refine or filter the request. Includes options such as:
- approved: Include only approved calculated metrics (boolean).
- classifiable: Include classifiable dimensions (boolean).
- componentId / componentIds: Filter by component IDs (string or comma-separated string).
- componentType: Filter by component type (string).
- curatedRsid: Include curated item status for given RSID (string).
- dimension: Dimension to run the report against (string).
- endDate / startDate: Date range limits for filtering (ISO8601 string).
- event / eventType: Filter logs by event description or numeric event type ID (string).
- expansion: Add extra metadata fields (comma-delimited string).
- favorite: Include only favorite calculated metrics (boolean).
- filterByDateRange / filterByIds / filterByModifiedAfter / filterByPublishedSegments: Various filters for annotations, segments, etc. (strings).
- includeType: Include additional annotations not owned by user ("all", "shared").
- ip / login / userid: Filters based on IP address, user login, or user ID (string/number).
- limit: Maximum number of results to return (number).
- locale: Locale code for response localization (string).
- lookupNoneValues, migrating, newDefinition, pagination, reportable, segmentable, useCache: Boolean flags controlling behavior and filtering.
- name, ownerId, page, searchAnd, searchClause, searchNot, searchOr, searchPhrase, segmentFilter, tagNames, toBeUsedInRsid, sortDirection, sortProperty: Various filtering, sorting, and paging options (strings/numbers).

Output

The output is a JSON array where each element corresponds to the API response for the requested metric. The JSON structure contains the full metric definition and metadata as returned by the Adobe Analytics API, including properties like metric name, ID, description, calculation logic, and other relevant attributes.

No binary data is produced by this node.

Example output snippet:

[
  {
    "id": "metric_id",
    "name": "Page Views",
    "description": "Number of page views",
    "calculation": "...",
    "approved": true,
    ...
  }
]

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n with client ID, client secret, and scope.
  • The node obtains an OAuth2 access token from Adobe IMS using client credentials flow.
  • Network access to Adobe Analytics API endpoints (https://analytics.adobe.io/api/...).
  • Proper permissions in Adobe Analytics to access metric definitions.

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Access Token Retrieval Failure: Failure to obtain an access token from Adobe IMS will cause the node to error out. Check client ID, secret, and scope correctness.
  • Required Parameter Missing: If the Metric ID or Global Company ID is not provided, the node throws an error specifying the missing parameter.
  • API Errors: Any errors returned by the Adobe Analytics API (e.g., unauthorized, not found) will be surfaced as node errors with descriptive messages.
  • Empty or Invalid Responses: If the API returns empty or non-JSON responses, the node attempts to parse or returns raw text; ensure the API endpoint and parameters are correct.

Links and References

Discussion