Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API

Overview

This node integrates with the Adobe Analytics API to manage and interact with various Adobe Analytics resources. Specifically, for the Project resource with the Create Project operation, it allows users to create a new project within their Adobe Analytics workspace. This is useful for automating project creation workflows, such as setting up new analysis projects programmatically based on dynamic inputs or triggers.

Typical use cases include:

  • Automating the setup of analytics projects when onboarding new clients.
  • Creating projects dynamically in response to business events.
  • Integrating Adobe Analytics project management into broader data pipelines.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics under which the project is created. Required for all operations except some user discovery ones.
Query Parameters Optional parameters to filter or modify the request. Includes many options like pagination, filtering by owner, date ranges, etc. (Not typically used for project creation but available.)
Request Body JSON object representing the details of the project to be created. This should contain the project configuration according to Adobe Analytics API specifications.

Notes on Query Parameters

The query parameters collection includes many possible filters and flags (e.g., approved, classifiable, componentId, limit, locale, ownerId, page, pagination, sortDirection, startDate, endDate, etc.). For the "Create Project" operation, these are generally not required but are available if needed for other operations.

Output

The node outputs the JSON response from the Adobe Analytics API after creating the project. This typically includes the newly created project's details such as its ID, name, configuration, and metadata as returned by the API.

If the API returns no content (HTTP 204), the output will indicate "Status Code": "204 No Content".

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for Adobe Analytics with client ID, client secret, and scope.
  • 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 for authentication.
  • Network access to https://analytics.adobe.io/api/{globalCompanyId}/projects for project creation.
  • Proper permissions in Adobe Analytics to create projects.

Troubleshooting

  • Missing Credentials Error: If the API key credential is not configured or missing, the node throws an error indicating missing Adobe Analytics API credentials. Ensure credentials are set up correctly.
  • Access Token Retrieval Failure: If the node cannot obtain an access token, it throws an error. Verify client ID, client secret, and scope are correct and that the Adobe IMS service is reachable.
  • Required Parameter Missing: For the Create Project operation, if the global company ID or request body is missing or invalid, the node may throw errors. Make sure all required fields are provided.
  • API Errors: Any HTTP errors from Adobe Analytics API are wrapped and thrown as node API errors with messages including the original error message and stack trace.
  • Invalid JSON in Request Body: The request body must be valid JSON. Invalid JSON will cause parsing errors before sending the request.

Links and References


This summary focuses on the "Project" resource and "Create Project" operation as requested, describing the input properties, output, dependencies, and common troubleshooting points based on static code analysis of the node implementation.

Discussion