Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node interacts with the Adobe Analytics API to list available dimensions for a specified report suite (global company). It allows users to retrieve metadata about dimensions that can be used for segmentation and data breakdowns in analytics reports. This is useful when building dynamic reports or dashboards where you need to know which dimensions are available for filtering or grouping data.

Typical use cases include:

  • Fetching all dimensions to populate dropdowns or selection lists in reporting tools.
  • Filtering dimensions based on various criteria such as whether they are reportable, segmentable, or approved.
  • Automating workflows that require dimension metadata from Adobe Analytics for further processing or analysis.

Properties

Name Meaning
Global Company ID The identifier of the Adobe Analytics global company (report suite) to query dimensions from.
Query Parameters A collection of optional filters and parameters to refine the list of dimensions returned. These include:
- Approved: Whether to include only approved calculated metrics (boolean).
- Classifiable: Whether to include classifiable dimensions (boolean).
- Component ID / Component IDs: Filter by specific component(s) (string).
- Component Type: Filter by component type (string).
- Curated RSID: Include curated item status for given RSID (string).
- Dimension: Filter by dimension name (string).
- End Date / Start Date: Date range filters for the query (ISO8601 string).
- Event / Event Type: Filter logs by event description or numeric event type ID (string).
- Expansion: Add extra metadata to items (comma-delimited string).
- Favorite: Whether to include favorite calculated metrics (boolean).
- Filter by Date Range / IDs / Modified After / Published Segments: Various filters for annotations, segments, or modifications (string).
- Include Type: Include additional annotations not owned by user ("all" or "shared").
- IP / Login: Filter logs by IP address or login value (string).
- Limit: Maximum number of results to return (number, minimum 1).
- Locale: Locale setting, default "en_US" (string).
- Lookup None Values: Whether to include none values (boolean).
- Migrating: Whether to include migration functions in validation (boolean).
- Name: Filter segments containing this name (string).
- New Definition: Use new JSON definition format (boolean).
- Owner ID: Filter projects owned by specified login ID (string).
- Page: Pagination page number, base 0 (number).
- Pagination: Whether to return paginated results (boolean).
- Reportable: Include only dimensions valid within a report (boolean).
- RSID: Report suite ID to filter logs by (string).
- Search And / Or / Not / Clause / Phrase: Various search term filters (string).
- Segment Filter: Filter segments by specified list (string).
- Segmentable: Include only dimensions valid within a segment (boolean).
- Sort Direction: Sort order, either ASC or DESC (string).
- Sort Property: Property to sort by (string).
- Tag Names: Filter segments containing one of the tags (string).
- To Be Used In RSID: Report suite where the calculated metric is intended to be used (string).
- Use Cache: Whether to use caching for faster requests (boolean).
- User ID: User ID to return details for (only admins may use) (number).

Output

The output is a JSON array containing the list of dimensions retrieved from the Adobe Analytics API. Each item in the array represents a dimension object with its metadata as provided by the API. The exact structure depends on the Adobe Analytics API response but typically includes properties like dimension ID, name, description, and flags indicating if it is reportable, segmentable, etc.

No binary data output is produced by this operation.

Example output snippet (conceptual):

[
  {
    "id": "variables/page",
    "name": "Page",
    "description": "Page viewed",
    "reportable": true,
    "segmentable": true,
    ...
  },
  ...
]

Dependencies

  • Requires an Adobe Analytics API credential with client ID, client secret, and scope configured in n8n.
  • The node obtains an OAuth access token via Adobe's IMS token endpoint using client credentials grant.
  • Network access to https://ims-na1.adobelogin.com/ims/token/v3 and https://analytics.adobe.io/api/{globalCompanyId} endpoints is required.

Troubleshooting

  • Missing Credentials: If the Adobe Analytics API credentials are not set or invalid, the node will throw an error "Missing Adobe Analytics API Credentials".
  • Access Token Retrieval Failure: If the OAuth token cannot be obtained, the error "Failed to retrieve access token" will occur. Check client ID, secret, and network connectivity.
  • Required Parameter Missing: For this operation, the "Global Company ID" must be provided; otherwise, the node throws an error.
  • API Errors: Any errors returned by the Adobe Analytics API will be wrapped and reported with the message prefix "Error calling Adobe Analytics API".
  • Invalid Query Parameters: Providing unsupported or malformed query parameters may cause API errors or empty results.
  • Rate Limits: Adobe Analytics API may enforce rate limits; excessive calls might result in throttling errors.

Links and References

Discussion