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 on Adobe Analytics resources. Specifically, for the Segment resource and the Delete Segment operation, it allows users to delete a segment identified by its Segment ID within a specified global company context.
This is useful in scenarios where you want to programmatically manage your Adobe Analytics segments, such as cleaning up unused or obsolete segments automatically as part of a workflow. For example, after archiving data related to a segment, you might want to delete that segment to keep your analytics environment tidy.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the Adobe Analytics company (tenant) under which the segment exists. Required for all operations except one specific user discovery operation. |
| Segment ID | The unique identifier of the segment to be deleted. This is required for the Delete Segment operation. |
| Query Parameters | A collection of optional parameters that can modify the request behavior. For Delete Segment, these are generally not used but available for other operations. |
The full list of query parameters includes options like approved, classifiable, componentId, endDate, limit, locale, sortDirection (ASC or DESC), startDate, and many others mostly relevant for filtering or listing operations rather than deletion.
Output
The output of the Delete Segment operation is the JSON response from the Adobe Analytics API after attempting to delete the specified segment.
- If the deletion is successful and the API returns content, the node outputs the parsed JSON response.
- If the API returns an empty string or no content (HTTP 204 No Content), the node outputs a JSON object indicating
"Status Code": "204 No Content". - If the response is a plain string, the node attempts to parse it as JSON; if parsing fails, it outputs the raw text.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for Adobe Analytics with client ID, client secret, and scope configured.
- 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/v3for authentication andhttps://analytics.adobe.io/api/{globalCompanyId}for API calls. - Proper permissions on the Adobe Analytics account to delete segments.
Troubleshooting
- Missing Credentials Error: If the Adobe Analytics API credentials are not set or invalid, the node will throw an error "Missing Adobe Analytics API Credentials". Ensure credentials are configured correctly.
- Failed to Retrieve Access Token: If the OAuth token request fails, check client ID, client secret, and scope values.
- Missing Segment ID: The node requires a Segment ID for deletion. If omitted, it throws "Segment ID is required".
- API Errors: Any errors returned by the Adobe Analytics API during deletion will be wrapped and thrown as node errors with messages starting "Error calling Adobe Analytics API".
- Network Issues: Connectivity problems to Adobe endpoints will cause request failures.
- Permission Denied: Insufficient permissions to delete segments will result in API errors; verify user roles and API scopes.
Links and References
This summary focuses on the Segment resource's Delete operation as requested, based on static analysis of the provided source code and property definitions.