Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node integrates with the Adobe Analytics API to create a new segment within a specified Adobe Analytics company account. Segments in Adobe Analytics allow users to define subsets of data based on specific criteria, enabling more focused analysis and reporting.

Typical use cases include:

  • Creating custom audience segments for targeted marketing analysis.
  • Defining user behavior groups to analyze specific patterns.
  • Automating segment creation as part of a larger data workflow.

For example, a marketer could use this node to programmatically create a segment that includes users who visited a particular page or performed a certain event, then use that segment in subsequent reports or campaigns.

Properties

Name Meaning
Global Company ID The unique identifier of the Adobe Analytics company (global company) where the segment will be created. This is required to specify the target company context for the API call.
Query Parameters Optional parameters to refine or filter the request. Includes many options such as: Approved (boolean), Classifiable (boolean), Component ID(s), Dimension, Date Range (startDate, endDate), Event filters, Limit, Locale, Pagination, Sort Direction, and many others. These parameters control aspects of the request but are generally not used when creating a segment.
Request Body A JSON object representing the segment definition to be created. This should conform to the Adobe Analytics API's expected segment schema. It contains the details of the segment such as name, description, rules, and other configuration.

Output

The node outputs the response from the Adobe Analytics API after attempting to create the segment. The output is a JSON array where each item corresponds to the API response for each input item processed.

  • The json field contains the parsed JSON response from the API, which typically includes details about the newly created segment such as its ID, name, and metadata.
  • If the API returns no content, the node outputs a status code message like "204 No Content".
  • The node does not output binary data.

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n, including:
    • Client ID
    • Client Secret
    • Scope
  • The node obtains an OAuth access token by making a POST request to Adobe's IMS token endpoint using these credentials.
  • The node makes authenticated HTTP requests to the Adobe Analytics API endpoints.
  • Network connectivity to Adobe Analytics API services is required.

Troubleshooting

  • Missing Credentials: If the Adobe Analytics API credentials are not set or incomplete, the node will throw an error "Missing Adobe Analytics API Credentials". Ensure credentials are properly configured.
  • Access Token Retrieval Failure: If the node cannot obtain an access token, it throws "Failed to retrieve access token". Verify client ID, secret, and scope are correct and have proper permissions.
  • Required Parameter Missing: For this operation, the Global Company ID and a valid JSON Request Body must be provided. Omitting these will cause errors.
  • API Errors: Any API error responses are wrapped and thrown as node errors with messages prefixed by "Error calling Adobe Analytics API". Check the error message and stack trace for details.
  • Invalid JSON in Request Body: The Request Body must be valid JSON. Invalid JSON will cause parsing errors before the API call.
  • Network Issues: Connectivity problems can cause request failures. Ensure stable internet connection and that Adobe Analytics API endpoints are reachable.

Links and References

Discussion