Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API

Overview

This node integrates with the Adobe Analytics API to manage and retrieve data related to various Adobe Analytics resources. Specifically, for the Project resource with the Lists Projects operation, it fetches a list of projects associated with a user's company. This is useful for users who want to programmatically access their workspace projects, enabling automation of project management tasks or integration with other systems.

Practical examples include:

  • Automatically retrieving all projects to display in a dashboard.
  • Syncing project lists with external project management tools.
  • Filtering projects based on specific criteria for reporting or auditing purposes.

Properties

Name Meaning
Global Company ID The unique identifier of the company within Adobe Analytics whose projects you want to list. This is required to scope the request properly.
Query Parameters A collection of optional filters and parameters to refine the list of projects returned. These include:
- Approved (boolean): Include only approved calculated metrics.
- Classifiable (boolean): Include classifiable dimensions.
- Component ID(s) (string): Filter by one or multiple component IDs.
- Component Type (string): Filter by component type.
- Curated RSID (string): Include curated item status for a given RSID.
- Dimension (string): Dimension to run the report against.
- End Date (string): End date for filtering (max 3 months period).
- Event / Event Type (string): Filter logs by event description or numeric event type ID.
- Expansion (string): Add extra metadata to items (comma-separated).
- Favorite (boolean): Include favorite calculated metrics.
- Filter by Date Range / IDs / Modified After / Published Segments (string): Various filters for annotations, segments, or modification dates.
- Include Type (string): Include additional annotations not owned by user ("all" or "shared").
- IP, Login, User ID (string/number): Filters for usage logs or user-specific queries.
- Limit (number): Maximum number of results to return (minimum 1).
- Locale (string): Locale setting, default is "en_US".
- Lookup None Values, Migrating, New Definition, Reportable, Segmentable, Use Cache (boolean): Various flags controlling inclusion/exclusion of certain data types or caching behavior.
- Name, Owner ID, Page, Pagination, RSID, Search And/Or/Not/Phrase, Segment Filter, Sort Direction/Property, Start Date, Tag Names, To Be Used In RSID (string/number): Additional filters and sorting options for projects.

The full set of query parameters allows fine-grained control over which projects are retrieved and how they are filtered or sorted.

Output

The output is a JSON array where each element represents a project object as returned by the Adobe Analytics API. Each project object contains details about a project such as its configuration, ownership, metadata, and other relevant attributes defined by Adobe Analytics.

If the API returns no content, the node outputs a status code message indicating "204 No Content".

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for Adobe Analytics with client ID, client secret, and scope configured.
  • The node performs OAuth2 client credentials flow to obtain an access token from Adobe's IMS authentication service.
  • Network connectivity to https://analytics.adobe.io and https://ims-na1.adobelogin.com is required.
  • Proper permissions on the Adobe Analytics account to list projects.

Troubleshooting

  • Missing Credentials Error: If the API key credential is not provided or invalid, the node will throw an error indicating missing credentials.
  • Access Token Retrieval Failure: If the OAuth token cannot be obtained, check client ID, client secret, and scope values.
  • Required Parameter Missing: For some operations, if required IDs (like Project ID) are missing, the node throws an error specifying the missing parameter.
  • API Errors: Any errors returned by the Adobe Analytics API are wrapped and reported with descriptive messages. Check the API response and ensure the query parameters and credentials are correct.
  • Empty Response: If no projects match the query, the node returns a "204 No Content" status message.

Links and References


This summary focuses on the "Project" resource and "Lists Projects" operation, describing the input properties, output structure, dependencies, and common troubleshooting points based on static analysis of the provided source code and property definitions.

Discussion