Actions57
- Annotation Actions
- Calculated Metric Actions
- Component Meta Data Actions
- Add Tags
- Delete Multiple Tags
- Delete One Tag
- Delete Shared Component
- Get Shared Component
- Get Tag
- List Shared Components by the User
- List Shared Components to the User
- List Tag Names
- List Tags
- Save Tags
- Search Shared Components
- Search Tags for Multiple Components
- Search Tags for One Component
- Share Component with Multiple User
- Share Component with One User
- Date Range Actions
- Dimension Actions
- Metric Actions
- Project Actions
- Report Actions
- Segment Actions
- Usage Log Actions
- User Actions
Overview
This node interacts with the Adobe Analytics API to retrieve detailed information about Dimensions within a specified Adobe Analytics global company context. Specifically, the "Get Dimension" operation fetches metadata and details for a particular dimension identified by its ID. This is useful when you want to programmatically access dimension definitions for segmentation, reporting, or data breakdowns in Adobe Analytics.
Typical use cases include:
- Automating retrieval of dimension metadata to dynamically build reports.
- Integrating Adobe Analytics dimension data into other systems or dashboards.
- Validating dimension existence and properties before running analytics queries.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the Adobe Analytics company (tenant) under which the dimension exists. Required for all operations except user discovery. |
| Dimension ID | The unique identifier of the dimension to retrieve. Required for the "Get Dimension" operation. |
| Query Parameters | Optional parameters to refine or filter the request. Includes many options such as: Approved (include approved metrics), Classifiable (include classifiable dimensions), Component IDs, Date ranges (startDate, endDate), Limit, Locale, Pagination, Sort options, and more. |
The Query Parameters collection supports numerous optional filters and flags that can be used to customize the request, including but not limited to:
approved: Whether to include only approved calculated metrics.classifiable: Whether to include classifiable dimensions.componentId/componentIds: Filter by specific component IDs.endDate/startDate: Define date range filters.limit: Maximum number of results to return.locale: Locale setting for returned data.pagination: Whether to paginate results.sortDirectionandsortProperty: Control sorting of results.
(For the "Get Dimension" operation, typically only the Dimension ID and Global Company ID are mandatory; query parameters may be less relevant.)
Output
The node outputs the JSON response from the Adobe Analytics API corresponding to the requested dimension's details. This includes metadata such as dimension name, description, classification, segmentability, reportability, and other attributes defined by Adobe Analytics.
If the API returns no content (HTTP 204), the output will indicate "204 No Content".
No binary data is produced by this node.
Dependencies
- Requires an Adobe Analytics API credential configured in n8n, providing:
- Client ID
- Client Secret
- Scope
- The node obtains an OAuth2 access token via Adobe's IMS token endpoint before making API calls.
- Network access to Adobe Analytics API endpoints (
https://analytics.adobe.io/api/) and Adobe IMS token service (https://ims-na1.adobelogin.com/ims/token/v3) is required.
Troubleshooting
- Missing Credentials Error: If the Adobe Analytics API credentials are not set or invalid, the node will throw an error indicating missing credentials. Ensure the API key and secret are correctly configured.
- 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: For the "Get Dimension" operation, if the Dimension ID or Global Company ID is empty, the node throws an error. Provide these mandatory inputs.
- API Errors: Any HTTP errors or unexpected responses from Adobe Analytics API will be surfaced as node errors with descriptive messages.
- Empty or Unexpected Response: If the API returns an empty string or non-JSON response, the node attempts to parse it; failure to parse will result in raw text output.
Links and References
This summary focuses on the "Dimension" resource and the "Get Dimension" operation as requested.