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 integrates with the Adobe Analytics API to perform various operations related to Adobe Analytics components. Specifically, for the Component Meta Data resource and the Search Shared Components operation, it allows users to search for shared components metadata across multiple components at once. This is useful in scenarios where you want to retrieve information about components that have been shared within an organization or team, enabling collaboration and reuse of analytics components such as calculated metrics, segments, or tags.
Practical examples include:
- Searching for shared calculated metrics or segments by filtering on properties like component type, approval status, or tags.
- Retrieving shared components metadata filtered by date ranges or ownership to audit or manage shared assets.
- Using query parameters to refine searches for components relevant to specific report suites or projects.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier for the company in Adobe Analytics context. Required to scope the API request. |
| Query Parameters | A collection of optional filters and options to refine the search for shared components. These include: |
| - Approved: Whether to include only approved calculated metrics (boolean). | |
| - Classifiable: Whether to include classifiable dimensions (boolean). | |
| - Component ID / Component IDs: Specific component(s) to operate on (string, comma-separated for multiple). | |
| - Component Type: Filter by component type (string). | |
| - Curated RSID: Include curated item status for a given report suite ID (string). | |
| - Dimension: Dimension to run the report against (string). | |
| - End Date / Start Date: Date range limits for filtering (ISO8601 string). | |
| - Event / Event Type: Filters for event descriptions or types (string). | |
| - Expansion: Extra metadata fields to add (comma-delimited string). | |
| - Favorite: Whether to include favorite calculated metrics (boolean). | |
| - Filter by Date Range / Modified After / Published Segments: Various filters for annotations, modification dates, and segment publication status (string). | |
| - Include Type: Inclusion filter for annotations not owned by user ("all" or "shared"). | |
| - IP / Login / User ID: Filters based on user or IP address (string or number). | |
| - Limit: Maximum number of results to return (number). | |
| - Locale: Locale setting for returned data (string, e.g., "en_US"). | |
| - Lookup None Values: Whether to include none values (boolean). | |
| - Migrating: Whether to include migration functions in validation (boolean). | |
| - Name / Tag Names / Segment Filter: Filters by name, tags, or segments (string). | |
| - New Definition: Whether to use the new JSON definition format (boolean). | |
| - Owner ID: Filter by project owner login ID (string). | |
| - Page / Pagination: Controls pagination of results (number and boolean). | |
| - Reportable / Segmentable: Filters for dimensions valid in reports or segments (boolean). | |
| - RSID / To Be Used In RSID: Report suite IDs for filtering (string). | |
| - Search And / Or / Not / Phrase / Clause: Various search term filters with logical operators (string). | |
| - Sort Direction / Sort Property: Sorting options for results (ASC/DESC and property name). | |
| - Use Cache: Whether to use caching for faster requests (boolean). | |
| Request Body | JSON object for the request body payload when applicable (used in some operations but available here for completeness). |
Output
The output is a JSON array where each element corresponds to the response from the Adobe Analytics API for the search query. The structure depends on the API response but generally includes metadata about shared components matching the search criteria, such as component IDs, types, names, sharing details, tags, and other relevant metadata.
If the API returns binary data (not typical for this operation), it would be summarized accordingly, but this operation primarily deals with JSON metadata.
Dependencies
- Requires an API key credential for Adobe Analytics with appropriate permissions.
- Needs network access to Adobe Analytics API endpoints.
- The node uses OAuth client credentials flow to obtain an access token before making API calls.
- No additional external dependencies beyond the Adobe Analytics API and n8n's HTTP request helper.
Troubleshooting
- Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Adobe Analytics API credentials are properly configured in n8n.
- Access Token Retrieval Failure: Errors retrieving the access token usually indicate invalid client ID/secret or scope issues. Verify these credentials.
- Required Parameter Missing: For this operation, the
Global Company IDis mandatory. Omitting it will cause an error. - Invalid Query Parameters: Passing unsupported or incorrectly formatted query parameters may result in API errors or empty results.
- API Rate Limits or Permissions: If the API returns authorization errors or rate limit exceeded messages, check your Adobe Analytics account permissions and usage quotas.
- Empty Results: If no shared components are found, verify the query parameters and ensure that shared components exist for the specified filters.